com.captainalm.lib.calmnet.stream

Class NetworkInputStream

java.lang.Object

java.io.InputStream

com.captainalm.lib.calmnet.stream.NetworkInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class NetworkInputStream
extends java.io.InputStream

This class provides a Network Input stream for either Sockets or DatagramSockets.

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
NetworkInputStream(java.net.DatagramSocket socketIn) Constructs a new NetworkInputStream with the specified DatagramSocket.
NetworkInputStream(java.net.Socket socketIn) Constructs a new NetworkInputStream with the specified Socket.

Method Summary

Modifier and Type	Method and Description
int	available() Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.
void	close() Closes this input stream and releases any system resources associated with the stream.
java.net.InetAddress	getAddress() Gets the current InetAddress of the stream.
java.net.DatagramSocket	getDatagramSocket() Gets the datagram socket in use or null.
java.net.InetAddress	getLocalAddress() Gets the local InetAddress of the stream.
java.lang.Integer	getLocalPort() Gets the local port of the stream.
int	getPacketSize() Gets the current datagram packet size.
java.lang.Integer	getPort() Gets the current port of the stream.
java.net.Socket	getSocket() Gets the socket in use or null.
int	read() Reads the next byte of data from the input stream.
byte[]	readPacket() Reads a single datagram packet.
int	readPacket(byte[] b) Reads a single datagram packet into the specified buffer storing with no offset.
int	readPacket(byte[] b, int off, int len) Reads a single datagram packet into the specified buffer storing from the specified offset and the specified number of bytes.
void	setDatagramSocket(java.net.DatagramSocket socketIn) Sets the datagram socket in use.
void	setSocket(java.net.Socket socketIn) Sets the socket in use.

Methods inherited from class java.io.InputStream

mark, markSupported, read, read, reset, skip

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkInputStream

public NetworkInputStream(java.net.Socket socketIn)

Constructs a new NetworkInputStream with the specified Socket.

Parameters:

socketIn - The socket to use.

Throws:

java.lang.NullPointerException - socketIn is null.

NetworkInputStream

public NetworkInputStream(java.net.DatagramSocket socketIn)

Constructs a new NetworkInputStream with the specified DatagramSocket.

Parameters:

socketIn - The datagram socket to use.

Throws:

java.lang.NullPointerException - socketIn is null.

Method Detail

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.

Specified by:

read in class java.io.InputStream

Returns:

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

Throws:

java.io.IOException - if an I/O error occurs.

readPacket

public byte[] readPacket()
                  throws java.io.IOException

Reads a single datagram packet.

Returns:

A byte array of the single datagram packet.

Throws:

java.io.IOException - if an I/O error occurs, stream closed or not using a datagram socket.

readPacket

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

Reads a single datagram packet into the specified buffer storing with no offset.

Parameters:

b - The buffer to store the packet in.

Returns:

The number of bytes stored or -1 for end of stream.

Throws:

java.lang.NullPointerException - b is null.

java.io.IOException - if an I/O error occurs, stream closed or not using a datagram socket.

readPacket

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

Reads a single datagram packet into the specified buffer storing from the specified offset and the specified number of bytes.

Parameters:

b - The buffer to store the packet in.

off - The offset to store in the buffer from.

len - The number of bytes to store in the buffer.

Returns:

The number of bytes stored or -1 for end of stream.

Throws:

java.lang.NullPointerException - b is null.

java.lang.IndexOutOfBoundsException - if off is negative, len is negative, or len is greater than the difference of the length of the buffer and off.

java.io.IOException - if an I/O error occurs, stream closed or not using a datagram socket.

getPacketSize

public int getPacketSize()
                  throws java.io.IOException

Gets the current datagram packet size.

Returns:

The datagram packet size.

Throws:

java.io.IOException - stream closed or not using a datagram socket.

getAddress

public java.net.InetAddress getAddress()

Gets the current InetAddress of the stream. Can be null.

Returns:

The address.

getPort

public java.lang.Integer getPort()

Gets the current port of the stream. Can be -1.

Returns:

The current port.

getLocalAddress

public java.net.InetAddress getLocalAddress()

Gets the local InetAddress of the stream. Can be null.

Returns:

The local address.

getLocalPort

public java.lang.Integer getLocalPort()

Gets the local port of the stream. Can be -1.

Returns:

The local port.

getSocket

public java.net.Socket getSocket()

Gets the socket in use or null.

Returns:

The socket in use or null.

setSocket

public void setSocket(java.net.Socket socketIn)
               throws java.io.IOException

Sets the socket in use.

Parameters:

socketIn - The socket to now use.

Throws:

java.lang.NullPointerException - socketIn is null.

java.io.IOException - stream closed or not using a socket.

getDatagramSocket

public java.net.DatagramSocket getDatagramSocket()

Gets the datagram socket in use or null.

Returns:

The datagram socket in use or null.

setDatagramSocket

public void setDatagramSocket(java.net.DatagramSocket socketIn)
                       throws java.io.IOException

Sets the datagram socket in use.

Parameters:

socketIn - The datagram socket to now use.

Throws:

java.lang.NullPointerException - socketIn is null.

java.io.IOException - stream closed or not using a datagram socket.

available

public int available()
              throws java.io.IOException

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream. The next invocation might be the same thread or another thread. A single read or skip of this many bytes will not block, but may read or skip fewer bytes.

Overrides:

available in class java.io.InputStream

Returns:

an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking or 0 when it reaches the end of the input stream.

Throws:

java.io.IOException - if an I/O error occurs.

close

public void close()
           throws java.io.IOException

Closes this input stream and releases any system resources associated with the stream. The underlying socket is closed.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.InputStream

Throws:

java.io.IOException - if an I/O error occurs.