Clients -
http :
FailoverClient
An HTTP client endpoint which provides failover support over multiple HTTP clients.
Constructor
__init
(FailoverClientConfiguration failoverClientConfig)
- failoverClientConfig FailoverClientConfiguration
-
The configurations of the client endpoint associated with this
Failoverinstance.
Remote Methods
| post | The POST remote function implementation of the Failover Connector. |
| head | The HEAD remote function implementation of the Failover Connector. |
| patch | The PATCH remote function implementation of the Failover Connector. |
| put | The PUT remote function implementation of the Failover Connector. |
| options | The OPTIONS remote function implementation of the Failover Connector. |
| forward | Invokes an HTTP call using the incoming request's HTTP method. |
| execute | Invokes an HTTP call with the specified HTTP method. |
| delete | The DELETE remote function implementation of the Failover Connector. |
| get | The GET remote function implementation of the Failover Connector. |
| submit | Submits an HTTP request to a service with the specified HTTP verb. |
| getResponse | Retrieves the |
| hasPromise | Checks whether an |
| getNextPromise | Retrieves the next available |
| getPromisedResponse | Retrieves the promised server push |
| rejectPromise | Rejects an |
Fields
- failoverClientConfig FailoverClientConfiguration
-
The configurations for the failover client endpoint
- failoverInferredConfig FailoverInferredConfig
-
Configurations derived from
FailoverConfig
- succeededEndpointIndex int
-
Index of the
CallerActions[]array which given a successful response
The POST remote function implementation of the Failover Connector.
Parameters
- path string
-
Resource path
- message RequestMessage
-
HTTP request or any payload of type
string,xml,json,byte[],io:ReadableByteChannelormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientErrorif failed to fulfill the request
The HEAD remote function implementation of the Failover Connector.
Parameters
- path string
-
Resource path
- message RequestMessage (default ())
-
An optional HTTP request or any payload of type
string,xml,json,byte[],io:ReadableByteChannelormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientErrorif failed to fulfill the request
The PATCH remote function implementation of the Failover Connector.
Parameters
- path string
-
Resource path
- message RequestMessage
-
An HTTP request or any payload of type
string,xml,json,byte[],io:ReadableByteChannelormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientErrorif failed to fulfill the request
The PUT remote function implementation of the Failover Connector.
Parameters
- path string
-
Resource path
- message RequestMessage
-
An HTTP request or any payload of type
string,xml,json,byte[],io:ReadableByteChannelormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientErrorif failed to fulfill the request
The OPTIONS remote function implementation of the Failover Connector.
Parameters
- path string
-
Resource path
- message RequestMessage (default ())
-
An optional HTTP request or any payload of type
string,xml,json,byte[],io:ReadableByteChannelormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientErrorif failed to fulfill the request
Invokes an HTTP call using the incoming request's HTTP method.
-
Return Type
(Response | ClientError) The response or an
http:ClientErrorif failed to fulfill the request
Invokes an HTTP call with the specified HTTP method.
Parameters
- httpVerb string
-
HTTP method to be used for the request
- path string
-
Resource path
- message RequestMessage
-
An HTTP request or any payload of type
string,xml,json,byte[],io:ReadableByteChannelormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientErrorif failed to fulfill the request
The DELETE remote function implementation of the Failover Connector.
Parameters
- path string
-
Resource path
- message RequestMessage (default ())
-
An optional HTTP request or any payload of type
string,xml,json,byte[],io:ReadableByteChannelormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientErrorif failed to fulfill the request
The GET remote function implementation of the Failover Connector.
Parameters
- path string
-
Resource path
- message RequestMessage (default ())
-
An optional HTTP request or any payload of type
string,xml,json,byte[],io:ReadableByteChannelormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientErrorif failed to fulfill the request
Submits an HTTP request to a service with the specified HTTP verb. The FailoverClient.submit() function does not
return an http:Response as the result. Rather it returns an http:HttpFuture which can be used for subsequent interactions
with the HTTP endpoint.
Parameters
- httpVerb string
-
The HTTP verb value
- path string
-
The resource path
- message RequestMessage
-
An HTTP outbound request message or any payload of type
string,xml,json,byte[],io:ReadableByteChannelormime:Entity[]
-
Return Type
(HttpFuture | ClientError) An
http:HttpFuturethat represents an asynchronous service invocation or else anhttp:ClientErrorif the submission fails
Retrieves the http:Response for a previously-submitted request.
Parameters
- httpFuture HttpFuture
-
The
http:HttpFuturerelated to a previous asynchronous invocation
-
Return Type
(Response | ClientError) An
http:Responsemessage or else anhttp:ClientErrorif the invocation fails
Checks whether an http:PushPromise exists for a previously-submitted request.
Parameters
- httpFuture HttpFuture
-
The
http:HttpFuturerelated to a previous asynchronous invocation
-
Return Type
(boolean) A
boolean, which represents whether anhttp:PushPromiseexists
Retrieves the next available http:PushPromise for a previously-submitted request.
Parameters
- httpFuture HttpFuture
-
The
http:HttpFuturerelated to a previous asynchronous invocation
-
Return Type
(PushPromise | ClientError) An
http:PushPromisemessage or else anhttp:ClientErrorif the invocation fails
Retrieves the promised server push http:Response message.
Parameters
- promise PushPromise
-
The related
http:PushPromise
-
Return Type
(Response | ClientError) A promised
http:Responsemessage or else anhttp:ClientErrorif the invocation fails
Rejects an http:PushPromise. When an http:PushPromise is rejected, there is no chance of fetching a promised
response using the rejected promise.
Parameters
- promise PushPromise
-
The Push Promise to be rejected