com.captainalm.lib.calmnet.stream

Class NetworkOutputStream

java.lang.Object

java.io.OutputStream

com.captainalm.lib.calmnet.stream.NetworkOutputStream

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class NetworkOutputStream
extends java.io.OutputStream

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

Author:

Captain ALM

Constructor Summary

Constructors

Constructor and Description
NetworkOutputStream(java.net.DatagramSocket socketIn) Constructs a new NetworkOutputStream with the specified DatagramSocket.
NetworkOutputStream(java.net.DatagramSocket socketIn, int size) Constructs a new NetworkOutputStream with the specified DatagramSocket and datagram buffer size.
NetworkOutputStream(java.net.DatagramSocket socketIn, int size, java.net.InetAddress address, int port) Constructs a new NetworkOutputStream with the specified DatagramSocket, datagram buffer size, InetAddress target and port target.
NetworkOutputStream(java.net.Socket socketIn) Constructs a new NetworkOutputStream with the specified Socket.

Method Summary

Modifier and Type	Method and Description
boolean	canDatagramBufferBeSet() Gets if the setDatagramBufferSize(int) can be used.
void	close() Closes this output stream and releases any system resources associated with this stream.
void	flush() Flushes this output stream and forces any buffered output bytes to be written out.
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.
java.lang.Integer	getPort() Gets the current port of the stream.
java.net.Socket	getSocket() Gets the socket in use or null.
void	setDatagramBufferSize(int size) Sets the buffer size for sending datagrams.
void	setDatagramSocket(java.net.DatagramSocket socketIn) Sets the datagram socket in use.
void	setDatagramTarget(java.net.InetAddress address, int port) Sets the datagram target InetAddress and port.
void	setSocket(java.net.Socket socketIn) Sets the socket in use.
void	write(int b) Writes the specified byte to this output stream.

Methods inherited from class java.io.OutputStream

write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkOutputStream

public NetworkOutputStream(java.net.Socket socketIn)

Constructs a new NetworkOutputStream with the specified Socket.

Parameters:

socketIn - The socket to use.

Throws:

java.lang.NullPointerException - socketIn is null.

NetworkOutputStream

public NetworkOutputStream(java.net.DatagramSocket socketIn)

Constructs a new NetworkOutputStream with the specified DatagramSocket.

Parameters:

socketIn - The datagram socket to use.

Throws:

java.lang.NullPointerException - socketIn is null.

NetworkOutputStream

public NetworkOutputStream(java.net.DatagramSocket socketIn,
                           int size)

Constructs a new NetworkOutputStream with the specified DatagramSocket and datagram buffer size.

Parameters:

socketIn - The datagram socket to use.

size - The size of the buffer.

Throws:

java.lang.NullPointerException - socketIn is null.

java.lang.IllegalArgumentException - size is less than 1 or greater than 65535.

NetworkOutputStream

public NetworkOutputStream(java.net.DatagramSocket socketIn,
                           int size,
                           java.net.InetAddress address,
                           int port)

Constructs a new NetworkOutputStream with the specified DatagramSocket, datagram buffer size, InetAddress target and port target.

Parameters:

socketIn - The datagram socket to use.

size - The size of the buffer.

address - The target address to set to.

port - The target port to set to.

Throws:

java.lang.NullPointerException - socketIn or address is null.

java.lang.IllegalArgumentException - size is less than 1 or greater than 65535 or port is less than 0 or greater than 65535.

Method Detail

canDatagramBufferBeSet

public boolean canDatagramBufferBeSet()

Gets if the setDatagramBufferSize(int) can be used.

Returns:

If the datagram buffer size can be set.

setDatagramBufferSize

public void setDatagramBufferSize(int size)
                           throws java.io.IOException

Sets the buffer size for sending datagrams.

Parameters:

size - The size to set to.

Throws:

java.lang.IllegalArgumentException - size is less than 1 or greater than 65535.

java.io.IOException - a datagram socket is not in use, buffer index is not null or the stream is closed.

setDatagramTarget

public void setDatagramTarget(java.net.InetAddress address,
                              int port)
                       throws java.io.IOException

Sets the datagram target InetAddress and port.

Parameters:

address - The address to set to.

port - The port to set to.

Throws:

java.lang.NullPointerException - address is null.

java.lang.IllegalArgumentException - port is less than 0 or greater than 65535.

java.io.IOException - a datagram socket is not in use or the stream is closed.

write

public void write(int b)
           throws java.io.IOException

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Specified by:

write in class java.io.OutputStream

Parameters:

b - the byte.

Throws:

java.io.IOException - if an I/O error occurs. In particular, an IOException will be thrown if the output stream has been closed.

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.

flush

public void flush()
           throws java.io.IOException

Flushes this output stream and forces any buffered output bytes to be written out. The general contract of flush is that calling it is an indication that, if any bytes previously written have been buffered by the implementation of the output stream, such bytes should immediately be written to their intended destination.

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

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

close

public void close()
           throws java.io.IOException

Closes this output stream and releases any system resources associated with this stream. The general contract of close is that it closes the output stream. A closed stream cannot perform output operations and cannot be reopened. 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.OutputStream

Throws:

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