core
API
Generated with
core/sttp.client4/WebSocketStreamBackend

WebSocketStreamBackend

sttp.client4.WebSocketStreamBackend
trait WebSocketStreamBackend[F[_], S] extends WebSocketBackend[F], StreamBackend[F, S], GenericBackend[F, S & WebSockets]

A GenericBackend which supports websockets, streams of type S and uses F to represent side-effects.

Attributes

Graph
Supertypes
trait StreamBackend[F, S]
trait WebSocketBackend[F]
trait Backend[F]
trait GenericBackend[F, S & WebSockets]
class Object
trait Matchable
class Any
Show all
Known subtypes

Members list

Value members

Inherited methods

def close(): F[Unit]

Close the backend, releasing any resources (such as thread or connection pools) that have been allocated when opening or using the backend.

Close the backend, releasing any resources (such as thread or connection pools) that have been allocated when opening or using the backend.

Attributes

Inherited from:
GenericBackend
def monad: MonadError[F]

A monad instance for the F effect type. Allows writing wrapper backends, which map/`flatMap`` over the return value of send.

A monad instance for the F effect type. Allows writing wrapper backends, which map/`flatMap`` over the return value of send.

Attributes

Inherited from:
GenericBackend
def send[T](request: GenericRequest[T, S & WebSockets & Effect[F]]): F[Response[T]]

Send the given request. Should only be used when implementing new backends, or backend wrappers. Client code should instead use the send methods on the request type, e.g. Request.send.

Send the given request. Should only be used when implementing new backends, or backend wrappers. Client code should instead use the send methods on the request type, e.g. Request.send.

Attributes

Inherited from:
GenericBackend
Generated with