jsimple.net

Class SocketListener

java.lang.Object

jsimple.net.SocketListener

Direct Known Subclasses:

JavaTcpSocketListener

public abstract class SocketListener
extends java.lang.Object

Since:

7/24/13 11:07 PM

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SocketListener.SocketListenerFactory

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SocketListener(SocketConnectionHandler socketConnectionHandler, int port)

Method Summary

Modifier and Type	Method and Description
static SocketListener	createTcpSocketListener(SocketConnectionHandler socketConnectionHandler, int port) Create TCP SocketListener, using the global factory.
int	getPort() Get the port.
SocketConnectionHandler	getSocketConnectionHandler()
static void	setFactory(SocketListener.SocketListenerFactory socketListenerFactory) Set the global (default) factory used to create SocketListeners.
void	setPort(int port) Set the port, overriding what was previously set.
abstract void	start()
abstract void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

SocketListener

protected SocketListener(SocketConnectionHandler socketConnectionHandler,
                         int port)

Method Detail

createTcpSocketListener

public static SocketListener createTcpSocketListener(SocketConnectionHandler socketConnectionHandler,
                                                     int port)

Create TCP SocketListener, using the global factory. This method is the normal way to create a TPC SocketListener, using the default implementation appropriate for the current platform.

Parameters:

socketConnectionHandler - connection handler, to receive incoming connections

port - port number to listen on

Returns:

SocketListener

setFactory

public static void setFactory(@Nullable
                              SocketListener.SocketListenerFactory socketListenerFactory)

Set the global (default) factory used to create SocketListeners. Clients normally don't call this method directly and just call JSimpleIO.init at app startup instead, which sets the factory to the default implementation appropriate for the current platform.

Parameters:

socketListenerFactory - socket listener factory

getSocketConnectionHandler

public SocketConnectionHandler getSocketConnectionHandler()

getPort

public int getPort()

Get the port. The port only applies to TCP sockets.

Returns:

port number

setPort

public void setPort(int port)

Set the port, overriding what was previously set. The port only applies to socket types that have the concept of port, like TCP/UDP sockets. The port must be set before starting the listener; if changed, the listener must be stopped & restarted.

Parameters:

port - port number

start

public abstract void start()

stop

public abstract void stop()