goog.net.WebChannel.FailureRecovery

Provided By	`goog.net.WebChannel`

This interface defines a pluggable API to allow WebChannel runtime to support customized algorithms in order to recover from transient failures such as those failures caused by network or proxies (intermediaries).

The algorithm may also choose to fail-fast, e.g. switch the client to some offline mode.

Extra measurements and logging could also be implemented in the custom module, which has the full knowledge of all the state transitions (due to failures).

A default algorithm will be provided by the webchannel library itself. Custom algorithms are expected to be tailored to specific client platforms or networking environments, e.g. mobile, cellular network.

VIEW SOURCE

Instance Methods

The Webchannel runtime needs call this method when webchannel is closed or aborted.

Once the instance is closed, any access to the instance will be a no-op.

VIEW SOURCE

Parameters

None.

Returns

goog.net.WebChannel.FailureRecovery.State

the current state, mainly for debugging use.

VIEW SOURCE

This method is for WebChannel runtime to set the current failure condition and to provide a callback for the algorithm to signal to the runtime when it is time to issue a recovery operation, e.g. a new request to the server.

Supported transitions include: INIT->FAILED FAILED->FAILED (re-entry ok) RECOVERY->FAILED.

Ignored if state == CLOSED.

Advanced implementations are expected to track all the state transitions and their timestamps for monitoring purposes.

Parameters

`failure`	`goog.net.WebChannel.FailureRecovery.FailureCondition`
	The new failure condition generated by the WebChannel runtime.
`operation`	`Function`
	The callback function to the WebChannel runtime to issue a recovery operation, e.g. a new request. E.g. the default recovery algorithm will issue timeout-based recovery operations. Post-condition for the callback: state transition to RECOVERING.

Returns

goog.net.WebChannel.FailureRecovery.State

The updated state as decided by the failure recovery module. Upon a recoverable failure event, the state is transitioned to RECOVERING; or the state is transitioned to FAILED which indicates a fail-fast decision for the runtime to execute.

VIEW SOURCE

goog.net.WebChannel.FailureRecovery

Instance Methods

`this.`close() `→` `void`

`this.`getState() `→` `goog.net.WebChannel.FailureRecovery.State`

`this.`setFailure( `failure`, `operation` ) `→` `goog.net.WebChannel.FailureRecovery.State`

Enumerations

goog.net.WebChannel.FailureRecovery

Instance Methods

this.close() → void

this.getState() → goog.net.WebChannel.FailureRecovery.State

this.setFailure( failure, operation ) → goog.net.WebChannel.FailureRecovery.State

Enumerations

`this.`close() `→` `void`

`this.`getState() `→` `goog.net.WebChannel.FailureRecovery.State`

`this.`setFailure( `failure`, `operation` ) `→` `goog.net.WebChannel.FailureRecovery.State`