Clients -
http :
FailoverClient
An HTTP client endpoint which provides failover support over multiple HTTP clients.
Constructor
__init
(FailoverClientConfiguration failoverClientConfig)
- failoverClientConfig FailoverClientConfiguration
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. The |
getResponse | Retrieves the |
hasPromise | Checks whether a |
getNextPromise | Retrieves the next available |
getPromisedResponse | Retrieves the promised server push |
rejectPromise | Rejects a |
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:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if 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:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if 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:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if 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:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if 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:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if 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:ClientError
if 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:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if 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:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if 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:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response or an
http:ClientError
if failed to fulfill the request
Submits an HTTP request to a service with the specified HTTP verb. The submit()
function does not return
a Response
as the result, rather it returns an 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:ReadableByteChannel
ormime:Entity[]
-
Return Type
(HttpFuture | ClientError) An
HttpFuture
that represents an asynchronous service invocation, or anhttp:ClientError
if the submission fails
Retrieves the Response
for a previously submitted request.
Parameters
- httpFuture HttpFuture
-
The
HttpFuture
related to a previous asynchronous invocation
-
Return Type
(Response | ClientError) An HTTP response message, or an
ClientError
if the invocation fails
Checks whether a PushPromise
exists for a previously submitted request.
Parameters
- httpFuture HttpFuture
-
The
HttpFuture
relates to a previous asynchronous invocation
-
Return Type
(boolean) A
boolean
that represents whether aPushPromise
exists
Retrieves the next available PushPromise
for a previously submitted request.
Parameters
- httpFuture HttpFuture
-
The
HttpFuture
relates to a previous asynchronous invocation
-
Return Type
(PushPromise | ClientError) An HTTP Push Promise message, or an
ClientError
if the invocation fails
Retrieves the promised server push Response
message.
Parameters
- promise PushPromise
-
The related
PushPromise
-
Return Type
(Response | ClientError) A promised HTTP
Response
message, or anClientError
if the invocation fails
Rejects a PushPromise
. When a 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