org.adroitlogic.ultraesb.api.format

Interface WebSocketMessage

public interface WebSocketMessage

A message payload format which is used to handle WebSocket communication

Author:

Sajith Dilshan

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WebSocketMessage.Opcode WebSocketMessage must contain one of the below opcode.

Method Summary

Methods

Modifier and Type	Method and Description
ByteBuffer	getHeader() The header is used to construct a Web Socket frame when the payload of the message is being transmitted to a Web Socket Client.
int	getHeaderSize()
ByteBuffer	getMaskedKeyBuffer()
WebSocketMessage.Opcode	getOpcode()
ByteBuffer	getPayloadAsByteBuffer()
int	getPayloadSize()
boolean	isFin()
void	setFin(boolean fin) Mark whether the complete payload of the message is present
void	setHeader(ByteBuffer header)
void	setMaskedKeyBuffer(ByteBuffer maskedKeyBuffer) Set the mask key of the messages received from WebSocketPeers
void	setOpcode(WebSocketMessage.Opcode opcode)
void	setPayloadSize(int payloadSize) Set the actual number of bytes present in the ByteBuffer which contains the unmasked payload data

Method Detail

getPayloadAsByteBuffer

ByteBuffer getPayloadAsByteBuffer()

Returns:

the ByteBuffer which contains the unmasked payload of the message

getOpcode

WebSocketMessage.Opcode getOpcode()

Returns:

the WebSocketMessage.Opcode of the message

getHeader

ByteBuffer getHeader()

The header is used to construct a Web Socket frame when the payload of the message is being transmitted to a Web Socket Client. The structure of the of the header must includes all the field defined in https://tools.ietf.org/html/rfc6455#section-5.2 except for the masking key and payload data. Masking key is not used when a Web Socket frame is being transmitted to a client from the server.

Returns:

a ByteBuffer that has the header field which corresponds to the unmasked payload of this message.

NOTE: This method will return null if it is invoked prior to the invocation of setHeader(ByteBuffer)

getHeaderSize

int getHeaderSize()

Returns:

-1 if this method is invoked prior to the invocation of setHeader(ByteBuffer) method. Otherwise it will return the actual number of bytes in the ByteBuffer which contains the header.

getPayloadSize

int getPayloadSize()

Returns:

the actual number of bytes in the ByteBuffer which contains the unmasked payload data

setPayloadSize

void setPayloadSize(int payloadSize)

Set the actual number of bytes present in the ByteBuffer which contains the unmasked payload data

Parameters:

payloadSize - number of bytes in the payload

setOpcode

void setOpcode(WebSocketMessage.Opcode opcode)

Parameters:

opcode - OpCode of this message

setHeader

void setHeader(ByteBuffer header)

Parameters:

header - ByteBuffer which contains the header fields, which corresponds to the unmasked payload in this message

See Also:

getHeader()

isFin

boolean isFin()

Returns:

True if the complete payload of the message is present and returns False if the payload of the message is incomplete

setFin

void setFin(boolean fin)

Mark whether the complete payload of the message is present

Parameters:

fin - true if the payload is complete and false otherwise

setMaskedKeyBuffer

void setMaskedKeyBuffer(ByteBuffer maskedKeyBuffer)

Set the mask key of the messages received from WebSocketPeers

Parameters:

maskedKeyBuffer - ByteBuffer which contains the masked key

getMaskedKeyBuffer

ByteBuffer getMaskedKeyBuffer()

Returns:

the ByteBuffer which contains the mask key of the message which was received from a WebSocketPeer ONLY when isFin() is false, otherwise(when isFin() returns true) this method will return null