WebSocket

Abstract Value Members

abstract def isOpen(): F[Boolean]
implicit abstract def monad: MonadError[F]
abstract def receive(): F[WebSocketFrame]

Receive the next frame from the web socket.
Receive the next frame from the web socket. This can be a data frame, or a control frame including WebSocketFrame.Close. After receiving a close frame, no further interactions with the web socket should happen.
However, not all implementations expose the close frame, and web sockets might also get closed without the proper close frame exchange. In such cases, as well as when invoking receive/send after receiving a close frame, this effect will fail with the WebSocketClosed exception.
abstract def send(f: WebSocketFrame, isContinuation: Boolean = false): F[Unit]
abstract def upgradeHeaders: Headers

Concrete 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[java.lang]
Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate() @throws( ... )
def close(): F[Unit]

Idempotent when used sequentially.
def either[T](f: ⇒ F[T]): F[Either[Option[Close], T]]

Returns an effect computing a:
Returns an effect computing a:
- Left if the web socket is closed - optionally with the received close frame (if available). - Right with the original result otherwise.
Will never fail with a WebSocketClosed.
f
The effect describing web socket interactions.
def eitherClose[T](f: ⇒ F[T]): F[Either[Close, T]]

Extracts the received close frame (if available) as the left side of an either, or returns the original result on the right.
Extracts the received close frame (if available) as the left side of an either, or returns the original result on the right.
Will fail with WebSocketClosed if the web socket is closed, but no close frame is available.
f
The effect describing web socket interactions.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

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

Definition Classes
AnyRef → Any
Annotations
@HotSpotIntrinsicCandidate()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@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
@HotSpotIntrinsicCandidate()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@HotSpotIntrinsicCandidate()
def receiveBinary(pongOnPing: Boolean): F[Array[Byte]]

Receive a single binary message (which might come from multiple, fragmented frames).
Receive a single binary message (which might come from multiple, fragmented frames). Ignores non-binary frames and returns combined results. Will fail with WebSocketClosed if the web socket is closed, or if a close frame is received.
pongOnPing
Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.
def receiveBinaryFrame(pongOnPing: Boolean = true): F[Binary]

Receive a single binary data frame, ignoring others.
Receive a single binary data frame, ignoring others. The frame might be a fragment. To receive whole messages, use receiveBinary. Will fail with WebSocketClosed if the web socket is closed, or if a close frame is received.
pongOnPing
Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.
def receiveDataFrame(pongOnPing: Boolean = true): F[Data[_]]

Receive a single data frame, ignoring others.
Receive a single data frame, ignoring others. The frame might be a fragment. Will fail with WebSocketClosed if the web socket is closed, or if a close frame is received.
pongOnPing
Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.
def receiveText(pongOnPing: Boolean = true): F[String]

Receive a single text message (which might come from multiple, fragmented frames).
Receive a single text message (which might come from multiple, fragmented frames). Ignores non-text frames and returns combined results. Will fail with WebSocketClosed if the web socket is closed, or if a close frame is received.
pongOnPing
Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.
def receiveTextFrame(pongOnPing: Boolean = true): F[Text]

Receive a single text data frame, ignoring others.
Receive a single text data frame, ignoring others. The frame might be a fragment. To receive whole messages, use receiveText. Will fail with WebSocketClosed if the web socket is closed, or if a close frame is received.
pongOnPing
Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.
def sendBinary(payload: Array[Byte]): F[Unit]
def sendText(payload: String): F[Unit]
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( ... )
final def wait(arg0: Long): Unit

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
Deprecated
(Since version ) see corresponding Javadoc for more information.

Related Doc: package ws

trait WebSocket[F[_]] extends AnyRef

Abstract Value Members

abstract def isOpen(): F[Boolean]

implicit abstract def monad: MonadError[F]

abstract def receive(): F[WebSocketFrame]

abstract def send(f: WebSocketFrame, isContinuation: Boolean = false): F[Unit]

abstract def upgradeHeaders: Headers

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def close(): F[Unit]

def either[T](f: ⇒ F[T]): F[Either[Option[Close], T]]

def eitherClose[T](f: ⇒ F[T]): F[Either[Close, T]]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def receiveBinary(pongOnPing: Boolean): F[Array[Byte]]

def receiveBinaryFrame(pongOnPing: Boolean = true): F[Binary]

def receiveDataFrame(pongOnPing: Boolean = true): F[Data[_]]

def receiveText(pongOnPing: Boolean = true): F[String]

def receiveTextFrame(pongOnPing: Boolean = true): F[Text]

def sendBinary(payload: Array[Byte]): F[Unit]

def sendText(payload: String): F[Unit]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wait(): Unit

Deprecated Value Members

def finalize(): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped