Clients -
http :
Caller
The caller actions for responding to client requests.
Remote Methods
Sends the outbound response to the caller.
Pushes a promise to the caller.
Sends a promised push response to the caller.
Sends an upgrade request with custom headers.
Cancels the handshake.
Sends a 100-continue
response to the caller.
Sends a redirect response to the user with the specified redirection status code.
Sends the outbound response to the caller with the status 200 OK.
Sends the outbound response to the caller with the status 201 Created.
Sends the outbound response to the caller with the status 202 Accepted.
Fields
Sends the outbound response to the caller.
Parameters
- message ResponseMessage - ()
-
The outbound response or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(ListenerError?) Returns an
http:ListenerError
if failed to respond
Pushes a promise to the caller.
Parameters
- promise PushPromise
-
Push promise message
-
Return Type
(ListenerError?) An
http:ListenerError
in case of failures
Sends a promised push response to the caller.
-
Return Type
(ListenerError?) An
http:ListenerError
in case of failures while responding with the promised response
Sends an upgrade request with custom headers.
Parameters
- headers map
-
A
map
of custom headers for handshake
-
Return Type
(WebSocketCaller) WebSocket service endpoint
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
(WebSocketError?) An
error
if an error occurs during cancelling the upgrade or nil
Sends a 100-continue
response to the caller.
-
Return Type
(ListenerError?) Returns an
http:ListenerError
if failed to send the100-continue
response
Sends a redirect response to the user with the specified redirection status code.
Parameters
- response Response
-
Response to be sent to the caller
- code RedirectCode
-
The redirect status code to be sent
- locations string[]
-
An array of URLs to which the caller can redirect to
-
Return Type
(ListenerError?) Returns an
http:ListenerError
if failed to send the redirect response
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
ormime:Entity[]
-
Return Type
(ListenerError?) Returns an
http:ListenerError
if failed to respond
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
ormime:Entity[]
. This message is optional.
-
Return Type
(ListenerError?) Returns an
http:ListenerError
if failed to respond
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
ormime:Entity[]
. This message is optional.
-
Return Type
(ListenerError?) Returns an
http:ListenerError
if failed to respond