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 Basic[T] with Product with Serializable
- Alphabetic
- By Inheritance
- WebSocketBodyOutput
- Serializable
- Serializable
- Product
- Equals
- Basic
- EndpointTransput
- EndpointTransputMacros
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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
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( ... ) @native() @HotSpotIntrinsicCandidate()
-
val
codec: Codec[PIPE_REQ_RESP, T, CodecFormat]
- Definition Classes
- WebSocketBodyOutput → Basic
-
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
- Basic
-
def
deprecated(): ThisType[T]
- Definition Classes
- Basic
-
def
description(d: String): ThisType[T]
- Definition Classes
- Basic
-
def
docsExtension[A](key: String, value: A)(implicit arg0: JsonCodec[A]): ThisType[T]
- Definition Classes
- Basic
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
example(example: Example[T]): ThisType[T]
- Definition Classes
- Basic
-
def
example(t: T): ThisType[T]
- Definition Classes
- Basic
-
def
examples(examples: List[Example[T]]): ThisType[T]
- Definition Classes
- Basic
-
final
def
getClass(): Class[_]
- 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 → Basic
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
map[U](mapping: Mapping[T, U]): ThisType[U]
- Definition Classes
- Basic → 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
-
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()
- val requests: Codec[WebSocketFrame, REQ, CodecFormat]
- def requestsDescription(d: String): ThisType[T]
- def requestsDocsExtension[A](key: String, value: A)(implicit arg0: JsonCodec[A]): 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 responsesDocsExtension[A](key: String, value: A)(implicit arg0: JsonCodec[A]): 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
- Basic
-
def
schema(s: Option[Schema[T]]): ThisType[T]
- Definition Classes
- Basic
-
def
schema(s: Schema[T]): ThisType[T]
- Definition Classes
- Basic
-
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]
- Definition Classes
- EndpointTransput
-
def
validateIterable[C[X] <: Iterable[X], U](v: Validator[U])(implicit tIsCU: =:=[T, C[U]]): ThisType[T]
- Definition Classes
- Basic
-
def
validateOption[U](v: Validator[U])(implicit tIsOptionU: =:=[T, Option[U]]): ThisType[T]
- Definition Classes
- Basic
-
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( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated