casa.agentCom

Interface InfiniteReadWriteByteBufferInterface

All Known Implementing Classes:

InfiniteReadWriteByteBuffer, TCPChannel

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

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, Department of Computer Science, University of Calgary

Version:

0.9

Author:

Rob Kremer

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

Method Detail

peakBuffer

byte[] peakBuffer(int size)

Parameters:

size -

Returns:

The first size elements of the buffer.

bytesAvailableInBuffer

int bytesAvailableInBuffer()

Returns:

The number of bytes available for read in the buffer.

readBuffer

byte[] readBuffer(int size)

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

Parameters:

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

Returns:

the first size bytes from the buffer.

writeBuffer

void writeBuffer(byte[] data)

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

Parameters:

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

getBytesExpected

int getBytesExpected()

Returns:

The number last written by putBytesExpected(int).

putBytesExpected

void putBytesExpected(int n)

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

Parameters:

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