io.nats.client.support

Class WebsocketFrameHeader

java.lang.Object

io.nats.client.support.WebsocketFrameHeader

public class WebsocketFrameHeader
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebsocketFrameHeader.OpCode

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_FRAME_HEADER_SIZE

Constructor Summary

Constructors

Constructor and Description
WebsocketFrameHeader()

Method Summary

Modifier and Type	Method and Description
int	filterPayload(byte[] buffer, int offset, int length) Decrement the payloadLength by at most maxSize such that payloadLength is non-negative, returning the amount decremented.
int	getMaskingKey()
WebsocketFrameHeader.OpCode	getOpCode()
long	getPayloadLength()
boolean	isFinal()
boolean	isMasked()
boolean	isPayloadEmpty()
int	read(byte[] buffer, int offset, int length) Serializes this WebsocketFrameHeader into a buffer.
int	size()
static int	size(byte[] buffer, int offset) Introspects the first 2 bytes of buffer at the specified offset to determine how large the entire header is.
WebsocketFrameHeader	withMask(int maskingKey)
WebsocketFrameHeader	withNoMask()
WebsocketFrameHeader	withOp(WebsocketFrameHeader.OpCode op, boolean isFinal)
WebsocketFrameHeader	withPayloadLength(long payloadLength)
int	write(byte[] buffer, int offset, int length) Overwrite internal frame header content with input buffer.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_FRAME_HEADER_SIZE

public static int MAX_FRAME_HEADER_SIZE

Constructor Detail

WebsocketFrameHeader

public WebsocketFrameHeader()

Method Detail

withOp

public WebsocketFrameHeader withOp(WebsocketFrameHeader.OpCode op,
                                   boolean isFinal)

withNoMask

public WebsocketFrameHeader withNoMask()

withMask

public WebsocketFrameHeader withMask(int maskingKey)

withPayloadLength

public WebsocketFrameHeader withPayloadLength(long payloadLength)

isFinal

public boolean isFinal()

isMasked

public boolean isMasked()

getMaskingKey

public int getMaskingKey()

getPayloadLength

public long getPayloadLength()

getOpCode

public WebsocketFrameHeader.OpCode getOpCode()

isPayloadEmpty

public boolean isPayloadEmpty()

filterPayload

public int filterPayload(byte[] buffer,
                         int offset,
                         int length)

Decrement the payloadLength by at most maxSize such that payloadLength is non-negative, returning the amount decremented.

Parameters:

buffer - is the buffer to filter.

offset - is the start offset within buffer to filter.

length - is the number of bytes to filter.

Returns:

min(payloadLength, maxSize), decrementing the internal payloadLength by this amount.

size

public int size()

size

public static int size(byte[] buffer,
                       int offset)

Introspects the first 2 bytes of buffer at the specified offset to determine how large the entire header is.

Parameters:

buffer - is the buffer to introspect

offset - is the offset within the buffer where the websocket header begins.

Returns:

the number of bytes used by the full websocket header.

read

public int read(byte[] buffer,
                int offset,
                int length)

Serializes this WebsocketFrameHeader into a buffer.

Parameters:

buffer - where the serialized header will be placed.

offset - is the start offset into the buffer.

length - is the max bytes that can be placed in the buffer.

Returns:

0 if there is insufficient remainder in the buffer, otherwise returns the number of bytes placed into the buffer.

write

public int write(byte[] buffer,
                 int offset,
                 int length)

Overwrite internal frame header content with input buffer.

 WebsocketFrameHeader header = new WebsocketFrameHeader();
 int consumedLength = header.write(buffer, offset, length);
 offset += consumedLength;
 length -= consumedLength;
 

Parameters:

buffer - containing the serialized header.

offset - is the start offset into the buffer.

length - is the max bytes to consume.

Returns:

0 if there is insufficient remainder in the buffer, otherwise returns the number of bytes consumed from the buffer.