ControlFrame

Undocumented in source.

Constructors

this
this(byte opcode)
Undocumented in source.

Members

Functions

assertValid
void assertValid()
Undocumented in source. Be warned that the author may not have intended to support it.
getPayload
ByteBuffer getPayload()
Undocumented in source. Be warned that the author may not have intended to support it.
isControlFrame
bool isControlFrame()
Undocumented in source. Be warned that the author may not have intended to support it.
isDataFrame
bool isDataFrame()
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(Object obj)
Undocumented in source. Be warned that the author may not have intended to support it.
setPayload
AbstractWebSocketFrame setPayload(ByteBuffer buf)
Undocumented in source. Be warned that the author may not have intended to support it.

Variables

MAX_CONTROL_PAYLOAD
enum int MAX_CONTROL_PAYLOAD;

Maximum size of Control frame, per RFC 6455

Inherited Members

From AbstractWebSocketFrame

finRsvOp
byte finRsvOp;

Combined FIN + RSV1 + RSV2 + RSV3 + OpCode byte. <p> <pre> 1000_0000 (0x80) = fin 0100_0000 (0x40) = rsv1 0010_0000 (0x20) = rsv2 0001_0000 (0x10) = rsv3 0000_1111 (0x0F) = opcode </pre>

masked
bool masked;
Undocumented in source.
mask
byte[] mask;
Undocumented in source.
data
ByteBuffer data;

The payload data. <p> It is assumed to always be in FLUSH mode (ready to read) in this object.

assertValid
void assertValid()
Undocumented in source.
copyHeaders
void copyHeaders(WebSocketFrame frame)
Undocumented in source. Be warned that the author may not have intended to support it.
copyHeaders
void copyHeaders(AbstractWebSocketFrame copy)
Undocumented in source. Be warned that the author may not have intended to support it.
equals
bool equals(Object obj)
Undocumented in source. Be warned that the author may not have intended to support it.
opEquals
bool opEquals(Object obj)
Undocumented in source. Be warned that the author may not have intended to support it.
getMask
byte[] getMask()
Undocumented in source. Be warned that the author may not have intended to support it.
getOpCode
byte getOpCode()
Undocumented in source. Be warned that the author may not have intended to support it.
getPayload
ByteBuffer getPayload()

Get the payload ByteBuffer. possible null.

getPayloadAsUTF8
string getPayloadAsUTF8()
Undocumented in source. Be warned that the author may not have intended to support it.
getPayloadLength
int getPayloadLength()
Undocumented in source. Be warned that the author may not have intended to support it.
getType
WebSocketFrameType getType()
Undocumented in source. Be warned that the author may not have intended to support it.
hashCode
size_t hashCode()
Undocumented in source. Be warned that the author may not have intended to support it.
toHash
size_t toHash()
Undocumented in source. Be warned that the author may not have intended to support it.
hasPayload
bool hasPayload()
Undocumented in source. Be warned that the author may not have intended to support it.
isControlFrame
bool isControlFrame()
Undocumented in source.
isDataFrame
bool isDataFrame()
Undocumented in source.
isFin
bool isFin()
Undocumented in source. Be warned that the author may not have intended to support it.
isMasked
bool isMasked()
Undocumented in source. Be warned that the author may not have intended to support it.
isRsv1
bool isRsv1()
Undocumented in source. Be warned that the author may not have intended to support it.
isRsv2
bool isRsv2()
Undocumented in source. Be warned that the author may not have intended to support it.
isRsv3
bool isRsv3()
Undocumented in source. Be warned that the author may not have intended to support it.
reset
void reset()
Undocumented in source. Be warned that the author may not have intended to support it.
setFin
AbstractWebSocketFrame setFin(bool fin)
Undocumented in source. Be warned that the author may not have intended to support it.
setMask
WebSocketFrame setMask(byte[] maskingKey)
Undocumented in source. Be warned that the author may not have intended to support it.
setMasked
WebSocketFrame setMasked(bool mask)
Undocumented in source. Be warned that the author may not have intended to support it.
setOpCode
AbstractWebSocketFrame setOpCode(byte op)
Undocumented in source. Be warned that the author may not have intended to support it.
setPayload
AbstractWebSocketFrame setPayload(ByteBuffer buf)

Set the data payload. <p> The provided buffer will be used as is, no copying of bytes performed. <p> The provided buffer should be flipped and ready to READ from.

setRsv1
AbstractWebSocketFrame setRsv1(bool rsv1)
Undocumented in source. Be warned that the author may not have intended to support it.
setRsv2
AbstractWebSocketFrame setRsv2(bool rsv2)
Undocumented in source. Be warned that the author may not have intended to support it.
setRsv3
AbstractWebSocketFrame setRsv3(bool rsv3)
Undocumented in source. Be warned that the author may not have intended to support it.
toString
string toString()
Undocumented in source. Be warned that the author may not have intended to support it.

Meta