Object

sttp.client.impl.fs2

Fs2WebSockets

Related Doc: package fs2

Permalink

object Fs2WebSockets

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Fs2WebSockets
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  9. def handleSocketThroughPipe[F[_]](ws: WebSocket[F], sendPongOnPing: Boolean = true)(pipe: Pipe[F, Incoming, WebSocketFrame])(implicit arg0: ConcurrentEffect[F]): F[Unit]

    Permalink

    Same as handleSocketThroughPipeWithFragmentation(), but assumes all frames are no continuations.

    Same as handleSocketThroughPipeWithFragmentation(), but assumes all frames are no continuations.

    F

    the effect type

    ws

    the websocket to handle

    sendPongOnPing

    if true, then automatically handle sending pongs on pings (which are then not passed to the pipe)

    pipe

    the pipe to handle the socket

    returns

    an Unit effect describing the full run of the websocket through the pipe

  10. def handleSocketThroughPipeWithFragmentation[F[_]](ws: WebSocket[F], sendPongOnPing: Boolean = true)(pipe: Pipe[F, Incoming, (WebSocketFrame, Boolean)])(implicit arg0: ConcurrentEffect[F]): F[Unit]

    Permalink

    Handle the websocket through a Pipe which receives the incoming events and produces the messages to be sent to the server.

    Handle the websocket through a Pipe which receives the incoming events and produces the messages to be sent to the server. Not that by the nature of a Pipe, there no need that these two streams are coupled. Just make sure to consume the input as otherwise the receiving buffer might overflow (use Stream.drain if you want to discard). Messages to be sent need to be coupled with a Boolean indicating whether this frame is a continuation, see WebSocket.send().

    F

    the effect type

    ws

    the websocket to handle

    sendPongOnPing

    if true, then automatically handle sending pongs on pings (which are then not passed to the pipe)

    pipe

    the pipe to handle the socket

    returns

    an Unit effect describing the full run of the websocket through the pipe

  11. def handleSocketThroughTextPipe[F[_]](ws: WebSocket[F])(pipe: Pipe[F, String, Either[Close, String]])(implicit arg0: ConcurrentEffect[F]): F[Unit]

    Permalink

    Like handleSocketThroughPipe() but extracts the contents of incoming text messages and wraps outgoing messages in text frames.

    Like handleSocketThroughPipe() but extracts the contents of incoming text messages and wraps outgoing messages in text frames. Helpful for implementing text-only protocols. Note: It always sends a pong for any received ping.

    F

    the effect type

    ws

    the websocket to handle

    pipe

    the pipe to handle the socket

    returns

    an Unit effect describing the full run of the websocket through the pipe

  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped