com.neovisionaries.ws.client

Class WebSocketFrame

java.lang.Object

com.neovisionaries.ws.client.WebSocketFrame

public class WebSocketFrame
extends Object

WebSocket frame.

See Also:

href="https://tools.ietf.org/html/rfc6455#section-5" >RFC 6455, 5. Data Framing</a>

Constructor Summary

Constructors

Constructor and Description
WebSocketFrame()

Method Summary

Modifier and Type	Method and Description
static WebSocketFrame	createBinaryFrame(byte[] payload) Create a binary frame.
static WebSocketFrame	createCloseFrame() Create a close frame.
static WebSocketFrame	createCloseFrame(int closeCode) Create a close frame.
static WebSocketFrame	createCloseFrame(int closeCode, String reason) Create a close frame.
static WebSocketFrame	createContinuationFrame() Create a continuation frame.
static WebSocketFrame	createContinuationFrame(byte[] payload) Create a continuation frame.
static WebSocketFrame	createContinuationFrame(String payload) Create a continuation frame.
static WebSocketFrame	createPingFrame() Create a ping frame.
static WebSocketFrame	createPingFrame(byte[] payload) Create a ping frame.
static WebSocketFrame	createPingFrame(String payload) Create a ping frame.
static WebSocketFrame	createPongFrame() Create a pong frame.
static WebSocketFrame	createPongFrame(byte[] payload) Create a pong frame.
static WebSocketFrame	createPongFrame(String payload) Create a pong frame.
static WebSocketFrame	createTextFrame(String payload) Create a text frame.
int	getCloseCode() Parse the first two bytes of the payload as a close code.
String	getCloseReason() Parse the third and subsequent bytes of the payload as a close reason.
boolean	getFin() Get the value of FIN bit.
int	getOpcode() Get the opcode.
byte[]	getPayload() Get the unmasked payload.
int	getPayloadLength() Get the payload length.
String	getPayloadText() Get the unmasked payload as a text.
boolean	getRsv1() Get the value of RSV1 bit.
boolean	getRsv2() Get the value of RSV2 bit.
boolean	getRsv3() Get the value of RSV3 bit.
boolean	hasPayload() Check if this frame has payload.
boolean	isBinaryFrame() Check if this frame is a binary frame.
boolean	isCloseFrame() Check if this frame is a close frame.
boolean	isContinuationFrame() Check if this frame is a continuation frame.
boolean	isControlFrame() Check if this frame is a control frame.
boolean	isDataFrame() Check if this frame is a data frame.
boolean	isPingFrame() Check if this frame is a ping frame.
boolean	isPongFrame() Check if this frame is a pong frame.
boolean	isTextFrame() Check if this frame is a text frame.
WebSocketFrame	setCloseFramePayload(int closeCode, String reason) Set the payload that conforms to the payload format of close frames.
WebSocketFrame	setFin(boolean fin) Set the value of FIN bit.
WebSocketFrame	setOpcode(int opcode) Set the opcode
WebSocketFrame	setPayload(byte[] payload) Set the unmasked payload.
WebSocketFrame	setPayload(String payload) Set the payload.
WebSocketFrame	setRsv1(boolean rsv1) Set the value of RSV1 bit.
WebSocketFrame	setRsv2(boolean rsv2) Set the value of RSV2 bit.
WebSocketFrame	setRsv3(boolean rsv3) Set the value of RSV3 bit.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketFrame

public WebSocketFrame()

Method Detail

getFin

public boolean getFin()

Get the value of FIN bit.

Returns:

The value of FIN bit.

setFin

public WebSocketFrame setFin(boolean fin)

Set the value of FIN bit.

Parameters:

fin - The value of FIN bit.

Returns:

this object.

getRsv1

public boolean getRsv1()

Get the value of RSV1 bit.

Returns:

The value of RSV1 bit.

setRsv1

public WebSocketFrame setRsv1(boolean rsv1)

Set the value of RSV1 bit.

Parameters:

rsv1 - The value of RSV1 bit.

Returns:

this object.

getRsv2

public boolean getRsv2()

Get the value of RSV2 bit.

Returns:

The value of RSV2 bit.

setRsv2

public WebSocketFrame setRsv2(boolean rsv2)

Set the value of RSV2 bit.

Parameters:

rsv2 - The value of RSV2 bit.

Returns:

this object.

getRsv3

public boolean getRsv3()

Get the value of RSV3 bit.

Returns:

The value of RSV3 bit.

setRsv3

public WebSocketFrame setRsv3(boolean rsv3)

Set the value of RSV3 bit.

Parameters:

rsv3 - The value of RSV3 bit.

Returns:

this object.

getOpcode

public int getOpcode()

Get the opcode.

<table border="1" cellpadding="5" style="table-collapse: collapse;"> <caption>WebSocket opcode</caption> <thead> <tr> <th>Value</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>0x0</td> <td>Frame continuation</td> </tr> <tr> <td>0x1</td> <td>Text frame</td> </tr> <tr> <td>0x2</td> <td>Binary frame</td> </tr> <tr> <td>0x3-0x7</td> <td>Reserved</td> </tr> <tr> <td>0x8</td> <td>Connection close</td> </tr> <tr> <td>0x9</td> <td>Ping</td> </tr> <tr> <td>0xA</td> <td>Pong</td> </tr> <tr> <td>0xB-0xF</td> <td>Reserved</td> </tr> </tbody> </table>

Returns:

The opcode.

See Also:

WebSocketOpcode

setOpcode

public WebSocketFrame setOpcode(int opcode)

Set the opcode

Parameters:

opcode - The opcode.

Returns:

this object.

See Also:

WebSocketOpcode

isContinuationFrame

public boolean isContinuationFrame()

Check if this frame is a continuation frame.

<p> This method returns true when the value of the opcode is 0x0 (WebSocketOpcode.CONTINUATION). </p>

Returns:

true if this frame is a continuation frame (= if the opcode is 0x0).

isTextFrame

public boolean isTextFrame()

Check if this frame is a text frame.

<p> This method returns true when the value of the opcode is 0x1 (WebSocketOpcode.TEXT). </p>

Returns:

true if this frame is a text frame (= if the opcode is 0x1).

isBinaryFrame

public boolean isBinaryFrame()

Check if this frame is a binary frame.

<p> This method returns true when the value of the opcode is 0x2 (WebSocketOpcode.BINARY). </p>

Returns:

true if this frame is a binary frame (= if the opcode is 0x2).

isCloseFrame

public boolean isCloseFrame()

Check if this frame is a close frame.

<p> This method returns true when the value of the opcode is 0x8 (WebSocketOpcode.CLOSE). </p>

Returns:

true if this frame is a close frame (= if the opcode is 0x8).

isPingFrame

public boolean isPingFrame()

Check if this frame is a ping frame.

<p> This method returns true when the value of the opcode is 0x9 (WebSocketOpcode.PING). </p>

Returns:

true if this frame is a ping frame (= if the opcode is 0x9).

isPongFrame

public boolean isPongFrame()

Check if this frame is a pong frame.

<p> This method returns true when the value of the opcode is 0xA (WebSocketOpcode.PONG). </p>

Returns:

true if this frame is a pong frame (= if the opcode is 0xA).

isDataFrame

public boolean isDataFrame()

Check if this frame is a data frame.

<p> This method returns true when the value of the opcode is in between 0x1 and 0x7. </p>

Returns:

true if this frame is a data frame (= if the opcode is in between 0x1 and 0x7).

isControlFrame

public boolean isControlFrame()

Check if this frame is a control frame.

<p> This method returns true when the value of the opcode is in between 0x8 and 0xF. </p>

Returns:

true if this frame is a control frame (= if the opcode is in between 0x8 and 0xF).

hasPayload

public boolean hasPayload()

Check if this frame has payload.

Returns:

true if this frame has payload.

getPayloadLength

public int getPayloadLength()

Get the payload length.

Returns:

The payload length.

getPayload

public byte[] getPayload()

Get the unmasked payload.

Returns:

The unmasked payload. null may be returned.

getPayloadText

public String getPayloadText()

Get the unmasked payload as a text.

Returns:

A string constructed by interrupting the payload as a UTF-8 bytes.

setPayload

public WebSocketFrame setPayload(byte[] payload)

Set the unmasked payload.

<p> Note that the payload length of a <a href="http://tools.ietf.org/html/rfc6455#section-5.5" >control frame</a> must be 125 bytes or less. </p>

Parameters:

payload - The unmasked payload. null is accepted. An empty byte array is treated in the same way as null.

Returns:

this object.

setPayload

public WebSocketFrame setPayload(String payload)

Set the payload. The given string is converted to a byte array in UTF-8 encoding.

<p> Note that the payload length of a <a href="http://tools.ietf.org/html/rfc6455#section-5.5" >control frame</a> must be 125 bytes or less. </p>

Parameters:

payload - The unmasked payload. null is accepted. An empty string is treated in the same way as null.

Returns:

this object.

setCloseFramePayload

public WebSocketFrame setCloseFramePayload(int closeCode,
                                           String reason)

Set the payload that conforms to the payload format of close frames.

<p> The given parameters are encoded based on the rules described in "<a href="http://tools.ietf.org/html/rfc6455#section-5.5.1" >5.5.1. Close</a>" of RFC 6455. </p>

<p> Note that the reason should not be too long because the payload length of a <a href="http://tools.ietf.org/html/rfc6455#section-5.5" >control frame</a> must be 125 bytes or less. </p>

Parameters:

closeCode - The close code.

reason - The reason. null is accepted. An empty string is treated in the same way as null.

Returns:

this object.

See Also:

href="http://tools.ietf.org/html/rfc6455#section-5.5.1" >RFC 6455, 5.5.1. Close</a>, WebSocketCloseCode

getCloseCode

public int getCloseCode()

Parse the first two bytes of the payload as a close code.

<p> If any payload is not set or the length of the payload is less than 2, this method returns 1005 (WebSocketCloseCode.NONE). </p>

<p> The value returned from this method is meaningless if this frame is not a close frame. </p>

Returns:

The close code.

See Also:

href="http://tools.ietf.org/html/rfc6455#section-5.5.1" >RFC 6455, 5.5.1. Close</a>, WebSocketCloseCode

getCloseReason

public String getCloseReason()

Parse the third and subsequent bytes of the payload as a close reason.

<p> If any payload is not set or the length of the payload is less than 3, this method returns null. </p>

<p> The value returned from this method is meaningless if this frame is not a close frame. </p>

Returns:

The close reason.

toString

public String toString()

Overrides:

toString in class Object

createContinuationFrame

public static WebSocketFrame createContinuationFrame()

Create a continuation frame. Note that the FIN bit of the returned frame is false.

Returns:

A WebSocket frame whose FIN bit is false, opcode is CONTINUATION and payload is null.

createContinuationFrame

public static WebSocketFrame createContinuationFrame(byte[] payload)

Create a continuation frame. Note that the FIN bit of the returned frame is false.

Parameters:

payload - The payload for a newly create frame.

Returns:

A WebSocket frame whose FIN bit is false, opcode is CONTINUATION and payload is the given one.

createContinuationFrame

public static WebSocketFrame createContinuationFrame(String payload)

Create a continuation frame. Note that the FIN bit of the returned frame is false.

Parameters:

payload - The payload for a newly create frame.

Returns:

A WebSocket frame whose FIN bit is false, opcode is CONTINUATION and payload is the given one.

createTextFrame

public static WebSocketFrame createTextFrame(String payload)

Create a text frame.

Parameters:

payload - The payload for a newly created frame.

Returns:

A WebSocket frame whose FIN bit is true, opcode is TEXT and payload is the given one.

createBinaryFrame

public static WebSocketFrame createBinaryFrame(byte[] payload)

Create a binary frame.

Parameters:

payload - The payload for a newly created frame.

Returns:

A WebSocket frame whose FIN bit is true, opcode is BINARY and payload is the given one.

createCloseFrame

public static WebSocketFrame createCloseFrame()

Create a close frame.

Returns:

A WebSocket frame whose FIN bit is true, opcode is CLOSE and payload is null.

createCloseFrame

public static WebSocketFrame createCloseFrame(int closeCode)

Create a close frame.

Parameters:

closeCode - The close code.

Returns:

A WebSocket frame whose FIN bit is true, opcode is CLOSE and payload contains a close code.

See Also:

WebSocketCloseCode

createCloseFrame

public static WebSocketFrame createCloseFrame(int closeCode,
                                              String reason)

Create a close frame.

Parameters:

closeCode - The close code.

reason - The close reason. Note that a control frame’s payload length must be 125 bytes or less (RFC 6455, <a href="https://tools.ietf.org/html/rfc6455#section-5.5" >5.5. Control Frames</a>).

Returns:

A WebSocket frame whose FIN bit is true, opcode is CLOSE and payload contains a close code and a close reason.

See Also:

WebSocketCloseCode

createPingFrame

public static WebSocketFrame createPingFrame()

Create a ping frame.

Returns:

A WebSocket frame whose FIN bit is true, opcode is PING and payload is null.

createPingFrame

public static WebSocketFrame createPingFrame(byte[] payload)

Create a ping frame.

Parameters:

payload - The payload for a newly created frame. Note that a control frame’s payload length must be 125 bytes or less (RFC 6455, <a href="https://tools.ietf.org/html/rfc6455#section-5.5" >5.5. Control Frames</a>).

Returns:

A WebSocket frame whose FIN bit is true, opcode is PING and payload is the given one.

createPingFrame

public static WebSocketFrame createPingFrame(String payload)

Create a ping frame.

Parameters:

payload - The payload for a newly created frame. Note that a control frame’s payload length must be 125 bytes or less (RFC 6455, <a href="https://tools.ietf.org/html/rfc6455#section-5.5" >5.5. Control Frames</a>).

Returns:

A WebSocket frame whose FIN bit is true, opcode is PING and payload is the given one.

createPongFrame

public static WebSocketFrame createPongFrame()

Create a pong frame.

Returns:

A WebSocket frame whose FIN bit is true, opcode is PONG and payload is null.

createPongFrame

public static WebSocketFrame createPongFrame(byte[] payload)

Create a pong frame.

Parameters:

payload - The payload for a newly created frame. Note that a control frame’s payload length must be 125 bytes or less (RFC 6455, <a href="https://tools.ietf.org/html/rfc6455#section-5.5" >5.5. Control Frames</a>).

Returns:

A WebSocket frame whose FIN bit is true, opcode is PONG and payload is the given one.

createPongFrame

public static WebSocketFrame createPongFrame(String payload)

Create a pong frame.

Parameters:

payload - The payload for a newly created frame. Note that a control frame’s payload length must be 125 bytes or less (RFC 6455, <a href="https://tools.ietf.org/html/rfc6455#section-5.5" >5.5. Control Frames</a>).

Returns:

A WebSocket frame whose FIN bit is true, opcode is PONG and payload is the given one.