trait SttpBackend[F[_], -S, -WS_HANDLER[_]] extends AnyRef
- F
The type constructor in which responses are wrapped. E.g.
Identity
for synchronous backends,Future
for asynchronous backends.- 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.
- Alphabetic
- By Inheritance
- SttpBackend
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
- abstract def close(): F[Unit]
-
abstract
def
openWebsocket[T, WS_RESULT](request: Request[T, S], handler: WS_HANDLER[WS_RESULT]): F[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
). -
abstract
def
responseMonad: MonadError[F]
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.
- abstract def send[T](request: Request[T, S]): F[Response[T]]
Concrete 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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
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
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @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
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )