org.mpisws.p2p.transport.util
Class SocketInputBuffer

java.lang.Object
  org.mpisws.p2p.transport.util.SocketInputBuffer

All Implemented Interfaces:

InputBuffer

public class SocketInputBuffer
extends Object
implements InputBuffer

An easy way to read a complete object in from a socket. Wraps a Socket as an InputBuffer Throws an InsufficientBytesExceptoin when there is not enough data available locally, but caches the data so you can attempt to deserialize the object from the beginning when there are additional bytes. Not thread safe! The read operations will either: a) succeed b) throw a InsufficientBytesException, which you should probably retry later when there are more bytes (automatically calls reset) c) throw a ClosedChannelException, which means the socket was closed, d) other IOException If you don't complete reading the object, and want to start from the beginning of the cache, call reset(). If you complete reading the object, but want to reuse the SocketInputBuffer, call clear(). Note that the bytesRemaining() field always returns UNKNOWN because Java's socket api doesn't give us this information To find the size of the cache call size(). This is the amount of usable bytes in the cache, not the capacity. SocketInputBuffer automatically grows. Implementation notes: readPtr/writePtr are operating on the same byte[] called cache

Author:

Jeff Hoye

Field Summary

Fields inherited from interface rice.p2p.commonapi.rawserialization.InputBuffer

UNKNOWN

Constructor Summary

SocketInputBuffer(P2PSocket socket)

SocketInputBuffer(P2PSocket socket, int size)

Method Summary

int	bytesRemaining() How much data is left in the InputBuffer.
void	clear() Clears the cache from memory, resetting it to the initial size.
int	read(byte[] b)
int	read(byte[] b, int off, int len)
boolean	readBoolean()
byte	readByte()
char	readChar()
double	readDouble()
float	readFloat()
int	readInt()
int	readInternal()
int	readInternal(byte[] b)
int	readInternal(byte[] b, int off, int len)
long	readLong()
short	readShort()
String	readUTF()
void	reset() Resets the read pointer to the beginning of the cache.
int	size() Note that this is not the number of bytes that can be read without throwing an exception, since some of these bytes may already have been consumed.

Methods inherited from class java.lang.Object

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

Constructor Detail

SocketInputBuffer

public SocketInputBuffer(P2PSocket socket)

SocketInputBuffer

public SocketInputBuffer(P2PSocket socket,
                         int size)

Method Detail

bytesRemaining

public int bytesRemaining()

Description copied from interface: InputBuffer

How much data is left in the InputBuffer. May be UNKNOWN

Specified by:

bytesRemaining in interface InputBuffer

reset

public void reset()

Resets the read pointer to the beginning of the cache.

size

public int size()

Note that this is not the number of bytes that can be read without throwing an exception, since some of these bytes may already have been consumed. This is mostly useful for debugging.

Returns:

the number of useful bytes in the cache

readInternal

public int readInternal(byte[] b,
                        int off,
                        int len)
                 throws IOException

Parameters:

b -

off -

len -

Returns:

the number of bytes read

Throws:

IOException

readInternal

public int readInternal(byte[] b)
                 throws IOException

Parameters:

b -

Returns:

the number of bytes read

Throws:

IOException

readInternal

public int readInternal()
                 throws IOException

Returns:

the value of one byte

Throws:

IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Specified by:

read in interface InputBuffer

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Specified by:

read in interface InputBuffer

Throws:

IOException

readByte

public byte readByte()
              throws IOException

Specified by:

readByte in interface InputBuffer

Throws:

IOException

readBoolean

public boolean readBoolean()
                    throws IOException

Specified by:

readBoolean in interface InputBuffer

Throws:

IOException

readChar

public char readChar()
              throws IOException

Specified by:

readChar in interface InputBuffer

Throws:

IOException

readDouble

public double readDouble()
                  throws IOException

Specified by:

readDouble in interface InputBuffer

Throws:

IOException

readFloat

public float readFloat()
                throws IOException

Specified by:

readFloat in interface InputBuffer

Throws:

IOException

readInt

public int readInt()
            throws IOException

Specified by:

readInt in interface InputBuffer

Throws:

IOException

readLong

public long readLong()
              throws IOException

Specified by:

readLong in interface InputBuffer

Throws:

IOException

readShort

public short readShort()
                throws IOException

Specified by:

readShort in interface InputBuffer

Throws:

IOException

readUTF

public String readUTF()
               throws IOException

Specified by:

readUTF in interface InputBuffer

Throws:

IOException

clear

public void clear()
           throws IOException

Clears the cache from memory, resetting it to the initial size. This is a good thing to do after you read an object.

Throws:

IOException