uk.co.real_logic.sbe.codec.java

Class DirectBuffer

java.lang.Object

uk.co.real_logic.sbe.codec.java.DirectBuffer

public class DirectBuffer
extends Object

Direct buffer which can wrap a byte[] or a ByteBuffer that is heap or direct allocated for direct access with native types.

Constructor Summary

Constructors

Constructor and Description
DirectBuffer(byte[] buffer) Attach a view to a byte[] for providing direct access.
DirectBuffer(ByteBuffer buffer) Attach a view to a ByteBuffer for providing direct access, the ByteBuffer can be heap based or direct.
DirectBuffer(long address, int capacity) Attach a view to an off-heap memory region by address.

Method Summary

Modifier and Type	Method and Description
byte[]	array() Return the underlying byte[] for this buffer or null if none is attached.
ByteBuffer	byteBuffer() Return the underlying ByteBuffer if one is attached.
int	capacity() Get the capacity of the underlying buffer.
void	checkLimit(int limit) Check that a given limit is not greater than the capacity of a buffer from a given offset.
ByteBuffer	duplicateByteBuffer() Create a duplicate ByteBuffer for the view in native byte order.
byte	getByte(int index) Get the value at a given index.
int	getBytes(int index, byte[] dst) Get from the underlying buffer into a supplied byte array.
int	getBytes(int index, byte[] dst, int offset, int length) Get bytes from the underlying buffer into a supplied byte array.
int	getBytes(int index, ByteBuffer dstBuffer, int length) Get from the underlying buffer into a supplied ByteBuffer.
int	getBytes(int index, DirectBuffer dst, int offset, int length) Get bytes from the underlying buffer into a supplied DirectBuffer
double	getDouble(int index, ByteOrder byteOrder) Get the value at a given index.
float	getFloat(int index, ByteOrder byteOrder) Get the value at a given index.
int	getInt(int index, ByteOrder byteOrder) Get the value at a given index.
long	getLong(int index, ByteOrder byteOrder) Get the value at a given index.
short	getShort(int index, ByteOrder byteOrder) Get the value at a given index.
void	putByte(int index, byte value) Put a value to a given index.
int	putBytes(int index, byte[] src) Put an array of src into the underlying buffer.
int	putBytes(int index, byte[] src, int offset, int length) Put an array into the underlying buffer.
int	putBytes(int index, ByteBuffer srcBuffer, int length) Put an bytes into the underlying buffer for the view.
int	putBytes(int index, DirectBuffer src, int offset, int length) Put bytes from a DirectBuffer into the underlying buffer.
void	putDouble(int index, double value, ByteOrder byteOrder) Put a value to a given index.
void	putFloat(int index, float value, ByteOrder byteOrder) Put a value to a given index.
void	putInt(int index, int value, ByteOrder byteOrder) Put a value to a given index.
void	putLong(int index, long value, ByteOrder byteOrder) Put a value to a given index.
void	putShort(int index, short value, ByteOrder byteOrder) Put a value to a given index.
void	wrap(byte[] buffer) Attach a view to a byte[] for providing direct access.
void	wrap(ByteBuffer buffer) Attach a view to a ByteBuffer for providing direct access, the ByteBuffer can be heap based or direct.
void	wrap(long address, int capacity) Attach a view to an off-heap memory region by address.

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectBuffer

public DirectBuffer(byte[] buffer)

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

Parameters:

buffer - to which the view is attached.

DirectBuffer

public DirectBuffer(ByteBuffer buffer)

Attach a view to a ByteBuffer for providing direct access, the ByteBuffer can be heap based or direct.

Parameters:

buffer - to which the view is attached.

DirectBuffer

public DirectBuffer(long address,
                    int capacity)

Attach a view to an off-heap memory region by address. This constructor is not available under Android.

Parameters:

address - where the memory begins off-heap

capacity - of the buffer from the given address

Method Detail

wrap

public void wrap(byte[] buffer)

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

Parameters:

buffer - to which the view is attached.

wrap

public void wrap(ByteBuffer buffer)

Attach a view to a ByteBuffer for providing direct access, the ByteBuffer can be heap based or direct.

Parameters:

buffer - to which the view is attached.

wrap

public void wrap(long address,
                 int capacity)

Attach a view to an off-heap memory region by address. This method is not available under Android.

Parameters:

address - where the memory begins off-heap

capacity - of the buffer from the given address

array

public byte[] array()

Return the underlying byte[] for this buffer or null if none is attached.

Returns:

the underlying byte[] for this buffer.

byteBuffer

public ByteBuffer byteBuffer()

Return the underlying ByteBuffer if one is attached.

Returns:

the underlying ByteBuffer if one is attached.

capacity

public int capacity()

Get the capacity of the underlying buffer.

Returns:

the capacity of the underlying buffer in bytes.

checkLimit

public void checkLimit(int limit)

Check that a given limit is not greater than the capacity of a buffer from a given offset. Can be overridden in a DirectBuffer subclass to enable an extensible buffer or handle retry after a flush.

Parameters:

limit - access is required to.

Throws:

IndexOutOfBoundsException - if limit is beyond buffer capacity.

duplicateByteBuffer

public ByteBuffer duplicateByteBuffer()

Create a duplicate ByteBuffer for the view in native byte order. The duplicate ByteBuffer shares the underlying memory so all changes are reflected. If no ByteBuffer is attached then one will be created.

Returns:

a duplicate of the underlying ByteBuffer

getLong

public long getLong(int index,
                    ByteOrder byteOrder)

Get the value at a given index.

Parameters:

index - in bytes from which to get.

byteOrder - of the value to be read.

Returns:

the value for at a given index

putLong

public void putLong(int index,
                    long value,
                    ByteOrder byteOrder)

Put a value to a given index.

Parameters:

index - in bytes for where to put.

value - for at a given index

byteOrder - of the value when written

getInt

public int getInt(int index,
                  ByteOrder byteOrder)

Get the value at a given index.

Parameters:

index - in bytes from which to get.

byteOrder - of the value to be read.

Returns:

the value at a given index.

putInt

public void putInt(int index,
                   int value,
                   ByteOrder byteOrder)

Put a value to a given index.

Parameters:

index - in bytes for where to put.

value - to be written

byteOrder - of the value when written

getDouble

public double getDouble(int index,
                        ByteOrder byteOrder)

Get the value at a given index.

Parameters:

index - in bytes from which to get.

byteOrder - of the value to be read.

Returns:

the value at a given index.

putDouble

public void putDouble(int index,
                      double value,
                      ByteOrder byteOrder)

Put a value to a given index.

Parameters:

index - in bytes for where to put.

value - to be written

byteOrder - of the value when written.

getFloat

public float getFloat(int index,
                      ByteOrder byteOrder)

Get the value at a given index.

Parameters:

index - in bytes from which to get.

byteOrder - of the value to be read.

Returns:

the value at a given index.

putFloat

public void putFloat(int index,
                     float value,
                     ByteOrder byteOrder)

Put a value to a given index.

Parameters:

index - in bytes for where to put.

value - to be written

byteOrder - of the value when written.

getShort

public short getShort(int index,
                      ByteOrder byteOrder)

Get the value at a given index.

Parameters:

index - in bytes from which to get.

byteOrder - of the value to be read.

Returns:

the value at a given index.

putShort

public void putShort(int index,
                     short value,
                     ByteOrder byteOrder)

Put a value to a given index.

Parameters:

index - in bytes for where to put.

value - to be written

byteOrder - of the value when written.

getByte

public 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.

putByte

public void putByte(int index,
                    byte value)

Put a value to a given index.

Parameters:

index - in bytes for where to put.

value - to be written

getBytes

public int 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.

Returns:

count of bytes copied.

getBytes

public int 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.

Returns:

count of bytes copied.

getBytes

public int getBytes(int index,
                    DirectBuffer dst,
                    int offset,
                    int length)

Get bytes from the underlying buffer into a supplied DirectBuffer

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.

Returns:

count of bytes copied.

getBytes

public int getBytes(int index,
                    ByteBuffer dstBuffer,
                    int length)

Get from the underlying buffer into a supplied ByteBuffer.

Parameters:

index - in the underlying buffer to start from.

dstBuffer - into which the bytes will be copied.

length - of the supplied buffer to use.

Returns:

count of bytes copied.

putBytes

public int putBytes(int index,
                    byte[] src)

Put an array of src into the underlying buffer.

Parameters:

index - in the underlying buffer to start from.

src - to be copied to the underlying buffer.

Returns:

count of bytes copied.

putBytes

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

Put an array into the underlying buffer.

Parameters:

index - in the underlying buffer to start from.

src - to be copied to the underlying buffer.

offset - in the supplied buffer to begin the copy.

length - of the supplied buffer to copy.

Returns:

count of bytes copied.

putBytes

public int putBytes(int index,
                    DirectBuffer src,
                    int offset,
                    int length)

Put bytes from a DirectBuffer into the underlying buffer.

Parameters:

index - in the underlying buffer to start from.

src - to be copied to the underlying buffer.

offset - in the supplied buffer to begin the copy.

length - of the supplied buffer to copy.

Returns:

count of bytes copied.

putBytes

public int putBytes(int index,
                    ByteBuffer srcBuffer,
                    int length)

Put an bytes into the underlying buffer for the view. Bytes will be copied from current Buffer.position() to Buffer.limit().

Parameters:

index - in the underlying buffer to start from.

srcBuffer - to copy the bytes from.

length - of the source buffer in bytes to copy

Returns:

count of bytes copied.