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

SttpClient

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

Attributes

Companion
class
Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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
case object TransportContext

Attributes

Companion
class
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type

Types

type Context = HttpContext[TransportContext]

Request context type.

Request context type.

Attributes

Inherited types

type MirroredElemLabels = EmptyTuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Singleton
type MirroredElemTypes = EmptyTuple

Attributes

Inherited from:
Singleton
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
type MirroredMonoType = Singleton.this.type

The mirrored *-type

The mirrored *-type

Attributes

Inherited from:
Singleton
type MirroredType = Singleton.this.type

Attributes

Inherited from:
Singleton

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.

Creates an STTP HTTP & WebSocket 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 & 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

Inherited methods

def fromProduct(p: Product): MirroredMonoType

Create a new instance of type T with elements taken from product p.

Create a new instance of type T with elements taken from product p.

Attributes

Inherited from:
Singleton
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with