core
API
Generated with
core/sttp.client4/WebSocketRequest

WebSocketRequest

sttp.client4.WebSocketRequest
final case class WebSocketRequest[F[_], T](method: Method, uri: Uri, body: BasicBody, headers: Seq[Header], response: WebSocketResponseAs[F, T], options: RequestOptions, tags: Map[String, Any]) extends GenericRequest[T, WebSockets & Effect[F]], RequestBuilder[WebSocketRequest[F, T]]

Describes an HTTP WebSocket request.

The request can be sent using an instance of WebSocketBackend with the send method.

Type parameters

F

The effect type used to process the WebSocket. Might include asynchronous computations (e.g. scala.concurrent.Future), pure effect descriptions (IO), or synchronous computations (Identity).

T

The target type, to which the response body should be read. If the WebSocket interactions are described entirely by the response description, this might be Unit. Otherwise, this can be a sttp.ws.WebSocket instance.

Value parameters

response

Description of how the WebSocket should be handled. Needs to be specified upfront so that the response is always consumed and hence there are no requirements on client code to consume it.

tags

Request-specific tags which can be used by backends for logging, metrics, etc. Empty by default.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait GenericRequest[T, WebSockets & Effect[F]]
trait RequestMetadata
trait HasHeaders
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def mapResponse[T2](f: T => T2): WebSocketRequest[F, T2]
override def method(method: Method, uri: Uri): WebSocketRequest[F, T]

Set the method & uri to the given ones.

Set the method & uri to the given ones.

Attributes

Definition Classes
def send(backend: WebSocketBackend[F]): F[Response[T]]

Sends the WebSocket request, using the given backend.

Sends the WebSocket request, using the given backend.

Attributes

Returns

An F-effect, containing a Response, with the body handled as specified by this request (see Request.response). Effects might include asynchronous computations (e.g. scala.concurrent.Future), pure effect descriptions (IO), or error wrappers (e.g. TryBackend). Exceptions are represented as failed effects (e.g. failed futures). The response WebSocket is handled as specified by this request (see Request.response). Known exceptions are converted by backends to one of SttpClientException. Other exceptions are thrown unchanged.

override def showBasic: String

Attributes

Definition Classes
def streamBody[S](s: Streams[S])(b: BinaryStream): WebSocketStreamRequest[T, Effect[F] & S]
override def withHeaders(headers: Seq[Header]): WebSocketRequest[F, T]

Replace all headers with the given ones.

Replace all headers with the given ones.

Attributes

Definition Classes
override def withOptions(options: RequestOptions): WebSocketRequest[F, T]

Replace all options with the given ones.

Replace all options with the given ones.

Attributes

Definition Classes
override def withTags(tags: Map[String, Any]): WebSocketRequest[F, T]

Replace all tags with the given ones.

Replace all tags with the given ones.

Attributes

Definition Classes

Inherited methods

def acceptEncoding(encoding: String): PR

Attributes

Inherited from:
PartialRequestBuilder
def auth: SpecifyAuthScheme[PR]

Attributes

Inherited from:
PartialRequestBuilder
def autoDecompressionDisabled: Boolean

Attributes

Inherited from:
PartialRequestBuilder
def body(fs: Seq[(String, String)], encoding: String): PR

Encodes the given parameters as form data. If content type is not yet specified, will be set to application/x-www-form-urlencoded.

Encodes the given parameters as form data. If content type is not yet specified, will be set to application/x-www-form-urlencoded.

If content length is not yet specified, will be set to the length of the number of bytes in the url-encoded parameter string.

Attributes

Inherited from:
PartialRequestBuilder
def body(fs: (String, String)*): PR

Encodes the given parameters as form data using utf-8. If content type is not yet specified, will be set to application/x-www-form-urlencoded.

Encodes the given parameters as form data using utf-8. If content type is not yet specified, will be set to application/x-www-form-urlencoded.

If content length is not yet specified, will be set to the length of the number of bytes in the url-encoded parameter string.

Attributes

Inherited from:
PartialRequestBuilder
def body(fs: Map[String, String], encoding: String): PR

Encodes the given parameters as form data. If content type is not yet specified, will be set to application/x-www-form-urlencoded.

Encodes the given parameters as form data. If content type is not yet specified, will be set to application/x-www-form-urlencoded.

If content length is not yet specified, will be set to the length of the number of bytes in the url-encoded parameter string.

Attributes

Inherited from:
PartialRequestBuilder
def body(fs: Map[String, String]): PR

Encodes the given parameters as form data using utf-8. If content type is not yet specified, will be set to application/x-www-form-urlencoded.

Encodes the given parameters as form data using utf-8. If content type is not yet specified, will be set to application/x-www-form-urlencoded.

If content length is not yet specified, will be set to the length of the number of bytes in the url-encoded parameter string.

Attributes

Inherited from:
PartialRequestBuilder
def body(b: InputStream): PR

If content type is not yet specified, will be set to application/octet-stream.

If content type is not yet specified, will be set to application/octet-stream.

Attributes

Inherited from:
PartialRequestBuilder
def body(b: ByteBuffer): PR

If content type is not yet specified, will be set to application/octet-stream.

If content type is not yet specified, will be set to application/octet-stream.

Attributes

Inherited from:
PartialRequestBuilder
def body(b: Array[Byte]): PR

If content type is not yet specified, will be set to application/octet-stream.

If content type is not yet specified, will be set to application/octet-stream.

If content length is not yet specified, will be set to the length of the given array.

Attributes

Inherited from:
PartialRequestBuilder
def body(b: String, encoding: String): PR

If content type is not yet specified, will be set to text/plain with the given encoding.

If content type is not yet specified, will be set to text/plain with the given encoding.

If content length is not yet specified, will be set to the number of bytes in the string using the given encoding.

Attributes

Inherited from:
PartialRequestBuilder
def body(b: String): PR

Uses the utf-8 encoding.

Uses the utf-8 encoding.

If content type is not yet specified, will be set to text/plain with utf-8 encoding.

If content length is not yet specified, will be set to the number of bytes in the string using the utf-8 encoding.

Attributes

Inherited from:
PartialRequestBuilder
def body[B : BodySerializer](b: B): R

If content type is not yet specified, will be set to application/octet-stream.

If content type is not yet specified, will be set to application/octet-stream.

Attributes

Inherited from:
PartialRequestExtensions
def body(file: File): R

If content type is not yet specified, will be set to application/octet-stream.

If content type is not yet specified, will be set to application/octet-stream.

If content length is not yet specified, will be set to the length of the given file.

Attributes

Inherited from:
PartialRequestExtensions
def contentLength(l: Long): PR

Attributes

Inherited from:
PartialRequestBuilder
def contentLength: Option[Long]

Attributes

Inherited from:
HasHeaders
def contentType(ct: String, encoding: String): PR

Attributes

Inherited from:
PartialRequestBuilder
def contentType(mt: MediaType): PR

Attributes

Inherited from:
PartialRequestBuilder
def contentType(ct: String): PR

Attributes

Inherited from:
PartialRequestBuilder
def contentType: Option[String]

Attributes

Inherited from:
HasHeaders
def cookies(nvs: (String, String)*): PR

Attributes

Inherited from:
PartialRequestBuilder
def cookies(cs: Iterable[CookieWithMeta]): PR

Attributes

Inherited from:
PartialRequestBuilder
def cookies(r: Response[_]): PR

Attributes

Inherited from:
PartialRequestBuilder
def cookies: Seq[Either[String, CookieWithMeta]]

Attributes

Inherited from:
HasHeaders
def delete(uri: Uri): R

Attributes

Inherited from:
PartialRequestBuilder
def disableAutoDecompression: PR

Attributes

Inherited from:
PartialRequestBuilder
def followRedirects(fr: Boolean): PR

Attributes

Inherited from:
PartialRequestBuilder
def get(uri: Uri): R

Attributes

Inherited from:
PartialRequestBuilder
def head(uri: Uri): R

Attributes

Inherited from:
PartialRequestBuilder
def header(k: String, ov: Option[String]): PR

Adds the given header to the end of the headers sequence, if the value is defined. Otherwise has no effect.

Adds the given header to the end of the headers sequence, if the value is defined. Otherwise has no effect.

Attributes

Inherited from:
PartialRequestBuilder
def header(k: String, v: String): PR

Adds the given header to the end of the headers sequence.

Adds the given header to the end of the headers sequence.

Attributes

Inherited from:
PartialRequestBuilder
def header(k: String, v: String, replaceExisting: Boolean): PR

Adds the given header to the end of the headers sequence.

Adds the given header to the end of the headers sequence.

Value parameters

replaceExisting

If there's already a header with the same name, should it be replaced?

Attributes

Inherited from:
PartialRequestBuilder
def header(h: Header, replaceExisting: Boolean): PR

Adds the given header to the end of the headers sequence.

Adds the given header to the end of the headers sequence.

Value parameters

replaceExisting

If there's already a header with the same name, should it be replaced?

Attributes

Inherited from:
PartialRequestBuilder
def header(h: String): Option[String]

Attributes

Inherited from:
HasHeaders
def headers(hs: Seq[Header], replaceExisting: Boolean): PR

Adds the given headers to the end of the headers sequence.

Adds the given headers to the end of the headers sequence.

Attributes

Inherited from:
PartialRequestBuilder
def headers(hs: Header*): PR

Adds the given headers to the end of the headers sequence.

Adds the given headers to the end of the headers sequence.

Attributes

Inherited from:
PartialRequestBuilder
def headers(hs: Map[String, String], replaceExisting: Boolean): PR

Adds the given headers to the end of the headers sequence.

Adds the given headers to the end of the headers sequence.

Value parameters

replaceExisting

If there's already a header with the same name, should it be replaced?

Attributes

Inherited from:
PartialRequestBuilder
def headers(hs: Map[String, String]): PR

Adds the given headers to the end of the headers sequence.

Adds the given headers to the end of the headers sequence.

Attributes

Inherited from:
PartialRequestBuilder
def headers(h: String): Seq[String]

Attributes

Inherited from:
HasHeaders
def httpVersion: Option[HttpVersion]

GetHttpVersion from tags in request. Supported only is a few backends

GetHttpVersion from tags in request. Supported only is a few backends

Attributes

Returns

one of values form HttpVersion enum or None

Inherited from:
PartialRequestBuilder
def httpVersion(version: HttpVersion): PR

Allows setting HTTP version per request. Supported only is a few backends

Allows setting HTTP version per request. Supported only is a few backends

Value parameters

version:

one of values from HttpVersion enum.

Attributes

Returns

request with version tag

Inherited from:
PartialRequestBuilder
def isWebSocket: Boolean

Attributes

Inherited from:
GenericRequest
def logSettings(logRequestBody: Option[Boolean], logResponseBody: Option[Boolean], logRequestHeaders: Option[Boolean], logResponseHeaders: Option[Boolean]): PR

Will only have effect when using the LoggingBackend

Will only have effect when using the LoggingBackend

Attributes

Inherited from:
PartialRequestBuilder
def loggingOptions: Option[LoggingOptions]

Attributes

Inherited from:
PartialRequestBuilder
def maxRedirects(n: Int): PR

Attributes

Inherited from:
PartialRequestBuilder
def multipartBody(p1: Part[BasicBodyPart], ps: Part[BasicBodyPart]*): PR

Attributes

Inherited from:
PartialRequestBuilder
def multipartBody(ps: Seq[Part[BasicBodyPart]]): PR

Attributes

Inherited from:
PartialRequestBuilder
def onlyMetadata: RequestMetadata

Metadata of the request, which doesn't retain the request body, or the response handling specification.

Metadata of the request, which doesn't retain the request body, or the response handling specification.

Attributes

Inherited from:
GenericRequest
def options(uri: Uri): R

Attributes

Inherited from:
PartialRequestBuilder
def patch(uri: Uri): R

Attributes

Inherited from:
PartialRequestBuilder
def post(uri: Uri): R

Attributes

Inherited from:
PartialRequestBuilder
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def proxyAuth: SpecifyAuthScheme[PR]

Attributes

Inherited from:
PartialRequestBuilder
def put(uri: Uri): R

Attributes

Inherited from:
PartialRequestBuilder
def readTimeout(t: Duration): PR

When the request is sent, if reading the response times out (there's no activity for the given period of time), a failed effect will be returned, or an exception will be thrown

When the request is sent, if reading the response times out (there's no activity for the given period of time), a failed effect will be returned, or an exception will be thrown

Attributes

Inherited from:
PartialRequestBuilder
def redirectToGet(r: Boolean): PR

When a POST or PUT request is redirected, should the redirect be a POST/PUT as well (with the original body), or should the request be converted to a GET without a body.

When a POST or PUT request is redirected, should the redirect be a POST/PUT as well (with the original body), or should the request be converted to a GET without a body.

Note that this only affects 301 and 302 redirects. 303 redirects are always converted, while 307 and 308 redirects always keep the same method.

See https://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections for details.

Attributes

Inherited from:
PartialRequestBuilder
def show(includeBody: Boolean, includeHeaders: Boolean, sensitiveHeaders: Set[String]): String

Attributes

Inherited from:
PartialRequestBuilder
def tag(k: String): Option[Any]

Attributes

Inherited from:
PartialRequestBuilder
def tag(k: String, v: Any): PR

Attributes

Inherited from:
PartialRequestBuilder
def toCurl(sensitiveHeaders: Set[String], omitAcceptEncoding: Boolean): String

Attributes

Inherited from:
GenericRequest
def toCurl(omitAcceptEncoding: Boolean): String

Attributes

Inherited from:
GenericRequest
def toCurl(sensitiveHeaders: Set[String]): String

Attributes

Inherited from:
GenericRequest
def toCurl: String

Attributes

Inherited from:
GenericRequest
def toRfc2616Format(sensitiveHeaders: Set[String]): String

Attributes

Inherited from:
GenericRequest
def toRfc2616Format: String

Attributes

Inherited from:
GenericRequest
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
RequestMetadata -> Any
Inherited from:
RequestMetadata
def unsafeCookies: Seq[CookieWithMeta]

Attributes

Inherited from:
HasHeaders
def withBody(body: BasicBody): PR

Attributes

Inherited from:
PartialRequestBuilder
Generated with