Module com.aoapps.messaging.api

Package com.aoapps.messaging

Interface SocketContext

All Superinterfaces:

AutoCloseable, Closeable

public interface SocketContext
extends Closeable

Each socket, regardless or protocol and whether client or server, has a context.

Method Summary

Modifier and Type	Method	Description
void	addSocketContextListener(SocketContextListener listener, boolean synchronous)	See ConcurrentListenerManager.addListener(java.lang.Object, boolean).
void	close()	Closes this context.
Socket	getSocket(Identifier id)	Gets the socket of the given ID or null if not found.
Map<Identifier,? extends Socket>	getSockets()	Gets a snapshot of all active sockets.
boolean	isClosed()	Checks if this context is closed.
boolean	removeSocketContextListener(SocketContextListener listener)	See ConcurrentListenerManager.removeListener(java.lang.Object).

Method Details

getSockets

Map<Identifier,? extends Socket> getSockets()

Gets a snapshot of all active sockets. If context is closed will be an empty map.

getSocket

Socket getSocket(Identifier id)

Gets the socket of the given ID or null if not found.

close

void close()
    throws IOException

Closes this context. When the context is closed, all active sockets are closed and all related persistent resources are freed.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

isClosed

boolean isClosed()

Checks if this context is closed.

addSocketContextListener

void addSocketContextListener(SocketContextListener listener,
 boolean synchronous)

See ConcurrentListenerManager.addListener(java.lang.Object, boolean).

removeSocketContextListener

boolean removeSocketContextListener(SocketContextListener listener)

See ConcurrentListenerManager.removeListener(java.lang.Object).