automorph.transport.http.client.SttpClient
See theSttpClient companion object
STTP HTTP & WebSocket client message transport plugin.
Uses the supplied RPC request as HTTP request body and returns HTTP response body as a result.
Type parameters
-
Effect
-
effect type
Value parameters
-
backend
-
STTP backend
-
effectSystem
-
effect system plugin
-
method
-
HTTP request method
-
url
-
remote API HTTP or WebSocket URL
Attributes
-
Constructor
-
Creates an STTP HTTP & WebSocket client message transport plugin with the specified STTP backend.
-
See also
-
-
Companion
-
object
-
Graph
-
-
Supertypes
-
trait Serializable
class Object
trait Matchable
class Any
Show all
Members list
Sends a request to a remote endpoint and retrieves the response.
Sends a request to a remote endpoint and retrieves the response.
An optional request context is used to supply additional information needed to send the request.
Value parameters
-
mediaType
-
message media (MIME) type.
-
requestBody
-
request message body
-
requestContext
-
request context
-
requestId
-
request correlation identifier
Attributes
-
Returns
-
response message and context
-
Definition Classes
-
-
Inherited from:
-
SttpClientBase (hidden)
Closes this client transport freeing the underlying resources.
Closes this client transport freeing the underlying resources.
Attributes
-
Returns
-
nothing
-
Definition Classes
-
-
Inherited from:
-
SttpClientBase (hidden)
Creates default request context based on the configuration of this client transport.
Creates default request context based on the configuration of this client transport.
Attributes
-
Returns
-
request context based on the configuration of this client transport
-
Definition Classes
-
-
Inherited from:
-
SttpClientBase (hidden)
Initializes this client to invoke remote APIs.
Initializes this client to invoke remote APIs.
Attributes
-
Returns
-
active RPC server
-
Definition Classes
-
-
Inherited from:
-
SttpClientBase (hidden)
Sends a request to a remote endpoint without waiting for a response.
Sends a request to a remote endpoint without waiting for a response.
An optional request context is used to supply additional information needed to send the request.
Value parameters
-
mediaType
-
message media (MIME) type.
-
requestBody
-
request message body
-
requestContext
-
request context
-
requestId
-
request correlation identifier
Attributes
-
Returns
-
nothing
-
Definition Classes
-
-
Inherited from:
-
SttpClientBase (hidden)