tapir-core/sttp.tapir/WebSocketBodyOutput

WebSocketBodyOutput

case class WebSocketBodyOutput[PIPE_REQ_RESP, REQ, RESP, T, S](streams: Streams[S], requests: Codec[WebSocketFrame, REQ, CodecFormat], responses: Codec[WebSocketFrame, RESP, CodecFormat], codec: Codec[PIPE_REQ_RESP, T, CodecFormat], info: Info[T], requestsInfo: Info[REQ], responsesInfo: Info[RESP], concatenateFragmentedFrames: Boolean, ignorePong: Boolean, autoPongOnPing: Boolean, decodeCloseRequests: Boolean, decodeCloseResponses: Boolean, autoPing: Option[(FiniteDuration, Ping)]) extends Atom[T]
trait Serializable
trait Product
trait Equals
trait Atom[T]
trait Basic[T]
class Object
trait Matchable
class Any

Value members

Concrete methods

def autoPing(p: Option[(FiniteDuration, Ping)]): WebSocketBodyOutput[PIPE_REQ_RESP, REQ, RESP, T, S]

Note: some interpreters ignore this setting.

Note: some interpreters ignore this setting.

Value parameters:
p

If Some, send the given Ping frame at the given interval. If None, do not automatically send pings.

def autoPongOnPing(a: Boolean): WebSocketBodyOutput[PIPE_REQ_RESP, REQ, RESP, T, S]

Note: some interpreters ignore this setting.

Note: some interpreters ignore this setting.

Value parameters:
a

If true, WebSocketFrame.Ping frames will cause a matching WebSocketFrame.Pong frame to be sent back, and won't be passed to codecs for decoding. Note that only some interpreters expose ping-pong frames.

def concatenateFragmentedFrames(c: Boolean): WebSocketBodyOutput[PIPE_REQ_RESP, REQ, RESP, T, S]
Value parameters:
c

If true, fragmented frames will be concatenated, and the data frames that the requests & responses codecs decode will always have finalFragment set to true. Note that only some interpreters expose fragmented frames.

def decodeCloseRequests(d: Boolean): WebSocketBodyOutput[PIPE_REQ_RESP, REQ, RESP, T, S]

Note: some interpreters ignore this setting.

Note: some interpreters ignore this setting.

Value parameters:
d

If true, WebSocketFrame.Close frames will be passed to the request codec for decoding (in server interpreters).

def decodeCloseResponses(d: Boolean): WebSocketBodyOutput[PIPE_REQ_RESP, REQ, RESP, T, S]

Note: some interpreters ignore this setting.

Note: some interpreters ignore this setting.

Value parameters:
d

If true, WebSocketFrame.Close frames will be passed to the response codec for decoding (in client interpreters).

def ignorePong(i: Boolean): WebSocketBodyOutput[PIPE_REQ_RESP, REQ, RESP, T, S]

Note: some interpreters ignore this setting.

Note: some interpreters ignore this setting.

Value parameters:
i

If true, WebSocketFrame.Pong frames will be ignored and won't be passed to the codecs for decoding. Note that only some interpreters expose ping-pong frames.

def requestsDescription(d: String): ThisType[T]
def requestsExample(e: REQ): ThisType[T]
def requestsExamples(examples: List[REQ]): ThisType[T]
def requestsSchema(s: Schema[REQ]): ThisType[T]
def requestsSchema(s: Option[Schema[REQ]]): ThisType[T]
def requestsSchema(modify: Schema[REQ] => Schema[REQ]): ThisType[T]
def responsesDescription(d: String): ThisType[T]
def responsesExample(e: RESP): ThisType[T]
def responsesExamples(examples: List[RESP]): ThisType[T]
def responsesSchema(s: Schema[RESP]): ThisType[T]
def responsesSchema(s: Option[Schema[RESP]]): ThisType[T]
def responsesSchema(modify: Schema[RESP] => Schema[RESP]): ThisType[T]
override def show: String
Definition Classes

Inherited methods

def attribute[A](k: AttributeKey[A], v: A): ThisType[T]
Inherited from:
Atom
def attribute[A](k: AttributeKey[A]): Option[A]
Inherited from:
Atom
def default(d: T): ThisType[T]
Inherited from:
Atom
def deprecated(): ThisType[T]
Inherited from:
Atom
def description(d: String): ThisType[T]
Inherited from:
Atom
def example(example: Example[T]): ThisType[T]
Inherited from:
Atom
def example(t: T): ThisType[T]
Inherited from:
Atom
def examples(examples: List[Example[T]]): ThisType[T]
Inherited from:
Atom
override def map[U](mapping: Mapping[T, U]): ThisType[U]
Definition Classes
Inherited from:
Atom
def map[U](f: T => U)(g: U => T): ThisType[U]
Inherited from:
EndpointTransput
def mapDecode[U](f: T => DecodeResult[U])(g: U => T): ThisType[U]
Inherited from:
EndpointTransput
inline def mapTo[CASE_CLASS <: Product](using mc: ProductOf[CASE_CLASS]): ThisType[CASE_CLASS]
Inherited from:
EndpointTransputMacros
def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product
def schema(modify: Schema[T] => Schema[T]): ThisType[T]
Inherited from:
Atom
def schema(s: Option[Schema[T]]): ThisType[T]
Inherited from:
Atom
def schema(s: Schema[T]): ThisType[T]
Inherited from:
Atom
def validate(v: Validator[T]): ThisType[T]
Inherited from:
EndpointTransput
def validateIterable[C <: (Iterable), U](v: Validator[U])(implicit tIsCU: T =:= C[U]): ThisType[T]
Inherited from:
Atom
def validateOption[U](v: Validator[U])(implicit tIsOptionU: T =:= Option[U]): ThisType[T]
Inherited from:
Atom