EitherBackend

A synchronous backend that safely wraps SttpBackend exceptions in Either[Throwable, ?]'s

S: The type of streams that are supported by the backend. Nothing, if streaming requests/responses is not supported by this backend.
WS_HANDLER: The type of websocket handlers, that are supported by this backend. The handler is parametrised by the value that is being returned when the websocket is established. NothingT, if websockets are not supported.

Linear Supertypes

SttpBackend[[β$0$]Either[Throwable, β$0$], S, WS_HANDLER], AnyRef, Any

Instance Constructors

new EitherBackend(delegate: SttpBackend[Identity, S, WS_HANDLER])

delegate
A synchronous SttpBackend which to which this backend forwards all requests

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def close(): Either[Throwable, Unit]

Definition Classes
EitherBackend → SttpBackend
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def openWebsocket[T, WS_RESULT](request: Request[T, S], handler: WS_HANDLER[WS_RESULT]): Either[Throwable, WebSocketResponse[WS_RESULT]]

Opens a websocket, using the given backend-specific handler.
Opens a websocket, using the given backend-specific handler.
If the connection doesn't result in a websocket being opened, a failed effect is returned, or an exception is thrown (depending on F).

Definition Classes
EitherBackend → SttpBackend
def responseMonad: MonadError[[β$1$]Either[Throwable, β$1$]]

The effect wrapper for responses.
The effect wrapper for responses. Allows writing wrapper backends, which map/flatMap over the return value of send and openWebsocket.

Definition Classes
EitherBackend → SttpBackend
def send[T](request: Request[T, S]): Either[Throwable, Response[T]]

Definition Classes
EitherBackend → SttpBackend
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package client

class EitherBackend[S, WS_HANDLER[_]] extends SttpBackend[[β$0$]Either[Throwable, β$0$], S, WS_HANDLER]

Instance Constructors

new EitherBackend(delegate: SttpBackend[Identity, S, WS_HANDLER])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def close(): Either[Throwable, Unit]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def openWebsocket[T, WS_RESULT](request: Request[T, S], handler: WS_HANDLER[WS_RESULT]): Either[Throwable, WebSocketResponse[WS_RESULT]]

def responseMonad: MonadError[[β$1$]Either[Throwable, β$1$]]

def send[T](request: Request[T, S]): Either[Throwable, Response[T]]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from SttpBackend[[β$0$]Either[Throwable, β$0$], S, WS_HANDLER]

Inherited from AnyRef

Inherited from Any

Ungrouped