ch.dermitza.securenio.socket

Class SocketContainer

java.lang.Object

ch.dermitza.securenio.socket.SocketContainer

public class SocketContainer
extends java.lang.Object

A container implementation containing SelectableChannel, SocketIF pairs. This container is used by the AbstractSelector to keep track of valid sockets. While it is used from a client implementation, it is most useful to a server implementation that deals with multiple connected sockets (clients).

This implementation is synchronized and thread-safe.

Since:

0.18

Constructor Summary

Constructors

Constructor and Description
SocketContainer()

Method Summary

Methods

Modifier and Type	Method and Description
void	addSocket(java.nio.channels.SelectableChannel key, SocketIF socket) Associates the specified SocketIF with the specified SelectableChannel in this map.
void	clear() Removes all SelectableChannel, SocketIF mappings from this map.
boolean	containsKey(java.nio.channels.SelectableChannel key) Returns true if this map contains a mapping for the specified SelectableChannel key.
SocketIF	getSocket(java.nio.channels.SelectableChannel key) Get the SocketIF that is paired to the given SelectableChannel key.
SocketIF	removeSocket(java.nio.channels.SelectableChannel key) Remove the SocketIF that is paired to the given SelectableChannel key.
int	size() Returns the number of SelectableChannel, SocketIF mappings in this map.

Methods inherited from class java.lang.Object

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

Constructor Detail

SocketContainer

public SocketContainer()

Method Detail

getSocket

public SocketIF getSocket(java.nio.channels.SelectableChannel key)

Get the SocketIF that is paired to the given SelectableChannel key.

Parameters:

key - the SelectableChannel key whose associated value is to be returned

Returns:

the SocketIF to which the specified SelectableChannel is mapped, or null if this map contains no mapping for the SelectableChannel.

containsKey

public boolean containsKey(java.nio.channels.SelectableChannel key)

Returns true if this map contains a mapping for the specified SelectableChannel key.

Parameters:

key - SelectableChannel key whose presence in this map is to be tested

Returns:

true if this map contains a SocketIF mapping for the specified SelectableChannel key

addSocket

public void addSocket(java.nio.channels.SelectableChannel key,
             SocketIF socket)

Associates the specified SocketIF with the specified SelectableChannel in this map. If the map previously contained a mapping for the SelectableChannel, the old SocketIF is replaced by the specified SocketIF.

Parameters:

key - the SelectableChannel key with which the specified value is to be associated

socket - SocketIF to be associated with the specified key

removeSocket

public SocketIF removeSocket(java.nio.channels.SelectableChannel key)

Remove the SocketIF that is paired to the given SelectableChannel key.

Parameters:

key - the SelectableChannel key whose associated value is to be removed from the map

Returns:

the previous SocketIF associated with SelectableChannel is mapped, or null if there was no mapping for SelectableChannel.

clear

public void clear()

Removes all SelectableChannel, SocketIF mappings from this map. The map will be empty after this call returns.

size

public int size()

Returns the number of SelectableChannel, SocketIF mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:

the number of SelectableChannel, SocketIF mappings in this map