c

sttp.tapir

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 Basic[T] with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, Basic[T], EndpointTransput[T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WebSocketBodyOutput
  2. Serializable
  3. Product
  4. Equals
  5. Basic
  6. EndpointTransput
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. 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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. 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 given Ping frame at the given interval. If None, do not automatically send pings.

  6. val autoPing: Option[(FiniteDuration, Ping)]
  7. 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.

  8. val autoPongOnPing: Boolean
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. val codec: Codec[PIPE_REQ_RESP, T, CodecFormat]
    Definition Classes
    WebSocketBodyOutput → Basic
  11. 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 the requests & responses codecs decode will always have finalFragment set to true. Note that only some interpreters expose fragmented frames.

  12. val concatenateFragmentedFrames: Boolean
  13. 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).

  14. val decodeCloseRequests: Boolean
  15. 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).

  16. val decodeCloseResponses: Boolean
  17. def default(d: T): ThisType[T]
    Definition Classes
    Basic
  18. def deprecated(): ThisType[T]
    Definition Classes
    Basic
  19. def description(d: String): ThisType[T]
    Definition Classes
    Basic
  20. def docsExtension[A](key: String, value: A)(implicit arg0: JsonCodec[A]): ThisType[T]
    Definition Classes
    Basic
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def example(example: Example[T]): ThisType[T]
    Definition Classes
    Basic
  23. def example(t: T): ThisType[T]
    Definition Classes
    Basic
  24. def examples(examples: List[Example[T]]): ThisType[T]
    Definition Classes
    Basic
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. 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.

  27. val ignorePong: Boolean
  28. val info: Info[T]
    Definition Classes
    WebSocketBodyOutput → Basic
  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def map[U](mapping: Mapping[T, U]): ThisType[U]
    Definition Classes
    Basic → EndpointTransput
  31. def map[U](f: (T) => U)(g: (U) => T): ThisType[U]
    Definition Classes
    EndpointTransput
  32. def mapDecode[U](f: (T) => DecodeResult[U])(g: (U) => T): ThisType[U]
    Definition Classes
    EndpointTransput
  33. def mapTo[COMPANION, CASE_CLASS <: Product](c: COMPANION)(implicit fc: FnComponents[COMPANION, T, CASE_CLASS]): ThisType[CASE_CLASS]
    Definition Classes
    EndpointTransput
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  37. def productElementNames: Iterator[String]
    Definition Classes
    Product
  38. val requests: Codec[WebSocketFrame, REQ, CodecFormat]
  39. def requestsDescription(d: String): ThisType[T]
  40. def requestsDocsExtension[A](key: String, value: A)(implicit arg0: JsonCodec[A]): ThisType[T]
  41. def requestsExample(e: REQ): ThisType[T]
  42. def requestsExamples(examples: List[REQ]): ThisType[T]
  43. val requestsInfo: Info[REQ]
  44. def requestsSchema(modify: (Schema[REQ]) => Schema[REQ]): ThisType[T]
  45. def requestsSchema(s: Option[Schema[REQ]]): ThisType[T]
  46. def requestsSchema(s: Schema[REQ]): ThisType[T]
  47. val responses: Codec[WebSocketFrame, RESP, CodecFormat]
  48. def responsesDescription(d: String): ThisType[T]
  49. def responsesDocsExtension[A](key: String, value: A)(implicit arg0: JsonCodec[A]): ThisType[T]
  50. def responsesExample(e: RESP): ThisType[T]
  51. def responsesExamples(examples: List[RESP]): ThisType[T]
  52. val responsesInfo: Info[RESP]
  53. def responsesSchema(modify: (Schema[RESP]) => Schema[RESP]): ThisType[T]
  54. def responsesSchema(s: Option[Schema[RESP]]): ThisType[T]
  55. def responsesSchema(s: Schema[RESP]): ThisType[T]
  56. def schema(modify: (Schema[T]) => Schema[T]): ThisType[T]
    Definition Classes
    Basic
  57. def schema(s: Option[Schema[T]]): ThisType[T]
    Definition Classes
    Basic
  58. def schema(s: Schema[T]): ThisType[T]
    Definition Classes
    Basic
  59. def show: String
    Definition Classes
    WebSocketBodyOutput → EndpointTransput
  60. val streams: Streams[S]
  61. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  62. def validate(v: Validator[T]): ThisType[T]
    Definition Classes
    EndpointTransput
  63. def validateIterable[C[X] <: Iterable[X], U](v: Validator[U])(implicit tIsCU: =:=[T, C[U]]): ThisType[T]
    Definition Classes
    Basic
  64. def validateOption[U](v: Validator[U])(implicit tIsOptionU: =:=[T, Option[U]]): ThisType[T]
    Definition Classes
    Basic
  65. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  67. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Basic[T]

Inherited from EndpointTransput[T]

Inherited from AnyRef

Inherited from Any

Ungrouped