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] with Product with Serializable
- Alphabetic
- By Inheritance
- WebSocketBodyOutput
- Serializable
- Product
- Equals
- Atom
- Basic
- EndpointTransput
- EndpointTransputMacros
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new WebSocketBodyOutput(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)])
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 attribute[A](k: AttributeKey[A], v: A): ThisType[T]
- Definition Classes
- Atom
- def attribute[A](k: AttributeKey[A]): Option[A]
- Definition Classes
- Atom
- 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.
- p
If
Some
, send the givenPing
frame at the given interval. IfNone
, do not automatically send pings.
- val autoPing: Option[(FiniteDuration, Ping)]
- def autoPongOnPing(a: Boolean): WebSocketBodyOutput[PIPE_REQ_RESP, REQ, RESP, T, S]
Note: some interpreters ignore this setting.
Note: some interpreters ignore this setting.
- 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.
- val autoPongOnPing: Boolean
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val codec: Codec[PIPE_REQ_RESP, T, CodecFormat]
- Definition Classes
- WebSocketBodyOutput → Atom
- def concatenateFragmentedFrames(c: Boolean): WebSocketBodyOutput[PIPE_REQ_RESP, REQ, RESP, T, S]
- c
If
true
, fragmented frames will be concatenated, and the data frames that therequests
&responses
codecs decode will always havefinalFragment
set totrue
. Note that only some interpreters expose fragmented frames.
- val concatenateFragmentedFrames: Boolean
- def decodeCloseRequests(d: Boolean): WebSocketBodyOutput[PIPE_REQ_RESP, REQ, RESP, T, S]
Note: some interpreters ignore this setting.
Note: some interpreters ignore this setting.
- d
If
true
, WebSocketFrame.Close frames will be passed to the request codec for decoding (in server interpreters).
- val decodeCloseRequests: Boolean
- def decodeCloseResponses(d: Boolean): WebSocketBodyOutput[PIPE_REQ_RESP, REQ, RESP, T, S]
Note: some interpreters ignore this setting.
Note: some interpreters ignore this setting.
- d
If
true
, WebSocketFrame.Close frames will be passed to the response codec for decoding (in client interpreters).
- val decodeCloseResponses: Boolean
- def default(d: T): ThisType[T]
- Definition Classes
- Atom
- def deprecated(): ThisType[T]
- Definition Classes
- Atom
- def description(d: String): ThisType[T]
- Definition Classes
- Atom
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def example(example: Example[T]): ThisType[T]
- Definition Classes
- Atom
- def example(t: T): ThisType[T]
- Definition Classes
- Atom
- def examples(examples: List[Example[T]]): ThisType[T]
- Definition Classes
- Atom
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def ignorePong(i: Boolean): WebSocketBodyOutput[PIPE_REQ_RESP, REQ, RESP, T, S]
Note: some interpreters ignore this setting.
Note: some interpreters ignore this setting.
- 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.
- val ignorePong: Boolean
- val info: Info[T]
- Definition Classes
- WebSocketBodyOutput → Atom
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def map[U](mapping: Mapping[T, U]): ThisType[U]
- Definition Classes
- Atom → EndpointTransput
- def map[U](f: (T) => U)(g: (U) => T): ThisType[U]
- Definition Classes
- EndpointTransput
- def mapDecode[U](f: (T) => DecodeResult[U])(g: (U) => T): ThisType[U]
- Definition Classes
- EndpointTransput
- macro def mapTo[CASE_CLASS]: ThisType[CASE_CLASS]
- Definition Classes
- EndpointTransputMacros
- def mapValidate[U](v: Validator[T])(f: (T) => U)(g: (U) => T): ThisType[U]
Adds the given validator, and maps to the given higher-level type
U
.Adds the given validator, and maps to the given higher-level type
U
.Unlike a
.validate(v).map(f)(g)
invocation, during decoding the validator is run before applying thef
function. If there are validation errors, decoding fails. However, the validator is then invoked again on the fully decoded value.This is useful to create inputs/outputs for types, which are unrepresentable unless the validator's condition is met, e.g. due to preconditions in the constructor.
- Definition Classes
- EndpointTransput
- See also
- 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()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val requests: Codec[WebSocketFrame, REQ, CodecFormat]
- def requestsDescription(d: String): ThisType[T]
- def requestsExample(e: REQ): ThisType[T]
- def requestsExamples(examples: List[REQ]): ThisType[T]
- val requestsInfo: Info[REQ]
- def requestsSchema(modify: (Schema[REQ]) => Schema[REQ]): ThisType[T]
- def requestsSchema(s: Option[Schema[REQ]]): ThisType[T]
- def requestsSchema(s: Schema[REQ]): ThisType[T]
- val responses: Codec[WebSocketFrame, RESP, CodecFormat]
- def responsesDescription(d: String): ThisType[T]
- def responsesExample(e: RESP): ThisType[T]
- def responsesExamples(examples: List[RESP]): ThisType[T]
- val responsesInfo: Info[RESP]
- def responsesSchema(modify: (Schema[RESP]) => Schema[RESP]): ThisType[T]
- def responsesSchema(s: Option[Schema[RESP]]): ThisType[T]
- def responsesSchema(s: Schema[RESP]): ThisType[T]
- def schema(modify: (Schema[T]) => Schema[T]): ThisType[T]
- Definition Classes
- Atom
- def schema(s: Option[Schema[T]]): ThisType[T]
- Definition Classes
- Atom
- def schema(s: Schema[T]): ThisType[T]
- Definition Classes
- Atom
- def show: String
- Definition Classes
- WebSocketBodyOutput → EndpointTransput
- val streams: Streams[S]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def validate(v: Validator[T]): ThisType[T]
Adds a validator.
Adds a validator.
Note that validation is run on a fully decoded value. That is, during decoding, first the decoding functions are run, followed by validations. Hence any functions provided in subsequent
.map
s or.mapDecode
s will be invoked before validation.- Definition Classes
- EndpointTransput
- See also
- def validateIterable[C[X] <: Iterable[X], U](v: Validator[U])(implicit tIsCU: =:=[T, C[U]]): ThisType[T]
Adds a validator which validates each element in the collection.
Adds a validator which validates each element in the collection.
Should only be used if the schema hasn't been created by
.map
ping another one, but directly fromSchema[U]
. Otherwise the shape of the schema doesn't correspond to the typeT
, but to some lower-level representation of the type. This might cause invalid results at run-time.- Definition Classes
- Atom
- def validateOption[U](v: Validator[U])(implicit tIsOptionU: =:=[T, Option[U]]): ThisType[T]
Adds a validator which validates the option's element, if it is present.
Adds a validator which validates the option's element, if it is present.
Should only be used if the schema hasn't been created by
.map
ping another one, but directly fromSchema[U]
. Otherwise the shape of the schema doesn't correspond to the typeT
, but to some lower-level representation of the type. This might cause invalid results at run-time.- Definition Classes
- Atom
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated