org.ice4j.socket

Class MultiplexingSocket

java.lang.Object

java.net.Socket

org.ice4j.socket.DelegatingSocket

org.ice4j.socket.MultiplexingSocket

All Implemented Interfaces:

Closeable, AutoCloseable

public class MultiplexingSocket
extends DelegatingSocket

Represents a Socket which allows filtering DatagramPackets it reads from the network using DatagramPacketFilters so that the DatagramPackets do not get received through it but through associated MultiplexedSockets.

Author:

Sebastien Vincent, Lyubomir Marinov

Field Summary

Fields

Modifier and Type	Field and Description
private InputStream	inputStream Custom InputStream for this Socket.
private static Logger	logger The Logger used by the MultiplexingSocket class and its instances for logging output.
private MultiplexingXXXSocketSupport<MultiplexedSocket>	multiplexingXXXSocketSupport The MultiplexingXXXSocketSupport which implements functionality common to TCP and UDP sockets in order to facilitate implementers such as this instance.
private TCPOutputStream	outputStream Custom OutputStream for this Socket.
private List<DatagramPacket>	received The list of DatagramPackets to be received through this Socket i.e.
private int	soTimeout Buffer variable for storing the SO_TIMEOUT value set by the last setSoTimeout() call.

Fields inherited from class org.ice4j.socket.DelegatingSocket

channel, delegate

Constructor Summary

Constructors

Modifier	Constructor and Description
	MultiplexingSocket() Initializes a new MultiplexingSocket instance.
	MultiplexingSocket(InetAddress address, int port) Initializes a new MultiplexingSocket instance.
	MultiplexingSocket(InetAddress address, int port, InetAddress localAddr, int localPort) Initializes a new MultiplexingSocket instance.
	MultiplexingSocket(Proxy proxy) Initializes a new MultiplexingSocket instance.
	MultiplexingSocket(Socket socket) Initializes a new MultiplexingSocket instance.
protected	MultiplexingSocket(SocketImpl impl) Initializes a new MultiplexingSocket instance.
	MultiplexingSocket(String host, int port) Initializes a new MultiplexingSocket instance.
	MultiplexingSocket(String host, int port, InetAddress localAddr, int localPort) Initializes a new MultiplexingSocket instance.

Method Summary

Modifier and Type	Method and Description
(package private) void	close(MultiplexedSocket multiplexed) Closes a specific MultiplexedSocket which filters DatagramPackets away from this Socket.
InputStream	getInputStream()
InputStream	getOriginalInputStream() Get original InputStream.
OutputStream	getOriginalOutputStream() Get original OutputStream.
OutputStream	getOutputStream()
MultiplexedSocket	getSocket(DatagramPacketFilter filter) Gets a MultiplexedDatagramSocket which filters DatagramPackets away from this DatagramSocket using a specific DatagramPacketFilter.
int	getSoTimeout()
private void	multiplexingXXXSocketSupportDoReceive(DatagramPacket p) Implements MultiplexingXXXSocketSupport.doReceive(DatagramPacket) on behalf of multiplexingXXXSocketSupport.
private void	multiplexingXXXSocketSupportDoSetReceiveBufferSize(int receiveBufferSize) Implements MultiplexingXXXSocketSupport.doSetReceiveBufferSize(int) on behalf of multiplexingXXXSocketSupport.
void	receive(DatagramPacket p) Receives a datagram packet from this socket.
(package private) void	receive(MultiplexedSocket multiplexed, DatagramPacket p) Receives a DatagramPacket from this Socket upon request from a specific MultiplexedSocket.
void	setSoTimeout(int timeout)

Methods inherited from class org.ice4j.socket.DelegatingSocket

bind, close, connect, connect, getChannel, getInetAddress, getKeepAlive, getLocalAddress, getLocalPort, getLocalSocketAddress, getOOBInline, getPort, getReceiveBufferSize, getRemoteSocketAddress, getReuseAddress, getSendBufferSize, getSoLinger, getTcpNoDelay, getTrafficClass, isBound, isClosed, isConnected, isInputShutdown, isOutputShutdown, receiveFromInputStream, send, sendUrgentData, setKeepAlive, setOOBInline, setOriginalInputStream, setPerformancePreferences, setReceiveBufferSize, setReuseAddress, setSendBufferSize, setSoLinger, setTcpNoDelay, setTrafficClass, shutdownInput, shutdownOutput, toString

Methods inherited from class java.net.Socket

setSocketImplFactory

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Logger logger

The Logger used by the MultiplexingSocket class and its instances for logging output.

inputStream

private final InputStream inputStream

Custom InputStream for this Socket.

multiplexingXXXSocketSupport

private final MultiplexingXXXSocketSupport<MultiplexedSocket> multiplexingXXXSocketSupport

The MultiplexingXXXSocketSupport which implements functionality common to TCP and UDP sockets in order to facilitate implementers such as this instance.

outputStream

private TCPOutputStream outputStream

Custom OutputStream for this Socket.

received

private final List<DatagramPacket> received

The list of DatagramPackets to be received through this Socket i.e. not accepted by the DatagramFilters of #sockets at the time of the reading from the network.

soTimeout

private int soTimeout

Buffer variable for storing the SO_TIMEOUT value set by the last setSoTimeout() call. Although not strictly needed, getting the locally stored value as opposed to retrieving it from a parent getSoTimeout() call seems to significantly improve efficiency, at least on some platforms.

Constructor Detail

MultiplexingSocket

public MultiplexingSocket()

Initializes a new MultiplexingSocket instance.

See Also:

Socket.Socket()

MultiplexingSocket

public MultiplexingSocket(InetAddress address,
                          int port)

Initializes a new MultiplexingSocket instance.

Parameters:

address - not used

port - not used

See Also:

Socket.Socket(InetAddress, int)

MultiplexingSocket

public MultiplexingSocket(InetAddress address,
                          int port,
                          InetAddress localAddr,
                          int localPort)

Initializes a new MultiplexingSocket instance.

Parameters:

address - not used

port - not used

localAddr - not used

localPort - not used

See Also:

Socket.Socket(InetAddress, int, InetAddress, int)

MultiplexingSocket

public MultiplexingSocket(Proxy proxy)

Initializes a new MultiplexingSocket instance.

Parameters:

proxy - not used

See Also:

Socket.Socket(Proxy)

MultiplexingSocket

public MultiplexingSocket(Socket socket)

Initializes a new MultiplexingSocket instance.

Parameters:

socket - delegate socket

MultiplexingSocket

protected MultiplexingSocket(SocketImpl impl)

Initializes a new MultiplexingSocket instance.

Parameters:

impl - not used

See Also:

Socket.Socket(SocketImpl)

MultiplexingSocket

public MultiplexingSocket(String host,
                          int port)

Initializes a new MultiplexingSocket instance.

Parameters:

host - not used

port - not used

See Also:

Socket.Socket(String, int)

MultiplexingSocket

public MultiplexingSocket(String host,
                          int port,
                          InetAddress localAddr,
                          int localPort)

Initializes a new MultiplexingSocket instance.

Parameters:

host - not used

port - not used

localAddr - not used

localPort - not used

See Also:

Socket.Socket(String, int, InetAddress, int)

Method Detail

close

void close(MultiplexedSocket multiplexed)

Closes a specific MultiplexedSocket which filters DatagramPackets away from this Socket.

Parameters:

multiplexed - the MultiplexedSocket to close

getInputStream

public InputStream getInputStream()
                           throws IOException

Overrides:

getInputStream in class DelegatingSocket

Throws:

IOException

getOriginalInputStream

public InputStream getOriginalInputStream()
                                   throws IOException

Get original InputStream.

Returns:

original InputStream

Throws:

IOException - if something goes wrong

getOriginalOutputStream

public OutputStream getOriginalOutputStream()
                                     throws IOException

Get original OutputStream.

Returns:

original OutputStream

Throws:

IOException - if something goes wrong

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Overrides:

getOutputStream in class DelegatingSocket

Throws:

IOException

getSocket

public MultiplexedSocket getSocket(DatagramPacketFilter filter)
                            throws SocketException

Gets a MultiplexedDatagramSocket which filters DatagramPackets away from this DatagramSocket using a specific DatagramPacketFilter. If such a MultiplexedDatagramSocket does not exist in this instance, it is created.

Parameters:

filter - the DatagramPacketFilter to get a MultiplexedDatagramSocket for

Returns:

a MultiplexedDatagramSocket which filters DatagramPackets away from this DatagramSocket using the specified filter

Throws:

SocketException - if creating the MultiplexedDatagramSocket for the specified filter fails

getSoTimeout

public int getSoTimeout()

Overrides:

getSoTimeout in class DelegatingSocket

multiplexingXXXSocketSupportDoReceive

private void multiplexingXXXSocketSupportDoReceive(DatagramPacket p)
                                            throws IOException

Implements MultiplexingXXXSocketSupport.doReceive(DatagramPacket) on behalf of multiplexingXXXSocketSupport. Receives a DatagramPacket from this socket.

Parameters:

p - the DatagramPacket into which to place the incoming data

Throws:

IOException - if an I/O error occurs

multiplexingXXXSocketSupportDoSetReceiveBufferSize

private void multiplexingXXXSocketSupportDoSetReceiveBufferSize(int receiveBufferSize)
                                                         throws SocketException

Implements MultiplexingXXXSocketSupport.doSetReceiveBufferSize(int) on behalf of multiplexingXXXSocketSupport. Sets the SO_RCVBUF option to the specified value for this DatagramSocket. The SO_RCVBUF option is used by the network implementation as a hint to size the underlying network I/O buffers. The SO_RCVBUF setting may also be used by the network implementation to determine the maximum size of the packet that can be received on this socket.

Parameters:

receiveBufferSize - the size to which to set the receive buffer size

Throws:

SocketException - if there is an error in the underlying protocol, such as a TCP error

receive

public void receive(DatagramPacket p)
             throws IOException

Receives a datagram packet from this socket. The DatagramPackets returned by this method do not match any of the DatagramPacketFilters of the MultiplexedDatagramSockets associated with this instance at the time of their receipt. When this method returns, the DatagramPacket's buffer is filled with the data received. The datagram packet also contains the sender's IP address, and the port number on the sender's machine.

This method blocks until a datagram is received. The length field of the datagram packet object contains the length of the received message. If the message is longer than the packet's length, the message is truncated.

Overrides:

receive in class DelegatingSocket

Parameters:

p - the DatagramPacket into which to place the incoming data

Throws:

IOException - if an I/O error occurs

See Also:

DelegatingSocket.receive(DatagramPacket)

receive

void receive(MultiplexedSocket multiplexed,
             DatagramPacket p)
      throws IOException

Receives a DatagramPacket from this Socket upon request from a specific MultiplexedSocket.

Parameters:

multiplexed - the MultiplexedSocket which requests the receipt of a DatagramPacket from the network

p - the DatagramPacket to receive the data from the network

Throws:

IOException - if an I/O error occurs

setSoTimeout

public void setSoTimeout(int timeout)
                  throws SocketException

Overrides:

setSoTimeout in class DelegatingSocket

Throws:

SocketException