Module com.aoapps.messaging.base

Package com.aoapps.messaging.base

Class AbstractSocketContext<S extends AbstractSocket>

java.lang.Object

com.aoapps.messaging.base.AbstractSocketContext<S>

All Implemented Interfaces:

SocketContext, Closeable, AutoCloseable

public abstract class AbstractSocketContext<S extends AbstractSocket>
extends Object
implements SocketContext

Base implementation of socket context.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static interface	AbstractSocketContext.IdentifierAvailabilityChecker	Something that can check the availability of a session ID, to skip used session IDs when creating new sessions.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSocketContext()	Creates a new AbstractSocketContext.

Method Summary

Modifier and Type	Method	Description
protected void	addIdentifierAvailabilityChecker(AbstractSocketContext.IdentifierAvailabilityChecker idChecker)	Adds a AbstractSocketContext.IdentifierAvailabilityChecker.
protected void	addSocket(S newSocket)	Adds a new socket to this context, sockets must be added to the context before they create any of their own events.
void	addSocketContextListener(SocketContextListener listener, boolean synchronous)
protected Future<?>	callOnError(Throwable t)	When an error as occurred, call this to distribute to all of the listeners.
void	close()	Any overriding implementation must call super.close() first.
S	getSocket(Identifier id)
Map<Identifier,S>	getSockets()
boolean	isClosed()
protected Identifier	newIdentifier()	Creates a random identifier that is not in the current set of sockets.
protected void	removeIdentifierAvailabilityChecker(AbstractSocketContext.IdentifierAvailabilityChecker idChecker)	Removes a AbstractSocketContext.IdentifierAvailabilityChecker.
boolean	removeSocketContextListener(SocketContextListener listener)

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractSocketContext

protected AbstractSocketContext()

Creates a new AbstractSocketContext.

Method Details

getSockets

public Map<Identifier,S> getSockets()

Specified by:

getSockets in interface SocketContext

getSocket

public S getSocket(Identifier id)

Specified by:

getSocket in interface SocketContext

addIdentifierAvailabilityChecker

protected void addIdentifierAvailabilityChecker(AbstractSocketContext.IdentifierAvailabilityChecker idChecker)

Adds a AbstractSocketContext.IdentifierAvailabilityChecker.

removeIdentifierAvailabilityChecker

protected void removeIdentifierAvailabilityChecker(AbstractSocketContext.IdentifierAvailabilityChecker idChecker)

Removes a AbstractSocketContext.IdentifierAvailabilityChecker.

newIdentifier

protected Identifier newIdentifier()

Creates a random identifier that is not in the current set of sockets.

The identifier is checked against any registered AbstractSocketContext.IdentifierAvailabilityChecker.

See Also:

• addIdentifierAvailabilityChecker(com.aoapps.messaging.base.AbstractSocketContext.IdentifierAvailabilityChecker)

close

public void close()

Any overriding implementation must call super.close() first.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface SocketContext

isClosed

public boolean isClosed()

Specified by:

isClosed in interface SocketContext

addSocketContextListener

public void addSocketContextListener(SocketContextListener listener,
 boolean synchronous)
                              throws IllegalStateException

Specified by:

addSocketContextListener in interface SocketContext

Throws:

IllegalStateException

removeSocketContextListener

public boolean removeSocketContextListener(SocketContextListener listener)

Specified by:

removeSocketContextListener in interface SocketContext

addSocket

protected void addSocket(S newSocket)

Adds a new socket to this context, sockets must be added to the context before they create any of their own events. This gives context listeners a chance to register per-socket listeners in "onNewSocket".

1. First, adds to the list of sockets.
2. Second, calls all listeners notifying them of new socket.
3. Third, waits for all listeners to handle the event before returning.

callOnError

protected Future<?> callOnError(Throwable t)
                         throws IllegalStateException

When an error as occurred, call this to distribute to all of the listeners. If need to wait until all of the listeners have handled the error, can call Future.get() or Future.isDone().

Throws:

IllegalStateException - if this socket is closed