Clients -
http :
HttpClient
Provides the HTTP actions for interacting with an HTTP server. Apart from the standard HTTP methods,
HttpClient.forward()
and HttpClient.execute()
functions are provided. More complex and specific endpoint types
can be created by wrapping this generic HTTP actions implementation.
Constructor
__init
(string url, ClientConfiguration? config)
- url string
-
URL of the target service
- config ClientConfiguration? ()
-
The configurations to be used when initializing the
client
Remote Methods
post | The |
head | The |
put | The |
execute | Invokes an HTTP call with the specified HTTP verb. |
patch | The |
delete | The |
get | The |
options | The |
forward | The |
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
- config ClientConfiguration (default {})
-
The configurations associated with the HttpClient
- url string
-
The URL of the remote HTTP endpoint
The HttpClient.post()
function can be used to send HTTP POST requests to HTTP endpoints.
Parameters
- path string
-
Resource path
- message RequestMessage
-
An HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response for the request or an
http:ClientError
if failed to establish communication with the upstream server
The HttpClient.head()
function can be used to send HTTP HEAD requests to HTTP endpoints.
Parameters
- path string
-
Resource path
- message RequestMessage (default ())
-
An HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) An
http:Response
for the request or else anhttp:ClientError
if failed to establish communication with the upstream server
The HttpClient.put()
function can be used to send HTTP PUT requests to HTTP endpoints.
Parameters
- path string
-
Resource path
- message RequestMessage
-
An HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) An
http:Response
for the request or else anhttp:ClientError
if failed to establish communication with the upstream server
Invokes an HTTP call with the specified HTTP verb.
Parameters
- httpVerb string
-
HTTP verb value
- path string
-
Resource path
- message RequestMessage
-
An HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) An
http:Response
for the request or else anhttp:ClientError
if failed to establish communication with the upstream server
The HttpClient.patch()
function can be used to send HTTP PATCH requests to HTTP endpoints.
Parameters
- path string
-
Resource path
- message RequestMessage
-
An HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response for the request or else an
http:ClientError
if failed to establish communication with the upstream server
The HttpClient.delete()
function can be used to send HTTP DELETE requests to HTTP endpoints.
Parameters
- path string
-
Resource path
- message RequestMessage (default ())
-
An optional HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) An
http:Response
for the request or else anhttp:ClientError
if failed to establish communication with the upstream server
The HttpClient.get()
function can be used to send HTTP GET requests to HTTP endpoints.
Parameters
- path string
-
Request path
- message RequestMessage (default ())
-
An optional HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) An
http:Response
for the request or else anhttp:ClientError
if failed to establish communication with the upstream server
The HttpClient.options()
function can be used to send HTTP OPTIONS requests to HTTP endpoints.
Parameters
- path string
-
Request path
- message RequestMessage (default ())
-
An optional HTTP outbound request message or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(Response | ClientError) The response for the request or else an
http:ClientError
if failed to establish communication with the upstream server
The HttpClient.forward()
function can be used to invoke an HTTP call with inbound request's HTTP verb
-
Return Type
(Response | ClientError) An
http:Response
for the request or else anhttp:ClientError
if failed to establish communication with the upstream server
Submits an HTTP request to a service with the specified HTTP verb.
The HttpClient->submit()
function does not give out an http:Response
as the result.
Rather, it returns an http:HttpFuture
which can be used to do further interactions with the 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
http:HttpFuture
that represents an asynchronous service invocation, or else anhttp:ClientError
if the submission fails
Retrieves the http:Response
for a previously-submitted request.
Parameters
- httpFuture HttpFuture
-
The
http:HttpFuture
related to a previous asynchronous invocation
-
Return Type
(Response | ClientError) An
http:Response
message or else anhttp:ClientError
if the invocation fails
Checks whether an http:PushPromise
exists for a previously-submitted request.
Parameters
- httpFuture HttpFuture
-
The
http:HttpFuture
related to a previous asynchronous invocation
-
Return Type
(boolean) A
boolean
, which represents whether anhttp:PushPromise
exists
Retrieves the next available http:PushPromise
for a previously-submitted request.
Parameters
- httpFuture HttpFuture
-
The
http:HttpFuture
related to a previous asynchronous invocation
-
Return Type
(PushPromise | ClientError) An
http:PushPromise
message or else anhttp:ClientError
if 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:Response
message or else anhttp:ClientError
if 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