object Fs2WebSockets
- Alphabetic
- By Inheritance
- Fs2WebSockets
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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 clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def handleSocketThroughPipe[F[_]](ws: WebSocket[F], sendPongOnPing: Boolean = true)(pipe: Pipe[F, Incoming, WebSocketFrame])(implicit arg0: ConcurrentEffect[F]): F[Unit]
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
- def handleSocketThroughPipeWithFragmentation[F[_]](ws: WebSocket[F], sendPongOnPing: Boolean = true)(pipe: Pipe[F, Incoming, (WebSocketFrame, Boolean)])(implicit arg0: ConcurrentEffect[F]): F[Unit]
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
- def handleSocketThroughTextPipe[F[_]](ws: WebSocket[F])(pipe: Pipe[F, String, Either[Close, String]])(implicit arg0: ConcurrentEffect[F]): F[Unit]
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
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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])