Package Torello.Browser

Class Network.WebSocketFrame

java.lang.Object

Torello.Java.Additional.BaseType

Torello.Browser.Network.WebSocketFrame

Enclosing class:

Network

public static class Network.WebSocketFrame
extends BaseType

WebSocket message data. This represents an entire WebSocket message, not just a fragmented frame as the name suggests.

Hi-Lited Source-Code:

• View Here: Torello/Browser/Network.java
• Open New Browser-Tab: Torello/Browser/Network.java

File Size: 2,391 Bytes Line Count: 59 '\n' Characters Found

Field Summary

Serializable ID
Modifier and Type	Field
protected static long	serialVersionUID	For Object Serialization.
Type Properties
Modifier and Type	Field
boolean	mask	WebSocket message mask.
Number	opcode	WebSocket message opcode.
String	payloadData	WebSocket message payload data.

Constructor Summary

Constructors

Constructor	Description
WebSocketFrame(Number opcode, boolean mask, String payloadData)	Constructor
WebSocketFrame(JsonObject jo)	JSON Object Constructor

Method Summary

Modifier and Type	Method	Description
boolean[]	optionals()	Implementing this method allows sub-classes to specify which JSON Properties may be absent or null.

Methods inherited from class Torello.Java.Additional.BaseType

toJSON, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

🡇 ⇈ ⮫

protected static final long serialVersionUID

For Object Serialization. java.io.Serializable

See Also:

Constant Field Values

opcode

🡅 🡇 ⇈ ⮫

public final java.lang.Number opcode

WebSocket message opcode.

mask

🡅 🡇 ⇈ ⮫

public final boolean mask

WebSocket message mask.

payloadData

🡅 🡇 ⇈ ⮫

public final java.lang.String payloadData

WebSocket message payload data. If the opcode is 1, this is a text message and payloadData is a UTF-8 string. If the opcode isn't 1, then payloadData is a base64 encoded string representing binary data.

Constructor Detail

WebSocketFrame

🡅 🡇 ⇈ ⮫

public WebSocketFrame(java.lang.Number opcode,
                      boolean mask,
                      java.lang.String payloadData)

Constructor

Parameters:

opcode - WebSocket message opcode.

mask - WebSocket message mask.

payloadData - WebSocket message payload data. If the opcode is 1, this is a text message and payloadData is a UTF-8 string. If the opcode isn't 1, then payloadData is a base64 encoded string representing binary data.

WebSocketFrame

🡅 🡇 ⇈ ⮫

public WebSocketFrame(JsonObject jo)

JSON Object Constructor

Parameters:

jo - A Json-Object having data about an instance of 'WebSocketFrame'.

Method Detail

optionals

🡅 ⇈ ⮫

public boolean[] optionals()

Description copied from class: BaseType

Implementing this method allows sub-classes to specify which JSON Properties may be absent or null. When binding a JsonObject to a Java-Object, if some of the expected fields for the Java-Object map to Properties which might be left-out or omitted, then that may be indicated by setting that fields array position TRUE.

NOTE: This array should have a length equal to the number of fields contained by the Java Object. The first boolean in the array should specify whether the first Object Field may by absent. The second boolean should specify whether the second Object Field is optional in the JSON - and so on and so forth...

Specified by:

optionals in class BaseType

Returns:

A boolean[] array whose length is precisely equal to the number of fields in the Java Object.