casa.agentCom

Class InfiniteReadWriteByteBuffer

java.lang.Object

casa.agentCom.InfiniteReadWriteByteBuffer

All Implemented Interfaces:

InfiniteReadWriteByteBufferInterface

public class InfiniteReadWriteByteBuffer
extends Object
implements InfiniteReadWriteByteBufferInterface

A simple "infinite" byte buffer designed to be for a writer to write byte[]s to and a read to read what the writer has written.

Title: CASA Agent Infrastructure

Description:

Copyright: Copyright (c) 2003-2014, Knowledge Science Group, University of Calgary. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. The Knowledge Science Group makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Company: Knowledge Science Group, University of Calgary

Version:

0.9

Author:

Rob Kremer

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	buffer
private int	bytesExpected

Constructor Summary

Constructors

Constructor and Description
InfiniteReadWriteByteBuffer()

Method Summary

Modifier and Type	Method and Description
int	bytesAvailableInBuffer()
int	getBytesExpected()
byte[]	peakBuffer(int size)
void	putBytesExpected(int n) Updates the number that will be returned by InfiniteReadWriteByteBufferInterface.getBytesExpected().
byte[]	readBuffer(int size) Returns the first size elements from the buffer and removes them from the buffer.
void	writeBuffer(byte[] data) Adds the data to the end of the buffer.

Methods inherited from class java.lang.Object

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

Field Detail

buffer

private byte[] buffer

bytesExpected

private int bytesExpected

Constructor Detail

InfiniteReadWriteByteBuffer

public InfiniteReadWriteByteBuffer()

Method Detail

writeBuffer

public void writeBuffer(byte[] data)

Description copied from interface: InfiniteReadWriteByteBufferInterface

Adds the data to the end of the buffer. This data may later be read by InfiniteReadWriteByteBufferInterface.readBuffer(int).

Specified by:

writeBuffer in interface InfiniteReadWriteByteBufferInterface

Parameters:

data - The data to be written into the end of the buffer.

readBuffer

public byte[] readBuffer(int size)

Description copied from interface: InfiniteReadWriteByteBufferInterface

Returns the first size elements from the buffer and removes them from the buffer.

Specified by:

readBuffer in interface InfiniteReadWriteByteBufferInterface

Parameters:

size - Specifies the number or elements to read from the buffer.

Returns:

the first size bytes from the buffer.

bytesAvailableInBuffer

public int bytesAvailableInBuffer()

Specified by:

bytesAvailableInBuffer in interface InfiniteReadWriteByteBufferInterface

Returns:

The number of bytes available for read in the buffer.

peakBuffer

public byte[] peakBuffer(int size)

Specified by:

peakBuffer in interface InfiniteReadWriteByteBufferInterface

Returns:

The first size elements of the buffer.

getBytesExpected

public int getBytesExpected()

Specified by:

getBytesExpected in interface InfiniteReadWriteByteBufferInterface

Returns:

The number last written by InfiniteReadWriteByteBufferInterface.putBytesExpected(int).

putBytesExpected

public void putBytesExpected(int n)

Description copied from interface: InfiniteReadWriteByteBufferInterface

Updates the number that will be returned by InfiniteReadWriteByteBufferInterface.getBytesExpected().

Specified by:

putBytesExpected in interface InfiniteReadWriteByteBufferInterface

Parameters:

n - The number to be returned by subsequent calls to InfiniteReadWriteByteBufferInterface.getBytesExpected().