Module com.aoapps.messaging.api

Package com.aoapps.messaging

Interface Socket

All Superinterfaces:

AutoCloseable, Closeable

public interface Socket
extends Closeable

One established connection.

Method Summary

Modifier and Type	Method	Description
void	addSocketListener(SocketListener listener, boolean synchronous)	See ConcurrentListenerManager.addListener(java.lang.Object, boolean).
void	close()	Closing a socket also removes it from its context.
Long	getCloseTime()	Gets the time this connection closed or null if still connected.
SocketAddress	getConnectRemoteSocketAddress()	Gets the remote address at connection time.
long	getConnectTime()	Gets the time this connection was established.
Identifier	getId()	Gets this socket's unique identifier.
String	getProtocol()	Gets the protocol, such as "http" or "tcp".
SocketAddress	getRemoteSocketAddress()	Gets the most recently seen remote address.
SocketContext	getSocketContext()	Gets the context this socket is running within.
boolean	isClosed()	Checks if this socket is closed.
boolean	removeSocketListener(SocketListener listener)	See ConcurrentListenerManager.removeListener(java.lang.Object).
void	sendMessage(Message message)	Sends a single message.
void	sendMessages(Collection<? extends Message> messages)	Sends a set of messages.
void	start(Callback<? super Socket> onStart, Callback<? super Throwable> onError)	Starts the I/O of a socket.

Method Details

getSocketContext

SocketContext getSocketContext()

Gets the context this socket is running within.

getId

Identifier getId()

Gets this socket's unique identifier. This identifier should remain secret as compromising an identifier may allow hijacking a connection. No two sockets will have the same identifier for a given context at the same time.

getConnectTime

long getConnectTime()

Gets the time this connection was established.

getCloseTime

Long getCloseTime()

Gets the time this connection closed or null if still connected.

getProtocol

String getProtocol()

Gets the protocol, such as "http" or "tcp".

getConnectRemoteSocketAddress

SocketAddress getConnectRemoteSocketAddress()

Gets the remote address at connection time. This value will not change.

getRemoteSocketAddress

SocketAddress getRemoteSocketAddress()

Gets the most recently seen remote address. This value may change.

start

void start(Callback<? super Socket> onStart,
 Callback<? super Throwable> onError)
    throws IllegalStateException

Starts the I/O of a socket. After connection, a socket does not send I/O events until started. This allows listeners to be registered between connect and start calls.

Throws:

IllegalStateException - if closed or already started

close

void close()
    throws IOException

Closing a socket also removes it from its context.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

isClosed

boolean isClosed()

Checks if this socket is closed.

addSocketListener

void addSocketListener(SocketListener listener,
 boolean synchronous)
                throws IllegalStateException

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

Throws:

IllegalStateException

removeSocketListener

boolean removeSocketListener(SocketListener listener)

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

sendMessage

void sendMessage(Message message)
          throws IllegalStateException

Sends a single message. This will never block.

Throws:

IllegalStateException - if this socket is closed

sendMessages

void sendMessages(Collection<? extends Message> messages)
           throws IllegalStateException

Sends a set of messages. This will never block. If messages is empty, the request is ignored.

Throws:

IllegalStateException - if this socket is closed