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

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

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 attribute[A](k: AttributeKey[A], v: A): ThisType[T]
    Definition Classes
    Atom
  6. def attribute[A](k: AttributeKey[A]): Option[A]
    Definition Classes
    Atom
  7. 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.

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

  10. val autoPongOnPing: Boolean
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  12. val codec: Codec[PIPE_REQ_RESP, T, CodecFormat]
    Definition Classes
    WebSocketBodyOutput → Atom
  13. 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.

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

  16. val decodeCloseRequests: Boolean
  17. 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).

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

  28. val ignorePong: Boolean
  29. val info: Info[T]
    Definition Classes
    WebSocketBodyOutput → Atom
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. def map[U](mapping: Mapping[T, U]): ThisType[U]
    Definition Classes
    Atom → EndpointTransput
  32. def map[U](f: (T) ⇒ U)(g: (U) ⇒ T): ThisType[U]
    Definition Classes
    EndpointTransput
  33. def mapDecode[U](f: (T) ⇒ DecodeResult[U])(g: (U) ⇒ T): ThisType[U]
    Definition Classes
    EndpointTransput
  34. macro def mapTo[CASE_CLASS]: ThisType[CASE_CLASS]
    Definition Classes
    EndpointTransputMacros
  35. 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 the f 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

    validate

  36. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  37. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  38. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  39. val requests: Codec[WebSocketFrame, REQ, CodecFormat]
  40. def requestsDescription(d: String): 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 responsesExample(e: RESP): ThisType[T]
  50. def responsesExamples(examples: List[RESP]): ThisType[T]
  51. val responsesInfo: Info[RESP]
  52. def responsesSchema(modify: (Schema[RESP]) ⇒ Schema[RESP]): ThisType[T]
  53. def responsesSchema(s: Option[Schema[RESP]]): ThisType[T]
  54. def responsesSchema(s: Schema[RESP]): ThisType[T]
  55. def schema(modify: (Schema[T]) ⇒ Schema[T]): ThisType[T]
    Definition Classes
    Atom
  56. def schema(s: Option[Schema[T]]): ThisType[T]
    Definition Classes
    Atom
  57. def schema(s: Schema[T]): ThisType[T]
    Definition Classes
    Atom
  58. def show: String
    Definition Classes
    WebSocketBodyOutput → EndpointTransput
  59. val streams: Streams[S]
  60. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  61. 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 .maps or .mapDecodes will be invoked before validation.

    Definition Classes
    EndpointTransput
    See also

    mapValidate

  62. 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 .mapping another one, but directly from Schema[U]. Otherwise the shape of the schema doesn't correspond to the type T, but to some lower-level representation of the type. This might cause invalid results at run-time.

    Definition Classes
    Atom
  63. 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 .mapping another one, but directly from Schema[U]. Otherwise the shape of the schema doesn't correspond to the type T, but to some lower-level representation of the type. This might cause invalid results at run-time.

    Definition Classes
    Atom
  64. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  66. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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 Serializable

Inherited from Product

Inherited from Equals

Inherited from Atom[T]

Inherited from Basic[T]

Inherited from EndpointTransput[T]

Inherited from EndpointTransputMacros[T]

Inherited from AnyRef

Inherited from Any

Ungrouped