fr.dyade.aaa.agent.BufferedMessageInputStream Class Reference

Inherits fr.dyade.aaa.agent.MessageInputStream.

Inherited by fr.dyade.aaa.agent.HttpNetwork.NetworkInputStream, fr.dyade.aaa.agent.PoolNetwork.NetSession.NetworkInputStream, fr.dyade.aaa.agent.SimpleNetwork.NetworkInputStream, and fr.dyade.aaa.agent.UDPNetwork.NetworkInputStream.

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

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 BufferedMessageInputStream ()
 BufferedMessageInputStream (int size)
final int read () throws IOException
final int read (byte b[], int off, int len) throws IOException

Protected Member Functions

final void clean ()
final void readFully (int length) throws IOException

Protected Attributes

InputStream in = null

Detailed Description

Class used to recv messages through a stream using buffering.

Be careful this InputStream is not synchronized.

Definition at line 32 of file BufferedMessageInputStream.java.


Constructor & Destructor Documentation

fr.dyade.aaa.agent.BufferedMessageInputStream.BufferedMessageInputStream (  ) 

Creates a BufferedMessageInputStream that uses a buffer with default size.

Definition at line 42 of file BufferedMessageInputStream.java.

fr.dyade.aaa.agent.BufferedMessageInputStream.BufferedMessageInputStream ( int  size  ) 

Creates a BufferedMessageInputStream that uses a buffer with specified size.

Parameters:
size the buffer size.
Exceptions:
IllegalArgumentException if size is less than 0.

Definition at line 53 of file BufferedMessageInputStream.java.

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


Member Function Documentation

final void fr.dyade.aaa.agent.BufferedMessageInputStream.clean (  )  [protected]

Resets the stream for a new use. Removes all datas.

Definition at line 64 of file BufferedMessageInputStream.java.

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

Referenced by fr.dyade.aaa.agent.HttpNetwork.NetworkInputStream.readFrom(), and fr.dyade.aaa.agent.SimpleNetwork.NetServerIn.run().

final int fr.dyade.aaa.agent.BufferedMessageInputStream.read (  )  throws IOException [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.
Exceptions:
IOException if an I/O error occurs.

Implements fr.dyade.aaa.agent.MessageInputStream.

Definition at line 96 of file BufferedMessageInputStream.java.

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

Here is the call graph for this function:

final int fr.dyade.aaa.agent.BufferedMessageInputStream.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:
IOException If the first byte cannot be read for any reason other than end of file, or if the input stream has been closed, or if some other I/O error occurs.
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 133 of file BufferedMessageInputStream.java.

References fr.dyade.aaa.agent.MessageInputStream.getLogger(), and fr.dyade.aaa.agent.BufferedMessageInputStream.in.

Here is the call graph for this function:

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

Reads length bytes of data from the input stream. This method returns when length bytes are available or if end of stream is reached.

Implements fr.dyade.aaa.agent.MessageInputStream.

Definition at line 189 of file BufferedMessageInputStream.java.

References fr.dyade.aaa.agent.MessageInputStream.count, fr.dyade.aaa.agent.MessageInputStream.getLogger(), and fr.dyade.aaa.agent.BufferedMessageInputStream.in.

Referenced by fr.dyade.aaa.agent.SimpleNetwork.NetworkInputStream.readHeader(), and fr.dyade.aaa.agent.HttpNetwork.NetworkInputStream.readHeader().

Here is the call graph for this function:


Member Data Documentation

InputStream fr.dyade.aaa.agent.BufferedMessageInputStream.in = null [protected]

The underlying input stream to be read.

Definition at line 36 of file BufferedMessageInputStream.java.

Referenced by fr.dyade.aaa.agent.BufferedMessageInputStream.read(), and fr.dyade.aaa.agent.BufferedMessageInputStream.readFully().


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