WebSocket

Abstract Value Members

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

After receiving a close frame, no further interactions with the web socket should happen.
After receiving a close frame, no further interactions with the web socket should happen. Subsequent invocations of receive, as well as send, 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.
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[Either[Close, 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.
pongOnPing
Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.
def receiveBinaryFrame(pongOnPing: Boolean = true): F[Either[Close, 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.
pongOnPing
Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.
def receiveDataFrame(pongOnPing: Boolean = true): F[Either[Close, Data[_]]]

Receive a single data frame, ignoring others.
Receive a single data frame, ignoring others. The frame might be a fragment.
pongOnPing
Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.
def receiveText(pongOnPing: Boolean = true): F[Either[Close, 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.
pongOnPing
Should a WebSocketFrame.Pong be sent when a WebSocketFrame.Ping is received.
def receiveTextFrame(pongOnPing: Boolean = true): F[Either[Close, 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.
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]

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[Either[Close, Array[Byte]]]

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

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

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

def receiveTextFrame(pongOnPing: Boolean = true): F[Either[Close, 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