Package Torello.Browser.BrowserAPI

Class Network.WebSocketFrame

java.lang.Object

Torello.Browser.BaseType<Network.WebSocketFrame>

Torello.Browser.BrowserAPI.Network.WebSocketFrame

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BaseType<?>>

Enclosing class:

Network

public static class Network.WebSocketFrame
extends BaseType<Network.WebSocketFrame>
implements java.io.Serializable

This Nested Java Class is declared as a "Type", which is similar to a Java Class. The CDP API Specifications list this type among the types, events & commands located in the Network domain, which may be found within the BrowserAPI.

📌 All browser domain type classes will have a class name that begins with an upper case letter.

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

See Also:

Serialized Form

Hi-Lited Source-Code:

This File's Source Code:

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

File Size: 2,174 Bytes Line Count: 53 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc

• View Here: Network$$WebSocketFrame$$.java
• Open New Browser-Tab: Network$$WebSocketFrame$$.java

File Size: 8,239 Bytes Line Count: 202 '\n' Characters Found

Field Summary

Serializable ID
Modifier and Type	Field	Description
protected static long	serialVersionUID
Type Fields / Properties (from Google & Browser Specs)
Modifier and Type	Field	Description
boolean	mask	WebSocket message mask.
Number	opcode	WebSocket message opcode.
String	payloadData	WebSocket message payload data.

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
WebSocketFrame(ReadOnlyList<Boolean> isPresent, Number opcode, boolean mask, String payloadData)	Constructor.

Method Summary

Static Builder Convert a JsonObject to a POJO
Modifier and Type	Method	Description
static Network.WebSocketFrame	fromJSON(JsonObject jo)	Creates an instance of this class from a JsonObject.
Retrieve the Type-Descriptor Singleton-Instance for this Nested Class.
Modifier and Type	Method	Description
static NestedDescriptor<Network.WebSocketFrame>	descriptor()	Returns this class's NestedDescriptor singleton-instance.

Methods inherited from class Torello.Browser.BaseType

allEnumStrROLs, compareTo, enumStrList, enumStrValidate, enumStrValidateThrow, equals, hashCode, isPresent, optionalsValidate, optionalsValidateThrow, toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

🡇 ⇈ ⮫ 🗕 🗗 🗖

protected static final long serialVersionUID

This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.

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(ReadOnlyList<java.lang.Boolean> isPresent,
                      java.lang.Number opcode,
                      boolean mask,
                      java.lang.String payloadData)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Network.WebSocketFrame fromJSON(JsonObject jo)

Creates an instance of this class from a JsonObject.

Code:

Exact Method Body:

 return singleton.fromJSON(jo);

descriptor

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static NestedDescriptor<Network.WebSocketFrame> descriptor()

Returns this class's NestedDescriptor singleton-instance. class / type.

Code:

Exact Method Body:

 return singleton.descriptor();