WebSocketFrameEvent

Instance Constructors

new WebSocketFrameEvent(context: ChannelHandlerContext, initialHttpRequest: InitialHttpRequestMessage, wsFrame: WebSocketFrame, config: WebSocketEventConfig)

initialHttpRequest
The initial HTTP request
wsFrame
Incoming data for processing
config
Web Socket configuration

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

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

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def close(): Unit

Close the web socket connection
val config: WebSocketEventConfig

Web Socket configuration
val context: ChannelHandlerContext

Netty channel associated with this request
Netty channel associated with this request

Definition Classes
WebSocketFrameEvent → SockoEvent
val createdOn: Date

Timestamp when this event was fired
Timestamp when this event was fired

Definition Classes
SockoEvent
def duration(): Long

Number of milliseconds from the time when this context was created
Number of milliseconds from the time when this context was created

Definition Classes
SockoEvent
val endPoint: EndPoint

HTTP end point used by this chunk
HTTP end point used by this chunk

Definition Classes
WebSocketFrameEvent → SockoEvent
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val initialHttpRequest: InitialHttpRequestMessage

The initial HTTP request
val isBinary: Boolean

Indicates a binary frame
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val isText: Boolean

Indicates a text frame
lazy val items: Map[String, Any]

Store of items that can be used to pass data from route to processor and between processors.
Store of items that can be used to pass data from route to processor and between processors.
This map is not synchronized and not thread-safe. In most cases, we expect this cache to be used by a single thread - hence a standard map is faster.
If you do need to use a thread safe map, from your route, instance and store a ConcurrentHashMap as an item in this cache.

Definition Classes
SockoEvent
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val protocolVersion: String

Web socket version
def readBinary(): Array[Byte]

Returns the request content as byte array
def readText(): String

Returns the request content as a string.
Returns the request content as a string. UTF-8 character encoding is assumed
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
var username: Option[String]

Username of the authenticated user.
Username of the authenticated user. You need to set this for it to appear in the web logs.
Socko does not make assumptions on your authentication method. You do it and set this username to let us know.

Definition Classes
SockoEvent
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

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

Definition Classes
AnyRef
Annotations
@throws( ... )
val webSocketId: String

Unique ID for this web socket connection
Unique ID for this web socket connection
With Netty 5, we can use ChannelId. However, this is not supported in Netty 4 so we'll have to use UUID
def writeBinary(binary: Array[Byte]): Unit

Sends a binary web socket frame back to the client
Sends a binary web socket frame back to the client
binary
Binary data to return to the client
def writeText(text: String): Unit

Sends a text web socket frame back to the client
Sends a text web socket frame back to the client
text
Text to send to the client
def writeWebLog(method: String, uri: String, requestSize: Long, responseStatusCode: Int, responseSize: Long): Unit

Adds an entry to the web log.
Adds an entry to the web log.
Web logs were designed for request/response style interaction and not the duplex communication channel of websockets.
By default, Socko does not write web logs for websocket frames. This is because Socko does not know the context of your frames. However, you can write web logs by calling this method from your route or actor processor.
If you have authenticated the user, you can set it in this.username.
method
Can be used to describe the operation or the message type. No spaces allowed.
uri
Can be used to provide context. Querystring is also permissible.
requestSize
Length of request frame. Set to 0 if none.
responseStatusCode
Status code
responseSize
Length of response frame in bytes. Set to 0 if none.
val wsFrame: WebSocketFrame

Incoming data for processing

case class WebSocketFrameEvent(context: ChannelHandlerContext, initialHttpRequest: InitialHttpRequestMessage, wsFrame: WebSocketFrame, config: WebSocketEventConfig) extends SockoEvent with Product with Serializable

Instance Constructors

new WebSocketFrameEvent(context: ChannelHandlerContext, initialHttpRequest: InitialHttpRequestMessage, wsFrame: WebSocketFrame, config: WebSocketEventConfig)

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def close(): Unit

val config: WebSocketEventConfig

val context: ChannelHandlerContext

val createdOn: Date

def duration(): Long

val endPoint: EndPoint

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val initialHttpRequest: InitialHttpRequestMessage

val isBinary: Boolean

final def isInstanceOf[T0]: Boolean

val isText: Boolean

lazy val items: Map[String, Any]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val protocolVersion: String

def readBinary(): Array[Byte]

def readText(): String

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

var username: Option[String]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

val webSocketId: String

def writeBinary(binary: Array[Byte]): Unit

def writeText(text: String): Unit

def writeWebLog(method: String, uri: String, requestSize: Long, responseStatusCode: Int, responseSize: Long): Unit

val wsFrame: WebSocketFrame

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from SockoEvent

Inherited from AnyRef

Inherited from Any

Ungrouped