Module com.aoapps.messaging.base

Package com.aoapps.messaging.base

Class AbstractSocket

java.lang.Object

com.aoapps.messaging.base.AbstractSocket

All Implemented Interfaces:

Socket, Closeable, AutoCloseable

public abstract class AbstractSocket
extends Object
implements Socket

Base implementation of socket.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSocket(AbstractSocketContext<? extends AbstractSocket> socketContext, Identifier id, long connectTime, SocketAddress remoteSocketAddress)

Method Summary

Modifier and Type	Method	Description
void	addSocketListener(SocketListener listener, boolean synchronous)
protected Future<?>	callOnError(Throwable t)	When an error as occurred, call this to distribute to all of the listeners.
protected Future<?>	callOnMessages(List<? extends Message> messages)	When one or more new messages have arrived, call this to distribute to all of the listeners.
void	close()	Any overriding implementation must call super.close() first.
Long	getCloseTime()
SocketAddress	getConnectRemoteSocketAddress()
long	getConnectTime()
Identifier	getId()
abstract String	getProtocol()
SocketAddress	getRemoteSocketAddress()
AbstractSocketContext<? extends AbstractSocket>	getSocketContext()
boolean	isClosed()
boolean	removeSocketListener(SocketListener listener)
void	sendMessage(Message message)
void	sendMessages(Collection<? extends Message> messages)
protected abstract void	sendMessagesImpl(Collection<? extends Message> messages)	Implementation to actually enqueue and send messages.
protected void	setRemoteSocketAddress(SocketAddress newRemoteSocketAddress)	Sets the most recently seen remote address.
void	start(Callback<? super Socket> onStart, Callback<? super Throwable> onError)	Makes sure the socket is not already closed then calls startImpl.
protected abstract void	startImpl(Callback<? super Socket> onStart, Callback<? super Throwable> onError)	Called once the socket is confirmed to not be closed.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractSocket

protected AbstractSocket(AbstractSocketContext<? extends AbstractSocket> socketContext,
 Identifier id,
 long connectTime,
 SocketAddress remoteSocketAddress)

Method Details

toString

public String toString()

Overrides:

toString in class Object

getSocketContext

public AbstractSocketContext<? extends AbstractSocket> getSocketContext()

Specified by:

getSocketContext in interface Socket

getId

public Identifier getId()

Specified by:

getId in interface Socket

getConnectTime

public long getConnectTime()

Specified by:

getConnectTime in interface Socket

getCloseTime

public Long getCloseTime()

Specified by:

getCloseTime in interface Socket

getConnectRemoteSocketAddress

public SocketAddress getConnectRemoteSocketAddress()

Specified by:

getConnectRemoteSocketAddress in interface Socket

getRemoteSocketAddress

public SocketAddress getRemoteSocketAddress()

Specified by:

getRemoteSocketAddress in interface Socket

setRemoteSocketAddress

protected void setRemoteSocketAddress(SocketAddress newRemoteSocketAddress)

Sets the most recently seen remote address. If the provided value is different than the previous, will notify all listeners.

start

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

Makes sure the socket is not already closed then calls startImpl.

Specified by:

start in interface Socket

Throws:

IllegalStateException

See Also:

• startImpl(com.aoapps.concurrent.Callback, com.aoapps.concurrent.Callback)

close

public void close()
           throws IOException

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 Socket

Throws:

IOException

isClosed

public boolean isClosed()

Specified by:

isClosed in interface Socket

addSocketListener

public void addSocketListener(SocketListener listener,
 boolean synchronous)
                       throws IllegalStateException

Specified by:

addSocketListener in interface Socket

Throws:

IllegalStateException

removeSocketListener

public boolean removeSocketListener(SocketListener listener)

Specified by:

removeSocketListener in interface Socket

callOnMessages

protected Future<?> callOnMessages(List<? extends Message> messages)
                            throws IllegalStateException

When one or more new messages have arrived, call this to distribute to all of the listeners. If need to wait until all of the listeners have handled the messages, can call Future.get() or Future.isDone().

Throws:

IllegalStateException - if this socket is closed

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

sendMessage

public void sendMessage(Message message)
                 throws IllegalStateException

Specified by:

sendMessage in interface Socket

Throws:

IllegalStateException

sendMessages

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

Specified by:

sendMessages in interface Socket

Throws:

IllegalStateException

getProtocol

public abstract String getProtocol()

Specified by:

getProtocol in interface Socket

startImpl

protected abstract void startImpl(Callback<? super Socket> onStart,
 Callback<? super Throwable> onError)
                           throws IllegalStateException

Called once the socket is confirmed to not be closed.

Throws:

IllegalStateException - if already started

See Also:

• start(com.aoapps.concurrent.Callback, com.aoapps.concurrent.Callback)

sendMessagesImpl

protected abstract void sendMessagesImpl(Collection<? extends Message> messages)

Implementation to actually enqueue and send messages. This must never block.