com.glneurotech.devices.common.RingBufferStream Class Reference

Inheritance diagram for com.glneurotech.devices.common.RingBufferStream:

Public Member Functions
	RingBufferStream (int bufferSize)
	RingBufferStream ()
boolean	getCanRead ()
boolean	getCanSeek ()
boolean	getCanWrite ()
void	flush ()
long	getLength ()
final long	getActualLength ()
long	getPosition ()
void	setPosition (long value)
int	read ()
int	read (byte[] buffer, int offset, int count)
void	setLength (long value)
void	write (byte[] buffer, int offset, int count)
void	write (byte[] buffer)
void	write (int i)
void	close ()
final long	getBytesFree ()
final void	write (byte[] buffer, int length)
Public Member Functions inherited from com.glneurotech.devices.common.transportlayer.GlntStream
abstract void	close ()
abstract void	flush ()
abstract void	write (byte[] b)
abstract void	write (byte[] b, int off, int len)
abstract void	write (int b)
Public Member Functions inherited from com.glneurotech.devices.common.transportlayer.GlntInputStream
byte []	inputStreamToArray () throws IOException

Protected Member Functions
void	dispose (boolean disposing)

Detailed Description

Ring buffer stream class

Constructor & Destructor Documentation

RingBufferStream() [1/2]

com.glneurotech.devices.common.RingBufferStream.RingBufferStream

(

int

bufferSize

)

Ring buffer stream overloaded constructor.

Parameters

bufferSize

Take an integer as parameter.

RingBufferStream() [2/2]

com.glneurotech.devices.common.RingBufferStream.RingBufferStream

(

)

Ring buffer stream default constructor.

Member Function Documentation

close()

void com.glneurotech.devices.common.RingBufferStream.close

(

)

Close method.

dispose()

void com.glneurotech.devices.common.RingBufferStream.dispose ( boolean  disposing )

protected

Dispose method - sets data buffer to null.

Parameters

disposing

Take a boolean.

flush()

void com.glneurotech.devices.common.RingBufferStream.flush

(

)

Flush methods - reset read and write position to 0.

getActualLength()

final long com.glneurotech.devices.common.RingBufferStream.getActualLength

(

)

Return actual data buffer size length.

Returns

getBytesFree()

final long com.glneurotech.devices.common.RingBufferStream.getBytesFree

(

)

Gets bytes free.

Returns

getCanRead()

boolean com.glneurotech.devices.common.RingBufferStream.getCanRead

(

)

Gets can read - return true;

Returns

getCanSeek()

boolean com.glneurotech.devices.common.RingBufferStream.getCanSeek

(

)

Gets can seek - return false.

Returns

getCanWrite()

boolean com.glneurotech.devices.common.RingBufferStream.getCanWrite

(

)

Gets can write - return false

Returns

getLength()

long com.glneurotech.devices.common.RingBufferStream.getLength

(

)

Gets length.

Returns

getPosition()

long com.glneurotech.devices.common.RingBufferStream.getPosition

(

)

Gets position.

Returns

read() [1/2]

int com.glneurotech.devices.common.RingBufferStream.read

(

)

Read data from a buffer.

Returns

read() [2/2]

int com.glneurotech.devices.common.RingBufferStream.read	(	byte []	buffer,
		int	offset,
		int	count
	)

Read data from a buffer.

Parameters

buffer	Take a byte array.
offset	Take an integer.
count	Take an integer.

Returns

setLength()

void com.glneurotech.devices.common.RingBufferStream.setLength

(

long

value

)

Set length for a buffer. - Not supported.

Parameters

value

Take a long value.

setPosition()

void com.glneurotech.devices.common.RingBufferStream.setPosition

(

long

value

)

Sets position.

Parameters

value

Take a long value as parameter.

write() [1/4]

void com.glneurotech.devices.common.RingBufferStream.write	(	byte []	buffer,
		int	offset,
		int	count
	)

Write a block in a buffer. - Not supported.

Parameters

buffer	Take a byte array.
offset	Take an integer.
count	Take an integer.

write() [2/4]

void com.glneurotech.devices.common.RingBufferStream.write

(

byte []

buffer

)

Write a block in a buffer. - Not supported.

Parameters

buffer

Take a byte array.

write() [3/4]

void com.glneurotech.devices.common.RingBufferStream.write

(

int

i

)

Write a block in a buffer. - Not supported.

Parameters

i	Take an integer.

write() [4/4]

final void com.glneurotech.devices.common.RingBufferStream.write	(	byte []	buffer,
		int	length
	)

Write a block in a buffer.

Parameters

buffer	Take a byte array.
length	Take an integer.

---

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

• GLNeuroTech/src/main/java/com/glneurotech/devices/common/RingBufferStream.java