biz.onixs.util.network

Interface SocketConnector

All Superinterfaces:

AutoCloseable

public interface SocketConnector
extends AutoCloseable

The interface provides methods for creating socket connections.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SocketConnector.ErrorReason An enum that defines reasons for socket connecting errors.
static interface	SocketConnector.Listener The interface represents a listener for handling connect events.

Field Summary

Fields

Modifier and Type	Field and Description
static SocketConnector.Listener	NULL_LISTENER This field represents a dummy implementation of the SocketConnector.Listener interface.

Method Summary

Modifier and Type	Method and Description
Socket	connect() Synchronous connection attempt.
void	connectAfterInterval(long interval, TimeUnit timeUnit) Initiates a connection attempt after a specified interval.
void	connectAsync() Initiates an asynchronous connection attempt.
String	getHost() Returns the hostname or IP address to connect.
int	getPort() Returns the port number to connect.
void	setListener(SocketConnector.Listener listener) Sets the listener for this socket connector.
void	stopConnectAfterInterval() Stops a previously scheduled connection attempt via connectAfterInterval(long, TimeUnit).

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

NULL_LISTENER

static final SocketConnector.Listener NULL_LISTENER

This field represents a dummy implementation of the SocketConnector.Listener interface.

Method Detail

getHost

String getHost()

Returns the hostname or IP address to connect.

Returns:

the hostname or IP address to connect

getPort

int getPort()

Returns the port number to connect.

Returns:

the port number to connect

setListener

void setListener(SocketConnector.Listener listener)

Sets the listener for this socket connector.

Parameters:

listener - the listener to use for connection events

connect

Socket connect()
        throws IOException

Synchronous connection attempt.

Returns:

connected socket.

Throws:

IOException - if an error occurs during the binding/connection.

connectAsync

void connectAsync()

Initiates an asynchronous connection attempt.

connectAfterInterval

void connectAfterInterval(long interval,
                          TimeUnit timeUnit)

Initiates a connection attempt after a specified interval.

Parameters:

interval - the length of the interval

timeUnit - the time unit for the interval

stopConnectAfterInterval

void stopConnectAfterInterval()

Stops a previously scheduled connection attempt via connectAfterInterval(long, TimeUnit).