com.hazelcast.client.impl.protocol.util

Interface ClientProtocolBuffer

All Known Implementing Classes:

SafeBuffer, UnsafeBuffer

public interface ClientProtocolBuffer

Interface for buffer to be used in client protocol. Implemented by SafeBuffer and UnsafeBuffer

Method Summary

Modifier and Type	Method and Description
byte[]	byteArray() Get the underlying byte[] if one exists.
int	capacity() Get the capacity of the underlying buffer.
byte	getByte(int index) Get the value at a given index.
void	getBytes(int index, byte[] dst) Get from the underlying buffer into a supplied byte array.
void	getBytes(int index, byte[] dst, int offset, int length) Get bytes from the underlying buffer into a supplied byte array.
int	getInt(int index) Get the value at a given index.
long	getLong(int index) Get the value at a given index.
short	getShort(int index) Get the value at a given index.
String	getStringUtf8(int offset, int length) Get part of String from bytes encoded in UTF-8 format without a length prefix.
void	putByte(int index, byte value) Put a value to a given index.
void	putBytes(int index, byte[] src) Put an array of src into the underlying buffer.
void	putBytes(int index, byte[] src, int offset, int length) Put an array into the underlying buffer.
void	putBytes(int index, ByteBuffer src, int length)
void	putInt(int index, int value) Put a value at a given index.
void	putLong(int index, long value) Put a value at a given index.
void	putShort(int index, short value) Put a value to a given index.
int	putStringUtf8(int index, String value) Encode a String as UTF-8 bytes to the buffer with a length prefix.
int	putStringUtf8(int index, String value, int maxEncodedSize) Encode a String as UTF-8 bytes the buffer with a length prefix with a maximum encoded size check.
void	wrap(byte[] buffer) Attach a view to a byte[] for providing direct access.

Method Detail

wrap

void wrap(byte[] buffer)

Attach a view to a byte[] for providing direct access.

Parameters:

buffer - to which the view is attached.

byteArray

byte[] byteArray()

Get the underlying byte[] if one exists.

Returns:

the underlying byte[] if one exists.

capacity

int capacity()

Get the capacity of the underlying buffer.

Returns:

the capacity of the underlying buffer in bytes.

getLong

long getLong(int index)

Get the value at a given index.

Parameters:

index - in bytes from which to get.

Returns:

the value for at a given index

getInt

int getInt(int index)

Get the value at a given index.

Parameters:

index - in bytes from which to get.

Returns:

the value at a given index.

getShort

short getShort(int index)

Get the value at a given index.

Parameters:

index - in bytes from which to get.

Returns:

the value at a given index.

getByte

byte getByte(int index)

Get the value at a given index.

Parameters:

index - in bytes from which to get.

Returns:

the value at a given index.

getBytes

void getBytes(int index,
              byte[] dst)

Get from the underlying buffer into a supplied byte array. This method will try to fill the supplied byte array.

Parameters:

index - in the underlying buffer to start from.

dst - into which the dst will be copied.

getBytes

void getBytes(int index,
              byte[] dst,
              int offset,
              int length)

Get bytes from the underlying buffer into a supplied byte array.

Parameters:

index - in the underlying buffer to start from.

dst - into which the bytes will be copied.

offset - in the supplied buffer to start the copy

length - of the supplied buffer to use.

getStringUtf8

String getStringUtf8(int offset,
                     int length)

Get part of String from bytes encoded in UTF-8 format without a length prefix.

Parameters:

offset - at which the String begins.

length - of the String in bytes to decode.

Returns:

the String as represented by the UTF-8 encoded bytes.

putLong

void putLong(int index,
             long value)

Put a value at a given index.

Parameters:

index - The index in bytes where the value is put.

value - The value to put at the given index.

putInt

void putInt(int index,
            int value)

Put a value at a given index.

Parameters:

index - The index in bytes where the value is put.

value - The value put at the given index.

putShort

void putShort(int index,
              short value)

Put a value to a given index.

Parameters:

index - The index in bytes where the value is put.

value - The value put at the given index.

putByte

void putByte(int index,
             byte value)

Put a value to a given index.

Parameters:

index - The index in bytes where the value is put.

value - The value put at the given index.

putBytes

void putBytes(int index,
              byte[] src)

Put an array of src into the underlying buffer.

Parameters:

index - The index in the underlying buffer from which to start the array.

src - The array to be copied into the underlying buffer.

putBytes

void putBytes(int index,
              byte[] src,
              int offset,
              int length)

Put an array into the underlying buffer.

Parameters:

index - The index in the underlying buffer from which to start the array.

src - The array to be copied into the underlying buffer.

offset - The offset in the supplied buffer at which to begin the copy.

length - The length of the supplied buffer to copy.

putBytes

void putBytes(int index,
              ByteBuffer src,
              int length)

putStringUtf8

int putStringUtf8(int index,
                  String value)

Encode a String as UTF-8 bytes to the buffer with a length prefix.

Parameters:

index - The index at which the String should be encoded.

value - The value of the String to be encoded.

Returns:

The number of bytes put to the buffer.

putStringUtf8

int putStringUtf8(int index,
                  String value,
                  int maxEncodedSize)

Encode a String as UTF-8 bytes the buffer with a length prefix with a maximum encoded size check.

Parameters:

index - The index at which the String should be encoded.

value - The value of the String to be encoded.

maxEncodedSize - The maximum encoded size to be checked before writing to the buffer.

Returns:

The number of bytes put to the buffer.

Throws:

IllegalArgumentException - if the encoded bytes are greater than maxEncodedSize.