An implementation of Buffer representing a Java direct buffer. More...

#include <JavaBuffer.h++>

Inheritance diagram for JavaBuffer:

Collaboration diagram for JavaBuffer:

Public Member Functions
	JavaBuffer (JavaVirtualMachine *jvm, size_t size)
	Construct a new JavaBuffer. More...

	~JavaBuffer ()
	Destructor. More...

void	setSize (size_t newSize)

jobject	getJavaObject ()
	Get the JVM object representing the Java direct buffer. More...

virtual void	clear ()
	Clear the buffer. More...

void	flip ()
	Flip the buffer. More...

void	rewind ()
	Rewind the buffer. More...

void	setLimit (uint_t limit)
	Set the limit. More...

void	setPosition (uint_t pos)
	Set the position. More...

uint_t	bump (uint_t delta)
	Bump (advance) the position by the given number of elements, or to the limit, whichever occurs first. More...

uint_t	skip (uint_t delta)
	Advance the position by the given number of elements, or to the limit, whichever occurs first, filling the "skipped" elements with zeroes. More...

bool	put (const T &item)
	Copy an item into the buffer at the current position and bump the position by 1. More...

bool	put (const T *items, uint_t count)
	Copy an array of items into the buffer starting at the current position, and bump the position by the number of items. More...

bool	get (T *item)
	Copy an item from the buffer at the current position and bump the position by 1. More...

bool	get (T *items, uint_t count)
	Copy an array of items from the buffer starting at the current position, and bump the position by the number of items. More...

void	fill (const T &item, uint_t count=0)
	Fill the buffer with a given item. More...

int	peek (const T &item) const
	Scan forward from the current position for an element equal to the given value. More...

T *	getPointer ()
	Get a pointer to the element at the current position. More...

const T *	getPointer () const
	Get a pointer to the next element to be read or written. More...

uint_t	getLimit () const
	Get the limit. More...

uint_t	getRemaining () const
	Get the number of elements available to be read or written. More...

bool	hasRemaining () const
	Test if there are any elements available to be read or written. More...

uint_t	getPosition () const
	Get the position of the next element to be read or written. More...

T &	operator[] (int index)
	Get a reference to the element at the specified index. More...

T	operator[] (int index) const
	Get a copy of the element at the specified index. More...

virtual void	setSize (uint_t newSize)
	Resize the buffer. More...

uint_t	getSize () const
	Get the size of the buffer. More...

T *	getBase ()
	Get a pointer to the base of the buffer. More...

const T *	getBase () const
	Get a pointer to the base of the buffer. More...

Protected Attributes
uint_t	_limit
	The limit. More...

uint_t	_pos
	The position. More...

T *	_data
	A pointer to the raw buffer. More...

uint_t	_size
	The size of the buffer. More...

bool	_owner
	Whether this object owns the raw buffer. More...

Detailed Description

An implementation of Buffer representing a Java direct buffer.

Author: Mark Lindner

Constructor & Destructor Documentation

◆ JavaBuffer()

JavaBuffer	(	JavaVirtualMachine *	jvm,
		size_t	size
	)

Construct a new JavaBuffer.

Parameters

jvm	The JavaVirtualMachine in which the buffer is being created.
size	The size of the buffer, in bytes.

Exceptions

JavaException If the buffer cannot be constructed.

◆ ~JavaBuffer()

~JavaBuffer ( )

Destructor.

Member Function Documentation

◆ bump()

uint_t bump ( uint_t delta )

inherited

Bump (advance) the position by the given number of elements, or to the limit, whichever occurs first.

Parameters

delta The number of elements.

Returns: The new position.

◆ clear()

virtual void clear ( )

virtualinherited

Clear the buffer.

Sets the position to 0 and the limit to the end of the buffer.

Reimplemented from AbstractBuffer< T >.

◆ fill()

void fill	(	const T &	item,
		uint_t	count = `0`
	)

inherited

Fill the buffer with a given item.

Parameters

item	The item to fill with.
count	The number of elements to fill. If 0 or greater than the number of elements before the limit, the buffer is filled up to the limit.

◆ flip()

void flip ( )

inherited

Flip the buffer.

Sets the limit to the current position, and the position to 0.

◆ get() [1/2]

bool get ( T * item )

inherited

Copy an item from the buffer at the current position and bump the position by 1.

Parameters

item The item.

Returns: true if the buffer produced the item, false if there was not enough data available.

◆ get() [2/2]

bool get	(	T *	items,
		uint_t	count
	)

inherited

Copy an array of items from the buffer starting at the current position, and bump the position by the number of items.

Parameters

items	The items to copy into.
count	The number of items.

Returns: true if the buffer produced the items, false if there was not enough data available.

◆ getBase() [1/2]

T* getBase ( )

inlineinherited

Get a pointer to the base of the buffer.

◆ getBase() [2/2]

const T* getBase ( ) const

inlineinherited

Get a pointer to the base of the buffer.

◆ getJavaObject()

jobject getJavaObject ( )

inline

Get the JVM object representing the Java direct buffer.

◆ getLimit()

uint_t getLimit ( ) const

inlineinherited

Get the limit.

◆ getPointer() [1/2]

T* getPointer ( )

inlineinherited

Get a pointer to the element at the current position.

◆ getPointer() [2/2]

const T* getPointer ( ) const

inlineinherited

Get a pointer to the next element to be read or written.

◆ getPosition()

uint_t getPosition ( ) const

inlineinherited

Get the position of the next element to be read or written.

◆ getRemaining()

uint_t getRemaining ( ) const

inlinevirtualinherited

Get the number of elements available to be read or written.

Returns: The number of elements between the position and the limit.

Implements AbstractBuffer< T >.

◆ getSize()

uint_t getSize ( ) const

inlineinherited

Get the size of the buffer.

Returns: The size, in elements.

◆ hasRemaining()

bool hasRemaining ( ) const

inlinevirtualinherited

Test if there are any elements available to be read or written.

Returns: true if there are elements available, false otherwise.

Reimplemented from AbstractBuffer< T >.

◆ operator[]() [1/2]

T& operator[] ( int index )

inherited

Get a reference to the element at the specified index.

Parameters

index The index of the element.

Exceptions

OutOfBoundsException If the index is out of bounds.

◆ operator[]() [2/2]

T operator[] ( int index ) const

inherited

Get a copy of the element at the specified index.

Parameters

index The index of the element.

Exceptions

OutOfBoundsException If the index is out of bounds.

◆ peek()

int peek ( const T & item ) const

inherited

Scan forward from the current position for an element equal to the given value.

Parameters

item	The item to scan for.

Returns: The number of elements between the current position and the matching item, if found; otherwise -1.

◆ put() [1/2]

bool put ( const T & item )

inherited

Copy an item into the buffer at the current position and bump the position by 1.

Parameters

item The item.

Returns: true if the buffer accepted the item, false if there was not enough room.

◆ put() [2/2]

bool put	(	const T *	items,
		uint_t	count
	)

inherited

Copy an array of items into the buffer starting at the current position, and bump the position by the number of items.

Parameters

items	The items to place in the buffer.
count	The number of items.

Returns: true if the buffer accepted the items, false if there was not enough room.

◆ rewind()

void rewind ( )

inherited

Rewind the buffer.

Sets the position to 0.

◆ setLimit()

void setLimit ( uint_t limit )

inherited

Set the limit.

◆ setPosition()

void setPosition ( uint_t pos )

inherited

Set the position.

◆ setSize() [1/2]

virtual void setSize ( uint_t newSize )

virtualinherited

Resize the buffer.

Parameters

newSize The new size, in elements.

Exceptions

UnsupportedOperationException If this object does not own the underlying byte buffer.

Reimplemented in CircularBuffer< T >, CircularBuffer< C >, and CircularBuffer< byte_t >.

◆ setSize() [2/2]

void setSize ( size_t newSize )

Exceptions

JavaException If the buffer cannot be resized.

◆ skip()

uint_t skip ( uint_t delta )

inherited

Advance the position by the given number of elements, or to the limit, whichever occurs first, filling the "skipped" elements with zeroes.

Parameters

delta The number of elements.

Returns: The new position.

Member Data Documentation

◆ _data

T* _data

protectedinherited

A pointer to the raw buffer.

◆ _limit

uint_t _limit

protectedinherited

The limit.

◆ _owner

bool _owner

protectedinherited

Whether this object owns the raw buffer.

◆ _pos

uint_t _pos

protectedinherited

The position.

◆ _size

uint_t _size

protectedinherited

The size of the buffer.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JavaBuffer()

◆ ~JavaBuffer()

Member Function Documentation

◆ bump()

◆ clear()

◆ fill()

◆ flip()

◆ get() [1/2]

◆ get() [2/2]

◆ getBase() [1/2]

◆ getBase() [2/2]

◆ getJavaObject()

◆ getLimit()

◆ getPointer() [1/2]

◆ getPointer() [2/2]

◆ getPosition()

◆ getRemaining()

◆ getSize()

◆ hasRemaining()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ peek()

◆ put() [1/2]

◆ put() [2/2]

◆ rewind()

◆ setLimit()

◆ setPosition()

◆ setSize() [1/2]

◆ setSize() [2/2]

◆ skip()

Member Data Documentation

◆ _data

◆ _limit

◆ _owner

◆ _pos

◆ _size