fr.dyade.aaa.agent.ByteArrayMessageInputStream Class Reference

Inherits fr.dyade.aaa.agent.MessageInputStream.

Inheritance diagram for fr.dyade.aaa.agent.ByteArrayMessageInputStream:

Inheritance graph
[legend]
Collaboration diagram for fr.dyade.aaa.agent.ByteArrayMessageInputStream:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ByteArrayMessageInputStream (byte[] buf)
 ByteArrayMessageInputStream (byte[] buf, int offset, int length)
final int read ()
final int read (byte b[], int off, int len) throws IOException

Protected Member Functions

final void readFully (int length) throws IOException

Detailed Description

Class used to recv messages through a stream in a byte array.

Be careful this InputStream is not synchronized.

Definition at line 28 of file ByteArrayMessageInputStream.java.


Constructor & Destructor Documentation

fr.dyade.aaa.agent.ByteArrayMessageInputStream.ByteArrayMessageInputStream ( byte[]  buf  ) 

Creates a ByteArrayMessageInputStream that uses buf as its buffer array.

Be careful, the buffer array is not copied. The initial value of pos is 0 and the initial value of count is the length of buf.

Parameters:
buf the input buffer.

Definition at line 39 of file ByteArrayMessageInputStream.java.

fr.dyade.aaa.agent.ByteArrayMessageInputStream.ByteArrayMessageInputStream ( byte[]  buf,
int  offset,
int  length 
)

Creates ByteArrayMessageInputStream that uses buf as its buffer array.

Be careful, the buffer array is not copied. The initial value of pos is offset and the initial value of count is the minimum of offset+length and buf.length.

Parameters:
buf the input buffer.
offset the offset in the buffer of the first byte to read.
length the maximum number of bytes to read from the buffer.

Definition at line 56 of file ByteArrayMessageInputStream.java.

References fr.dyade.aaa.agent.MessageInputStream.count, and fr.dyade.aaa.agent.MessageInputStream.pos.


Member Function Documentation

final int fr.dyade.aaa.agent.ByteArrayMessageInputStream.read (  )  [virtual]

Reads the next byte of data from the input stream. The value byte is returned as an int in the range 0 to 255. If no byte is available because the end of the stream has been reached, the value -1 is returned. This method blocks until input data is available, the end of the stream is detected, or an exception is thrown.

Returns:
the next byte of data, or -1 if the end of the stream is reached.

Implements fr.dyade.aaa.agent.MessageInputStream.

Definition at line 73 of file ByteArrayMessageInputStream.java.

References fr.dyade.aaa.agent.MessageInputStream.buf, fr.dyade.aaa.agent.MessageInputStream.count, and fr.dyade.aaa.agent.MessageInputStream.pos.

final int fr.dyade.aaa.agent.ByteArrayMessageInputStream.read ( byte  b[],
int  off,
int  len 
) throws IOException [virtual]

Reads up to len bytes of data from the input stream into an array of bytes. An attempt is made to read as many as len bytes, but a smaller number may be read. The number of bytes actually read is returned as an integer.

This method blocks until input data is available, end of file is detected, or an exception is thrown.

Parameters:
b the buffer into which the data is read.
off the start offset in array b at which the data is written.
len the maximum number of bytes to read.
Returns:
the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.
Exceptions:
NullPointerException If b is null.
IndexOutOfBoundsException If off is negative, len is negative, or len is greater than b.length - off

Implements fr.dyade.aaa.agent.MessageInputStream.

Definition at line 98 of file ByteArrayMessageInputStream.java.

References fr.dyade.aaa.agent.MessageInputStream.buf, fr.dyade.aaa.agent.MessageInputStream.count, and fr.dyade.aaa.agent.MessageInputStream.pos.

final void fr.dyade.aaa.agent.ByteArrayMessageInputStream.readFully ( int  length  )  throws IOException [protected, virtual]

Reads length bytes of data from the input stream.

Implements fr.dyade.aaa.agent.MessageInputStream.

Definition at line 122 of file ByteArrayMessageInputStream.java.


The documentation for this class was generated from the following file:
Generated on Tue Sep 16 16:16:19 2008 for joram by  doxygen 1.5.0