::: header

SSC R2.4 Web Services API

Generated by IDLdoc

:::

Overview Directory File Source [attach.png] {align=“top”} Etc Categories Search Index Help User documentation

single page{target=“_top”} | use frames{target=“_top”} summary class fields routine details file attributes

::: content

./

spdfhttperrorreporter__define.pro[]{.file-attributes}

::: {#file_comments} ::: small This class represents an object that is used to report HTTP errors.
Notes:

This class exists in both the CDAS and SSC web service IDL libraries. They should be kept identical to void incompatiblities for clients that use both libraries simultaneously.
As of release 1.7.35 of the CDAS library the retryAfterTime field and associated logic is obsolete. The SpdfRest class now handles a 429/503 http response with a Retry-After header itself and never calls this class for those responses. The code here has not yet been deleted because of note 1 above. ::: :::

Author information

Author

: B. Harris

: Copyright (c) 2010-2021 United States Government as represented by the National Aeronautics and Space Administration. No copyright is claimed in the United States under Title 17, U.S.Code. All Other Rights Reserved.

::: class-description

Class description for SpdfHttpErrorReporter

:::

Routines

Routines from spdfhttperrorreporter__define.pro

[result]{.var} = SpdfHttpErrorReporter::init()

: Creates an SpdfHttpErrorReporter object.

SpdfHttpErrorReporter::cleanup

: Performs cleanup operations when this object is destroyed.

SpdfHttpErrorReporter::reportError[, responseCode]{.argument}[, responseHeader]{.argument}[, responseFilename]{.argument}

: This procedure is called when an HTTP error occurs.

SpdfHttpErrorReporter::printResponse[, responseFilename]{.argument}

: This procedure prints some diagnostic information from the given HTTP error response file.

SpdfHttpErrorReporter::waitUntilRetryAfterTime

: Suspends execution until after any retryAfterTime.

[result]{.var} = SpdfHttpErrorReporter::getRetryAfterTime()

: Gets the retryAfterTime value.

SpdfHttpErrorReporter__define

: Defines the SpdfHttpErrorReporter class.

::: {#routine-details}

Routine details

::: {#SpdfHttpErrorReporter::init .routine-details .details}

top{.top} source{.top} SpdfHttpErrorReporter::init[]{.routine-attributes}

[result]{.var} = SpdfHttpErrorReporter::init()

Creates an SpdfHttpErrorReporter object.

Return value

::: small reference to an SpdfHttpErrorReporter object. ::: :::

::: {#SpdfHttpErrorReporter::cleanup .routine-details .details}

top{.top} source{.top} SpdfHttpErrorReporter::cleanup[]{.routine-attributes}

SpdfHttpErrorReporter::cleanup

Performs cleanup operations when this object is destroyed.

:::

::: {#SpdfHttpErrorReporter::reportError .routine-details .details}

top{.top} source{.top} SpdfHttpErrorReporter::reportError[]{.routine-attributes}

SpdfHttpErrorReporter::reportError[, responseCode]{.argument}[, responseHeader]{.argument}[, responseFilename]{.argument}

This procedure is called when an HTTP error occurs. This default implementation merely prints some diagnostic information.

Parameters

responseCode [in type=int ]{.smaller}

: the HTTP response code of the request causing the error.

responseHeader [in type=string ]{.smaller}

: the HTTP response header of the request causing the error.

responseFilename [in type=string ]{.smaller}

: the name of an error response file sent when the error occurred. :::

::: {#SpdfHttpErrorReporter::printResponse .routine-details .details}

top{.top} source{.top} SpdfHttpErrorReporter::printResponse[]{.routine-attributes}

SpdfHttpErrorReporter::printResponse[, responseFilename]{.argument}

This procedure prints some diagnostic information from the given HTTP error response file. It only recognizes the “typical” error response from the web services.

Parameters

responseFilename [in type=string ]{.smaller}

: the name of an error response file sent when the error occurred. :::

::: {#SpdfHttpErrorReporter::waitUntilRetryAfterTime .routine-details .details}

top{.top} source{.top} SpdfHttpErrorReporter::waitUntilRetryAfterTime[]{.routine-attributes}

SpdfHttpErrorReporter::waitUntilRetryAfterTime

Suspends execution until after any retryAfterTime. If there has been no HTTP 429/503/RetryAfter condition or the current time is after the retryAfterTime, then no suspension occurs.

:::

::: {#SpdfHttpErrorReporter::getRetryAfterTime .routine-details .details}

top{.top} source{.top} SpdfHttpErrorReporter::getRetryAfterTime[]{.routine-attributes}

[result]{.var} = SpdfHttpErrorReporter::getRetryAfterTime()

Gets the retryAfterTime value.

Return value

::: small the number of seconds elapsed since 1970-01-01 when we can retry a request following an HTTP response with status 429/503 and an HTTP Retry-After header value. ::: :::

::: {#SpdfHttpErrorReporter__define .routine-details .details}

top{.top} source{.top} SpdfHttpErrorReporter__define[]{.routine-attributes}

SpdfHttpErrorReporter__define

Defines the SpdfHttpErrorReporter class.

::: :::

::: {#attributes}

File attributes

Modification date: Fri May 13 08:54:13 2022 Lines: 72

:::

SSC Feedback. :::

::: footer

Produced by IDLdoc 3.6.4 on Mon Apr 8 09:50:59 2024 IDLdoc project information{target=“_top”}

:::