mobnet
Class InputStream

java.lang.Object
  java.io.InputStream
      mobnet.InputStream

public class InputStream

extends java.io.InputStream

InputStream.java - Class which provides an InputStream implementation based on the Virtual Network design.

Author:

Avi TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

Constructor Summary

InputStream()
Empty Constructor for InputStream.

Method Summary

int	available() Returns the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream.
void	close() Closes this input stream and releases any system resources associated with the stream.
int	getTimeouttime() Get the timeout used for this InputStream
static void	main(java.lang.String[] args)
void	mark(int readlimit) NOT SUPPORTED AT PRESENT - DO NOT USE Marks the current position in this input stream.
boolean	markSupported() CURRENTLY ALWAYS RETURNS FALSE as mark not supported Tests if this input stream supports the mark and reset methods.
int	read() Reads the next byte of data from the input stream.
int	read(byte[] b) Reads some number of bytes from the input stream and stores them into the buffer array b.
int	read(byte[] b, int off, int len) Reads up to len bytes of data from the input stream into an array of bytes.
void	reset() CURRENTLY NOT SUPPORTED - DO NOT USE Repositions this stream to the position at the time the mark method was last called on this input stream.
void	setBytes(byte[] b) Add a byte array into the internal byte array which stores the bytes that have been 'recieved' by this node.
void	setTimeout()
void	setTimeouttime(int ms) Set the timeout to be used for this InputStream.
long	skip(int n) Skips over and discards n bytes of data from this input stream.

Methods inherited from class java.io.InputStream

skip

Methods inherited from class java.lang.Object

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

Constructor Detail

InputStream

public InputStream()

Empty Constructor for InputStream.

Method Detail

setBytes

public void setBytes(byte[] b)

Add a byte array into the internal byte array which stores the bytes that have been 'recieved' by this node.

Parameters:

b - Byte array containing the bytes to be appended.

setTimeouttime

public void setTimeouttime(int ms)

Set the timeout to be used for this InputStream.

Parameters:

ms - length in milliseconds of time out.

getTimeouttime

public int getTimeouttime()

Get the timeout used for this InputStream

Returns:

Timeout in milliseconds

read

public int read(byte[] b)
         throws java.io.IOException

Reads some number of bytes from the input stream and stores them into the buffer array b. 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. If b is null, a NullPointerException is thrown. If the length of b is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b. The first byte read is stored into element b[0], the next one into b[1], and so on. The number of bytes read is, at most, equal to the length of b. Let k be the number of bytes actually read; these bytes will be stored in elements b[0] through b[k-1], leaving elements b[k] through b[b.length-1] unaffected. If the first byte cannot be read for any reason other than end of file, then an IOException is thrown. In particular, an IOException is thrown if the input stream has been closed. The read(b) method for class InputStream has the same effect as read(b, 0, b.length)

Parameters:

b - The buffer into which the data is read.

Returns:

Throws:

java.io.IOException

read

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

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, possibly zero. 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. If b is null, a NullPointerException is thrown. If off is negative, or len is negative, or off+len is greater than length of the array b, then an IndexOutOfBoundsException is thrown. If len is zero, then no bytes are read and 0 is returned; otherwise, there is an attempt to read at least one byte. If no byte is available because the stream is at end of file, the value -1 is returned; otherwise, at least one byte is read and stored into b. The first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len. Let k be the number of bytes actually read; these bytes will be stored in elements b[off] through b[off+k-1], leaving elements b[off+k] through b[off+len-1] unaffected. In every case, elements b[0] through b[off] and elements b[off+len] through b[b.length-1] are unaffected.

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.

Throws:

java.io.IOException

setTimeout

public void setTimeout()

read

public int read()
         throws java.io.IOException

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.

Throws:

java.io.IOException

available

public int available()

Returns the number of bytes that can be read (or skipped over) from this input stream without blocking by the next caller of a method for this input stream. The next caller might be the same thread or or another thread.

Returns:

the number of bytes that can be read from this input stream without blocking.

mark

public void mark(int readlimit)

NOT SUPPORTED AT PRESENT - DO NOT USE Marks the current position in this input stream. A subsequent call to the reset method repositions this stream at the last marked position so that subsequent reads re-read the same bytes. The readlimit arguments tells this input stream to allow that many bytes to be read before the mark position gets invalidated. The general contract of mark is that, if the method markSupported returns true, the stream somehow remembers all the bytes read after the call to mark and stands ready to supply those same bytes again if and whenever the method reset is called. However, the stream is not required to remember any data at all if more than readlimit bytes are read from the stream before reset is called.

Parameters:

readlimit - the maximum limit of bytes that can be read before the mark position becomes invalid

reset

public void reset()

CURRENTLY NOT SUPPORTED - DO NOT USE Repositions this stream to the position at the time the mark method was last called on this input stream.

skip

public long skip(int n)
          throws java.io.IOException

Skips over and discards n bytes of data from this input stream. The skip method may, for a variety of reasons, end up skipping over some smaller number of bytes, possibly 0. This may result from any of a number of conditions; reaching end of file before n bytes have been skipped is only one possibility. The actual number of bytes skipped is returned. If n is negative, no bytes are skipped. The skip method of InputStream creates a byte array and then repeatedly reads into it until n bytes have been read or the end of the stream has been reached.

Parameters:

n - The number of bytes to be skipped.

Returns:

the actual number of bytes skipped

Throws:

java.io.IOException

markSupported

public boolean markSupported()

CURRENTLY ALWAYS RETURNS FALSE as mark not supported Tests if this input stream supports the mark and reset methods. Whether or not mark and reset are supported is an invariant property of a particular input stream instance. The markSupported method of InputStream returns false.

Returns:

true if this stream instance supports the mark and reset methods; false otherwise.

close

public void close()

Closes this input stream and releases any system resources associated with the stream.

main

public static void main(java.lang.String[] args)