Package org.dellroad.stuff.net

Class PersistentSocketConnection

java.lang.Object

org.dellroad.stuff.net.PersistentConnection<Socket>

org.dellroad.stuff.net.PersistentSocketConnection

public abstract class PersistentSocketConnection
extends PersistentConnection<Socket>

Maintains a persistent Socket connection to a remote server, automatically reconnecting when the connection fails.

Subclasses need only override handleConnection().

Field Summary

Fields inherited from class org.dellroad.stuff.net.PersistentConnection

DEFAULT_MAX_RESTART_DELAY, DEFAULT_MIN_RESTART_DELAY, log

Constructor Summary

Constructors

Constructor	Description
PersistentSocketConnection()

Method Summary

Modifier and Type	Method	Description
protected void	cleanupConnection(Socket socket)	Perform cleanup after a server connection ends.
protected Socket	createConnection()	Create a new server connection.
protected Socket	createSocket()	Create the Socket to use for a new connection.
SocketAddress	getServerAddress()	Get the address to which this instance should connect.
void	setServerAddress(SocketAddress serverAddress)	Configure the address to which this instance should connect.
void	start()	Start this instance.

Methods inherited from class org.dellroad.stuff.net.PersistentConnection

connectionEnded, connectionFailed, connectionSuccessful, getMaxRestartDelay, getMinRestartDelay, getThreadName, handleConnection, isRunning, setMaxRestartDelay, setMinRestartDelay, started, stop, stopped

Methods inherited from class java.lang.Object

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

Constructor Details

PersistentSocketConnection

public PersistentSocketConnection()

Method Details

getServerAddress

public SocketAddress getServerAddress()

Get the address to which this instance should connect.

Returns:

remote server address

setServerAddress

public void setServerAddress(SocketAddress serverAddress)

Configure the address to which this instance should connect.

Required property.

Parameters:

serverAddress - remote server address

start

public void start()

Description copied from class: PersistentConnection

Start this instance. This starts the background thread, which initiates the first connection attempt.

If this instance is already started, nothing happens.

Overrides:

start in class PersistentConnection<Socket>

createConnection

protected Socket createConnection()
                           throws InterruptedException,
IOException

Create a new server connection.

The implementation in PersistentSocketConnection creates a socket via createSocket() and connects the socket to the configured server.

Specified by:

createConnection in class PersistentConnection<Socket>

Returns:

connected socket

Throws:

IOException - if the connection attempt fails

InterruptedException - if the current thread is interrupted

cleanupConnection

protected void cleanupConnection(Socket socket)

Perform cleanup after a server connection ends.

The implementation in PersistentSocketConnection ensures the socket is closed.

Overrides:

cleanupConnection in class PersistentConnection<Socket>

Parameters:

socket - socket returned from createConnection() when this connection was created

createSocket

protected Socket createSocket()
                       throws IOException

Create the Socket to use for a new connection. The socket should not be connected yet.

The implementation in PersistentSocketConnection creates a normal Socket and sets the keep-alive flag to ensure connection failures are detected promptly. Subclasses may override to configure the socket differently.

Returns:

new socket

Throws:

IOException - if socket creation fails