Client: LoadBalanceClient

Isolated

LoadBalanceClient endpoint provides load balancing functionality over multiple HTTP clients.

Constructor

Load Balancer adds an additional layer to the HTTP client to make network interactions more resilient.

init (*LoadBalanceClientConfiguration loadBalanceClientConfig)

Remote Methods

post

The POST remote function implementation of the LoadBalancer Connector.

put

The PUT remote function implementation of the Load Balance Connector.

patch

The PATCH remote function implementation of the LoadBalancer Connector.

delete

The DELETE remote function implementation of the LoadBalancer Connector.

head

The HEAD remote function implementation of the LoadBalancer Connector.

get

The GET remote function implementation of the LoadBalancer Connector.

options

The OPTIONS remote function implementation of the LoadBalancer Connector.

execute

The EXECUTE remote function implementation of the LoadBalancer Connector.

forward

The FORWARD remote function implementation of the LoadBalancer Connector.

submit

The submit implementation of the LoadBalancer Connector.

getResponse

The getResponse implementation of the LoadBalancer Connector.

hasPromise

The hasPromise implementation of the LoadBalancer Connector.

getNextPromise

The getNextPromise implementation of the LoadBalancer Connector.

getPromisedResponse

The getPromisedResponse implementation of the LoadBalancer Connector.

rejectPromise

The rejectPromise implementation of the LoadBalancer Connector.

post

function post(string path, RequestMessage message, map<string | string[ ]>? headers, string? mediaType, TargetType targetType) returns targetType | ClientError
Isolated Function
Remote Function

The POST remote function implementation of the LoadBalancer Connector.

Parameters

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

  • mediaType string? (default ())
  • The MIME type header of the request entity

  • targetType TargetType (default <>)
  • HTTP response or the payload type (string, xml, json, byte[],record {| anydata...; |}, or record {| anydata...; |}[]), which is expected to be returned after data binding

Return Type

(targetType | ClientError)

The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

put

function put(string path, RequestMessage message, map<string | string[ ]>? headers, string? mediaType, TargetType targetType) returns targetType | ClientError
Isolated Function
Remote Function

The PUT remote function implementation of the Load Balance Connector.

Parameters

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

  • mediaType string? (default ())
  • The MIME type header of the request entity

  • targetType TargetType (default <>)
  • HTTP response or the payload type (string, xml, json, byte[],record {| anydata...; |}, or record {| anydata...; |}[]), which is expected to be returned after data binding

Return Type

(targetType | ClientError)

The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

patch

function patch(string path, RequestMessage message, map<string | string[ ]>? headers, string? mediaType, TargetType targetType) returns targetType | ClientError
Isolated Function
Remote Function

The PATCH remote function implementation of the LoadBalancer Connector.

Parameters

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

  • mediaType string? (default ())
  • The MIME type header of the request entity

  • targetType TargetType (default <>)
  • HTTP response or the payload type (string, xml, json, byte[],record {| anydata...; |}, or record {| anydata...; |}[]), which is expected to be returned after data binding

Return Type

(targetType | ClientError)

The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

delete

function delete(string path, RequestMessage message, map<string | string[ ]>? headers, string? mediaType, TargetType targetType) returns targetType | ClientError
Isolated Function
Remote Function

The DELETE remote function implementation of the LoadBalancer Connector.

Parameters

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

  • mediaType string? (default ())
  • The MIME type header of the request entity

  • targetType TargetType (default <>)
  • HTTP response or the payload type (string, xml, json, byte[],record {| anydata...; |}, or record {| anydata...; |}[]), which is expected to be returned after data binding

Return Type

(targetType | ClientError)

The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

function head(string path, map<string | string[ ]>? headers) returns Response | ClientError
Isolated Function
Remote Function

The HEAD remote function implementation of the LoadBalancer Connector.

Parameters

Return Type

(Response | ClientError)

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

get

function get(string path, map<string | string[ ]>? headers, TargetType targetType) returns targetType | ClientError
Isolated Function
Remote Function

The GET remote function implementation of the LoadBalancer Connector.

Parameters

  • targetType TargetType (default <>)
  • HTTP response or the payload type (string, xml, json, byte[],record {| anydata...; |}, or record {| anydata...; |}[]), which is expected to be returned after data binding

Return Type

(targetType | ClientError)

The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

options

function options(string path, map<string | string[ ]>? headers, TargetType targetType) returns targetType | ClientError
Isolated Function
Remote Function

The OPTIONS remote function implementation of the LoadBalancer Connector.

Parameters

  • targetType TargetType (default <>)
  • HTTP response or the payload type (string, xml, json, byte[],record {| anydata...; |}, or record {| anydata...; |}[]), which is expected to be returned after data binding

Return Type

(targetType | ClientError)

The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

execute

function execute(string httpVerb, string path, RequestMessage message, map<string | string[ ]>? headers, string? mediaType, TargetType targetType) returns targetType | ClientError
Isolated Function
Remote Function

The EXECUTE remote function implementation of the LoadBalancer Connector.

Parameters

  • httpVerb string
  • HTTP verb value

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

  • mediaType string? (default ())
  • The MIME type header of the request entity

  • targetType TargetType (default <>)
  • HTTP response or the payload type (string, xml, json, byte[],record {| anydata...; |}, or record {| anydata...; |}[]), which is expected to be returned after data binding

Return Type

(targetType | ClientError)

The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

forward

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

The FORWARD remote function implementation of the LoadBalancer Connector.

Parameters

  • targetType TargetType (default <>)
  • HTTP response or the payload type (string, xml, json, byte[],record {| anydata...; |}, or record {| anydata...; |}[]), which is expected to be returned after data binding

Return Type

(targetType | ClientError)

The response or the payload (if the targetType is configured) or an http:ClientError if failed to establish the communication with the upstream server or a data binding failure

submit

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

The submit implementation of the LoadBalancer Connector.

Parameters

  • httpVerb string
  • The HTTP verb value

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

Return Type

(HttpFuture | ClientError)

An http:HttpFuture that 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

The getResponse implementation of the LoadBalancer Connector.

Parameters

  • httpFuture HttpFuture
  • The http:HttpFuture related 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

The hasPromise implementation of the LoadBalancer Connector.

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

The getNextPromise implementation of the LoadBalancer Connector.

Parameters

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

Return Type

(PushPromise | ClientError)

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

getPromisedResponse

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

The getPromisedResponse implementation of the LoadBalancer Connector.

Parameters

Return Type

(Response | ClientError)

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

rejectPromise

function rejectPromise(PushPromise promise)
Isolated Function
Remote Function

The rejectPromise implementation of the LoadBalancer Connector.

Parameters