Clients - http : Caller

The caller actions for responding to client requests.

Remote Methods

Fields

  • remoteAddress Remote {}
  • The remote address

  • localAddress Local {}
  • The local address

  • protocol string
  • The protocol associated with the service endpoint

respond

(ResponseMessage message)

returns error?

Sends the outbound response to the caller.

Parameters

  • message ResponseMessage
  • The outbound response or any payload of type string, xml, json, byte[], io:ReadableByteChannel or mime:Entity[]

  • Return Type

    (error?)
  • Returns an error if failed to respond

promise

(PushPromise promise)

returns error?

Pushes a promise to the caller.

Parameters

  • Return Type

    (error?)
  • An error in case of failures

pushPromisedResponse

(PushPromise promise, Response response)

returns error?

Sends a promised push response to the caller.

Parameters

  • response Response
  • The outbound response

  • Return Type

    (error?)
  • An error in case of failures while responding with the promised response

acceptWebSocketUpgrade

(map headers)

returns WebSocketCaller

Sends an upgrade request with custom headers.

Parameters

  • headers map
  • A map of custom headers for handshake

cancelWebSocketUpgrade

(int status, string reason)

returns error?

Cancels the handshake.

Parameters

  • status int
  • Error Status code for cancelling the upgrade and closing the connection. This error status code need to be 4xx or 5xx else the default status code would be 400.

  • reason string
  • Reason for cancelling the upgrade

  • Return Type

    (error?)
  • An error if an error occurs during cancelling the upgrade or nil

continue

()

returns error?

Sends a 100-continue response to the caller.

  • Return Type

    (error?)
  • Returns an error if failed to send the 100-continue response

redirect

(Response response, RedirectCode code, string[] locations)

returns error?

Sends a redirect response to the user with the specified redirection status code.

Parameters

  • response Response
  • Response to be sent to the caller

  • locations string[]
  • An array of URLs to which the caller can redirect to

  • Return Type

    (error?)
  • Returns an error if failed to send the redirect response

ok

(ResponseMessage message)

returns error?

Sends the outbound response to the caller with the status 200 OK.

Parameters

  • message ResponseMessage
  • The outbound response or any payload of type string, xml, json, byte[], io:ReadableByteChannel or mime:Entity[]

  • Return Type

    (error?)
  • Returns an error if failed to respond

created

(string uri, ResponseMessage message)

returns error?

Sends the outbound response to the caller with the status 201 Created.

Parameters

  • uri string
  • Represents the most specific URI for the newly created resource

  • message ResponseMessage - ()
  • The outbound response or any payload of type string, xml, json, byte[], io:ReadableByteChannel or mime:Entity[]. This message is optional.

  • Return Type

    (error?)
  • Returns an error if failed to respond

accepted

(ResponseMessage message)

returns error?

Sends the outbound response to the caller with the status 202 Accepted.

Parameters

  • message ResponseMessage - ()
  • The outbound response or any payload of type string, xml, json, byte[], io:ReadableByteChannel or mime:Entity[]. This message is optional.

  • Return Type

    (error?)
  • Returns an error if failed to respond