root
API
Generated with
root/automorph.transport.http.client/SttpClient

SttpClient

automorph.transport.http.client.SttpClient$
See theSttpClient companion class
object SttpClient

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
SttpClient.type

Members list

Type members

Classlikes

final case class TransportContext(request: PartialRequest[Either[String, String], Any])

Transport context.

Transport context.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TransportContext

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Types

type Context = HttpContext[TransportContext]

Request context type.

Request context type.

Attributes

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def apply[Effect[_]](effectSystem: EffectSystem[Effect], backend: SttpBackend[Effect, WebSockets], url: URI, method: HttpMethod): SttpClient[Effect]

Creates an STTP HTTP & WebSocket client message transport plugin with the specified STTP backend. Use the alternative SttpClient.http function for STTP backends without WebSocket capability.

Creates an STTP HTTP & WebSocket client message transport plugin with the specified STTP backend. Use the alternative SttpClient.http function for STTP backends without WebSocket capability.

Type parameters

Effect

effect type

Value parameters

backend

STTP backend

effectSystem

effect system plugin

method

HTTP request method (default: POST)

url

HTTP or WebSocket server endpoint URL

Attributes

Returns

STTP HTTP & WebSocket client message transport plugin

def http[Effect[_]](effectSystem: EffectSystem[Effect], backend: SttpBackend[Effect, _], url: URI, method: HttpMethod): SttpClient[Effect]

Creates an STTP HTTP client message transport plugin with the specified STTP backend.

Creates an STTP HTTP client message transport plugin with the specified STTP backend.

Type parameters

Effect

effect type

Value parameters

backend

STTP backend

effectSystem

effect system plugin

method

HTTP request method (default: POST)

url

HTTP or WebSocket server endpoint URL

Attributes

Returns

STTP HTTP client message transport plugin

Generated with