org.wso2.transport.http.netty.contract.websocket

Interface WebSocketBinaryMessage

All Superinterfaces:

WebSocketMessage

All Known Subinterfaces:

WebSocketControlMessage

All Known Implementing Classes:

DefaultWebSocketBinaryMessage, DefaultWebSocketControlMessage

public interface WebSocketBinaryMessage
extends WebSocketMessage

This message contains the details of WebSocket binary message.

Method Summary

Modifier and Type	Method and Description
byte[]	getByteArray() Get the binary data as a byte array.
ByteBuffer	getByteBuffer() Get the binary data as a byteBuffer.
boolean	isFinalFragment() Check whether the message is a final fragment.

Methods inherited from interface org.wso2.transport.http.netty.contract.websocket.WebSocketMessage

getTarget, getWebSocketConnection, isServerMessage

Method Detail

getByteBuffer

ByteBuffer getByteBuffer()

Get the binary data as a byteBuffer.

Returns:

binary data as a ByteBuffer.

getByteArray

byte[] getByteArray()

Get the binary data as a byte array.

Returns:

the binary data as a byte array.

isFinalFragment

boolean isFinalFragment()

Check whether the message is a final fragment.
This is true if the user receives single messages and not a fragments of a message. So if the user is pretty sure that the messages receiving are single messages user does not have to use this method.

Returns:

true if the received binary data is a final fragment.