Client: CookieClient

Isolated

Provides the cookie functionality across HTTP client actions.

Remote Methods

get

The CookieClient.get() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

post

The CookieClient.post() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

head

The CookieClient.head() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

put

The CookieClient.put() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

forward

The CookieClient.forward() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

execute

The CookieClient.execute() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

patch

The CookieClient.patch() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

delete

The CookieClient.delete() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

options

The CookieClient.options() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

submit

Submits an HTTP request to a service with the specified HTTP verb.

getResponse

Retrieves the http:Response for a previously-submitted request.

hasPromise

Checks whether an http:PushPromise exists for a previously-submitted request.

getNextPromise

Retrieves the next available http:PushPromise for a previously-submitted request.

getPromisedResponse

Retrieves the promised server push http:Response message.

rejectPromise

Rejects an http:PushPromise.

get

function get(string path, RequestMessage message) returns Response | ClientError
Isolated Function
Remote Function

The CookieClient.get() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

Parameters

  • message RequestMessage (default ())
  • An optional HTTP outbound request or any allowed payload

Return Type

(Response | ClientError)

The response or an http:ClientError if failed to establish the communication with the upstream server

post

function post(string path, RequestMessage message) returns Response | ClientError
Isolated Function
Remote Function

The CookieClient.post() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

Parameters

  • message RequestMessage
  • An HTTP outbound request or any allowed payload

Return Type

(Response | ClientError)

The response or an http:ClientError if failed to establish the communication with the upstream server

function head(string path, RequestMessage message) returns Response | ClientError
Isolated Function
Remote Function

The CookieClient.head() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

Parameters

  • message RequestMessage (default ())
  • An optional HTTP outbound request or any allowed payload

Return Type

(Response | ClientError)

The response or an http:ClientError if failed to establish the communication with the upstream server

put

function put(string path, RequestMessage message) returns Response | ClientError
Isolated Function
Remote Function

The CookieClient.put() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

Parameters

  • message RequestMessage
  • An HTTP outbound request or any allowed payload

Return Type

(Response | ClientError)

The response or an http:ClientError if failed to establish the communication with the upstream server

forward

function forward(string path, Request request) returns Response | ClientError
Isolated Function
Remote Function

The CookieClient.forward() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

Parameters

  • request Request
  • An HTTP inbound request message

Return Type

(Response | ClientError)

The response or an http:ClientError if failed to establish the communication with the upstream server

execute

function execute(string httpVerb, string path, RequestMessage message) returns Response | ClientError
Isolated Function
Remote Function

The CookieClient.execute() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

Parameters

  • httpVerb string
  • HTTP verb value

  • message RequestMessage
  • An HTTP outbound request or any allowed payload

Return Type

(Response | ClientError)

The response or an http:ClientError if failed to establish the communication with the upstream server

patch

function patch(string path, RequestMessage message) returns Response | ClientError
Isolated Function
Remote Function

The CookieClient.patch() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

Parameters

  • message RequestMessage
  • An HTTP outbound request or any allowed payload

Return Type

(Response | ClientError)

The response or an http:ClientError if failed to establish the communication with the upstream server

delete

function delete(string path, RequestMessage message) returns Response | ClientError
Isolated Function
Remote Function

The CookieClient.delete() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

Parameters

  • message RequestMessage (default ())
  • An optional HTTP outbound request or any allowed payload

Return Type

(Response | ClientError)

The response or an http:ClientError if failed to establish the communication with the upstream server

options

function options(string path, RequestMessage message) returns Response | ClientError
Isolated Function
Remote Function

The CookieClient.options() function wraps the underlying HTTP remote functions in a way to provide the cookie functionality for a given endpoint.

Parameters

  • message RequestMessage (default ())
  • An optional HTTP outbound request or any allowed payload

Return Type

(Response | ClientError)

The response or an http:ClientError if failed to establish the communication with the upstream server

submit

function submit(string httpVerb, string path, RequestMessage message) returns HttpFuture | ClientError
Isolated Function
Remote Function

Submits an HTTP request to a service with the specified HTTP verb. The CookieClient.submit() function does not produce a Response as the result. Rather, it returns an HttpFuture, which can be used to do further interactions with the endpoint.

Parameters

  • httpVerb string
  • The HTTP verb value

  • message RequestMessage
  • An HTTP outbound request or any allowed payload

Return Type

(HttpFuture | ClientError)

An HttpFuture, which represents an asynchronous service invocation or else an http:ClientError if the submission fails

getResponse

function getResponse(HttpFuture httpFuture) returns Response | ClientError
Isolated Function
Remote Function

Retrieves the http:Response for a previously-submitted request.

Parameters

  • httpFuture HttpFuture
  • The http:HttpFuture relates to a previous asynchronous invocation

Return Type

(Response | ClientError)

An HTTP response message or else an http:ClientError if the invocation fails

hasPromise

function hasPromise(HttpFuture httpFuture) returns boolean
Isolated Function
Remote Function

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 an http:PushPromise exists

getNextPromise

function getNextPromise(HttpFuture httpFuture) returns PushPromise | ClientError
Isolated Function
Remote Function

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 Push Promise message or else an http:ClientError if the invocation fails

getPromisedResponse

function getPromisedResponse(PushPromise promise) returns Response | ClientError
Isolated Function
Remote Function

Retrieves the promised server push http:Response message.

Parameters

Return Type

(Response | ClientError)

A promised HTTP http:Response message or else an http:ClientError if the invocation fails

rejectPromise

function rejectPromise(PushPromise promise)
Isolated Function
Remote Function

Rejects an http:PushPromise. When an http:PushPromise is rejected, there is no chance of fetching a promised response using the rejected promise.

Parameters