org.ice4j.socket

Class MultiplexingXXXSocketSupport<MultiplexedXXXSocketT extends MultiplexedXXXSocket>

java.lang.Object

org.ice4j.socket.MultiplexingXXXSocketSupport<MultiplexedXXXSocketT>

abstract class MultiplexingXXXSocketSupport<MultiplexedXXXSocketT extends MultiplexedXXXSocket>
extends Object

Implements functionality common to TCP and UDP implementations of (de)multiplexing sockets i.e. sockets which provide DatagramPacket-based views of the packets they receive in the forms of pseudo sockets.

Author:

Lyubomir Marinov

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	inReceive The indicator which determines whether this DatagramSocket is currently reading from the network using DatagramSocket.receive(DatagramPacket).
private static Logger	logger The Logger used by the MultiplexingXXXSocketSupport class and its instances for logging output.
private int	receiveBufferSize The value with which DatagramSocket.setReceiveBufferSize(int) is to be invoked if setReceiveBufferSize is true.
private Object	receiveSyncRoot The Object which synchronizes the access to inReceive.
private boolean	setReceiveBufferSize The indicator which determines whether DatagramSocket.setReceiveBufferSize(int) is to be invoked with the value of receiveBufferSize.
private List<MultiplexedXXXSocketT>	sockets The IP sockets filtering DatagramPackets away from this IP socket.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MultiplexingXXXSocketSupport() Initializes a new MultiplexingXXXSocketSupport instance.

Method Summary

Modifier and Type	Method and Description
private void	acceptBySocketsOrThis(DatagramPacket p) Accepts a DatagramPacket received by this socket and queues it for receipt through either this multiplexing socket or its multiplexed sockets whose DatagramPacketFilters accept p.
static DatagramPacket	clone(DatagramPacket p) Initializes a new DatagramPacket instance which is a clone of a specific DatagramPacket i.e.
private static DatagramPacket	clone(DatagramPacket p, boolean arraycopy) Initializes a new DatagramPacket instance which is a clone of a specific DatagramPacket i.e.
(package private) boolean	close(MultiplexedXXXSocketT multiplexed) Closes a specific MultiplexedDatagramSocket which filters DatagramPackets away from this DatagramSocket.
static void	copy(DatagramPacket src, DatagramPacket dest) Copies the properties of a specific DatagramPacket to another DatagramPacket.
protected abstract MultiplexedXXXSocketT	createSocket(DatagramPacketFilter filter) Initializes a new multiplexed socket instance which is to be associated with a specific DatagramPacketFilter.
protected abstract void	doReceive(DatagramPacket p) Receives a DatagramPacket from this socket.
protected abstract void	doSetReceiveBufferSize(int receiveBufferSize) Sets the SO_RCVBUF option to the specified value for this DatagramSocket.
protected DatagramPacketFilter	getFilter(MultiplexedXXXSocketT socket) Gets the DatagramPacketFilter associated with a specific multiplexed socket.
protected abstract List<DatagramPacket>	getReceived() Gets the list of DatagramPackets received by this socket and not accepted by any (existing) DatagramPacketFilter at the time of receipt.
protected abstract List<DatagramPacket>	getReceived(MultiplexedXXXSocketT socket) Gets the list of DatagramPackets received by this multiplexing socket and accepted by the DatagramPacketFilter of a specific multiplexed socket at the time of receipt.
MultiplexedXXXSocketT	getSocket(DatagramPacketFilter filter) Gets a MultiplexedDatagramSocket which filters DatagramPackets away from this DatagramSocket using a specific DatagramPacketFilter.
MultiplexedXXXSocketT	getSocket(DatagramPacketFilter filter, boolean create) Gets a MultiplexedDatagramSocket which filters DatagramPackets away from this DatagramSocket using a specific DatagramPacketFilter.
private void	moveReceivedFromThisToSocket(MultiplexedXXXSocketT socket) Moves packets which have been received from this multiplexing socket to a specific multiplexed socket if they are accepted by the DatagramPacketFilter of the latter.
(package private) void	receive(List<DatagramPacket> received, DatagramPacket p, int timeout) Receives a DatagramPacket from a specific list of DatagramPackets if it is not empty or from the network if the specified list is empty.
void	setReceiveBufferSize(int receiveBufferSize) Sets the SO_RCVBUF option to the specified value for this socket.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final Logger logger

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

inReceive

private boolean inReceive

The indicator which determines whether this DatagramSocket is currently reading from the network using DatagramSocket.receive(DatagramPacket). When true, subsequent requests to read from the network will be blocked until the current read is finished.

receiveBufferSize

private int receiveBufferSize

The value with which DatagramSocket.setReceiveBufferSize(int) is to be invoked if setReceiveBufferSize is true.

receiveSyncRoot

private final Object receiveSyncRoot

The Object which synchronizes the access to inReceive.

setReceiveBufferSize

private boolean setReceiveBufferSize

The indicator which determines whether DatagramSocket.setReceiveBufferSize(int) is to be invoked with the value of receiveBufferSize.

sockets

private final List<MultiplexedXXXSocketT extends MultiplexedXXXSocket> sockets

The IP sockets filtering DatagramPackets away from this IP socket.

Constructor Detail

MultiplexingXXXSocketSupport

protected MultiplexingXXXSocketSupport()

Initializes a new MultiplexingXXXSocketSupport instance.

Method Detail

clone

public static DatagramPacket clone(DatagramPacket p)

Initializes a new DatagramPacket instance which is a clone of a specific DatagramPacket i.e. the properties of the clone DatagramPacket are clones of the specified DatagramPacket.

Parameters:

p - the DatagramPacket to clone

Returns:

a new DatagramPacket instance which is a clone of the specified DatagramPacket

clone

private static DatagramPacket clone(DatagramPacket p,
                                    boolean arraycopy)

Initializes a new DatagramPacket instance which is a clone of a specific DatagramPacket i.e. the properties of the clone DatagramPacket are clones of the specified DatagramPacket.

Parameters:

p - the DatagramPacket to clone

arraycopy - true if the actual bytes of the data of p are to be copied into the clone or false if only the capacity of the data of p is to be cloned without copying the actual bytes of the data of p

Returns:

a new DatagramPacket instance which is a clone of the specified DatagramPacket

copy

public static void copy(DatagramPacket src,
                        DatagramPacket dest)

Copies the properties of a specific DatagramPacket to another DatagramPacket. The property values are not cloned.

Parameters:

src - the DatagramPacket which is to have its properties copied to dest

dest - the DatagramPacket which is to have its properties set to the value of the respective properties of src

acceptBySocketsOrThis

private void acceptBySocketsOrThis(DatagramPacket p)

Accepts a DatagramPacket received by this socket and queues it for receipt through either this multiplexing socket or its multiplexed sockets whose DatagramPacketFilters accept p.

Parameters:

p - the DatagramPacket to be accepted by either this multiplexing socket or its multiplexed sockets whose DatagramPacketFilters accept p

close

boolean close(MultiplexedXXXSocketT multiplexed)

Closes a specific MultiplexedDatagramSocket which filters DatagramPackets away from this DatagramSocket.

Parameters:

multiplexed - the MultiplexedDatagramSocket to close

Returns:

true if there are remaining filtered sockets.

createSocket

protected abstract MultiplexedXXXSocketT createSocket(DatagramPacketFilter filter)
                                               throws SocketException

Initializes a new multiplexed socket instance which is to be associated with a specific DatagramPacketFilter.

Parameters:

filter - the DatagramPacketFilter to associate with the new instance

Returns:

a new multiplexed socket associated with the specified filter

Throws:

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

doReceive

protected abstract void doReceive(DatagramPacket p)
                           throws IOException

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

doSetReceiveBufferSize

protected abstract void doSetReceiveBufferSize(int receiveBufferSize)
                                        throws SocketException

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 UDP error

getFilter

protected DatagramPacketFilter getFilter(MultiplexedXXXSocketT socket)

Gets the DatagramPacketFilter associated with a specific multiplexed socket.

Parameters:

socket - the multiplexed socket whose associated DatagramPacketFilter is to be retrieved

Returns:

the DatagramPacketFilter associated with socket

getReceived

protected abstract List<DatagramPacket> getReceived()

Gets the list of DatagramPackets received by this socket and not accepted by any (existing) DatagramPacketFilter at the time of receipt.

Returns:

the list of DatagramPackets received by this socket and not accepted by any (existing) DatagramPacketFilter at the time of receipt

getReceived

protected abstract List<DatagramPacket> getReceived(MultiplexedXXXSocketT socket)

Gets the list of DatagramPackets received by this multiplexing socket and accepted by the DatagramPacketFilter of a specific multiplexed socket at the time of receipt.

Parameters:

socket - the multiplexed socket whose list of accepted received DatagramPackets is to be returned

Returns:

the list of DatagramPackets received by this multiplexing socket and accepted by the DatagramPacketFilter of the multiplexed socket at the time of receipt

getSocket

public MultiplexedXXXSocketT 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

getSocket

public MultiplexedXXXSocketT getSocket(DatagramPacketFilter filter,
                                       boolean create)
                                throws SocketException

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

Parameters:

filter - the DatagramPacketFilter to get a MultiplexedDatagramSocket for

create - whether or not to create a MultiplexedDatagramSocket if this instance does not already have a socket for the given filter.

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.

moveReceivedFromThisToSocket

private void moveReceivedFromThisToSocket(MultiplexedXXXSocketT socket)

Moves packets which have been received from this multiplexing socket to a specific multiplexed socket if they are accepted by the DatagramPacketFilter of the latter.

Parameters:

socket - the multiplexed socket into which received packets are to be moved from this multiplexing socket if they are accepted by the DatagramPacketFilter of the former

receive

void receive(List<DatagramPacket> received,
             DatagramPacket p,
             int timeout)
      throws IOException

Receives a DatagramPacket from a specific list of DatagramPackets if it is not empty or from the network if the specified list is empty. 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.

Parameters:

received - the list of previously received DatagramPacket from which the first is to be removed and returned if available

p - the DatagramPacket into which to place the incoming data

timeout - the maximum time in milliseconds to wait for a packet. A timeout of zero is interpreted as an infinite timeout

Throws:

IOException - if an I/O error occurs

SocketTimeoutException - if timeout is positive and has expired

setReceiveBufferSize

public void setReceiveBufferSize(int receiveBufferSize)
                          throws SocketException

Sets the SO_RCVBUF option to the specified value for this socket. 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 or UDP error