Clients -
http :
Caller
The caller actions for responding to client requests.
Remote Methods
respond | Sends the outbound response to the caller. |
promise | Pushes a promise to the caller. |
pushPromisedResponse | Sends a promised push response to the caller. |
acceptWebSocketUpgrade | Sends an upgrade request with custom headers. |
cancelWebSocketUpgrade | Cancels the handshake. |
continue | Sends a 100-continue response to the caller.
|
redirect | Sends a redirect response to the user with the specified redirection status code. |
ok | Sends the outbound response to the caller with the status 200 OK. |
created | Sends the outbound response to the caller with the status 201 Created. |
accepted | Sends the outbound response to the caller with the status 202 Accepted. |
noContent | Sends the outbound response to the caller with the status 204 No Content. If the given response contains a body
that will be removed.
|
badRequest | Sends the outbound response to the caller with the status 400 Bad Request.
|
notFound | Sends the outbound response to the caller with the status 404 Not Found.
|
internalServerError | Sends the outbound response to the caller with the status 500 Internal Server Error.
|
Methods
Fields
Sends the outbound response to the caller.
Parameters
- message ResponseMessage (default ())
-
The outbound response or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
, ormime:Entity[]
-
Return Type
(ListenerError?) An
http:ListenerError
if failed to respond or else()
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 | WebSocketError) An
http:WebSocketCaller
instance or else anhttp:WebSocketError
on failure to upgrade
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?) An
http:ListenerError
if failed to send the100-continue
response or else()
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?) An
http:ListenerError
if failed to send the redirect response or else()
Sends the outbound response to the caller with the status 200 OK.
Parameters
- message ResponseMessage (default ())
-
The outbound response or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
-
Return Type
(ListenerError?) An
http:ListenerError
if failed to respond or else()
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 (default ())
-
The outbound response or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
. This message is optional.
-
Return Type
(ListenerError?) An
http:ListenerError
if failed to respond or else()
Sends the outbound response to the caller with the status 202 Accepted.
Parameters
- message ResponseMessage (default ())
-
The outbound response or any payload of type
string
,xml
,json
,byte[]
,io:ReadableByteChannel
ormime:Entity[]
. This message is optional.
-
Return Type
(ListenerError?) An
http:ListenerError
if failed to respond or else()
Sends the outbound response to the caller with the status 204 No Content. If the given response contains a body that will be removed.
http:ListenerError? err = caller->noContent();
Parameters
- message Response? (default ())
-
The outbound response, which is optional
-
Return Type
(ListenerError?) An
http:ListenerError
if failed to respond or else()
Sends the outbound response to the caller with the status 400 Bad Request.
http:ListenerError? err = caller->badRequest();
Parameters
- message ResponseMessage (default ())
-
The outbound response or any payload of type
string
,xml
,json
,byte[]
,io:ByteChannel
, ormime:Entity[]
-
Return Type
(ListenerError?) An
http:ListenerError
if failed to respond or else()
Sends the outbound response to the caller with the status 404 Not Found.
http:ListenerError? err = caller->notFound();
Parameters
- message ResponseMessage (default ())
-
The outbound response or any payload of type
string
,xml
,json
,byte[]
,io:ByteChannel
, ormime:Entity[]
-
Return Type
(ListenerError?) An
http:ListenerError
if failed to respond or else()
Sends the outbound response to the caller with the status 500 Internal Server Error.
http:ListenerError? err = caller->internalServerError();
Parameters
- message ResponseMessage (default ())
-
The outbound response or any payload of type
string
,xml
,json
,byte[]
,io:ByteChannel
, ormime:Entity[]
-
Return Type
(ListenerError?) An
http:ListenerError
if failed to respond or else()
Gets the hostname from the remote address. This method may trigger a DNS reverse lookup if the address was created with a literal IP address.
string? remoteHost = caller.getRemoteHostName();
-
Return Type
(string?) The hostname of the address or else
()
if it is unresolved