com.maverick.nio

Class Daemon

java.lang.Object

com.maverick.nio.Daemon

Direct Known Subclasses:

VirtualSSHD

public abstract class Daemon
extends Object

This class provides an abstract daemon for servicing any number of protocol contexts.

Author:

Lee David Painter

Field Summary

Fields

Modifier and Type	Field and Description
protected static char[]	hexArray

Constructor Summary

Constructors

Constructor and Description
Daemon() Constructs the Daemon.

Method Summary

Modifier and Type	Method and Description
void	addListener(DaemonListener listener)
void	addShutdownHook(Runnable r)
protected abstract void	configure(DaemonContext context) Called before the server is started so that you can configure the server to your own requirements.
DaemonContext	getContext() Get the context for this Daemon.
List<DaemonListener>	getDaemonListeners()
Throwable	getLastError() If startup failed get the last error.
static Date	getReleaseDate() Returns the release date of the current version.
static String	getVersion() Returns the current version of the API.
boolean	isStarted() Get whether the daemon is currently started
boolean	isStarting()
void	registerAcceptor(ClientAcceptor acceptor, ServerSocketChannel socketChannel) Register a client acceptor with the daemon.
void	registerConnector(ClientConnector connector, SocketChannel socketChannel) Register a client connector with the daemon.
void	registerHandler(SocketHandler handler, SelectableChannel channel)
void	registerHandler(SocketHandler handler, SelectableChannel channel, ProtocolEngine engine) Register a socket handler with the daemon.
void	registerHandler(SocketHandler handler, SelectableChannel channel, SelectorThread thread)
void	registerHandler(SocketHandler handler, SelectableChannel channel, SelectorThread thread, ProtocolEngine engine) Register a socket handler with the daemon.
void	removeAcceptor(ListeningInterface li)
void	removeListener(DaemonListener listener)
void	restart()
void	restart(boolean graceful, long forceAfterMs)
void	shutdownAsync(boolean graceful, long forceAfterMs) Shutdown the server.
void	shutdownNow(boolean graceful, long forceAfterMs) This method should be used to shutdown the server from your main thread.
boolean	startAcceptingConnections(boolean propagateErrors)
protected boolean	startListeningInterface(ListeningInterface li, boolean propagateErrors)
boolean	startup() Starts the daemon, first calling the #configure(ConfigurationContext) method to allow your server to configure itself.
boolean	startup(boolean propagateErrors) Starts the daemon, first calling the #configure(ConfigurationContext) method to allow your server to configure itself.
void	stopAcceptingConnections()

Methods inherited from class java.lang.Object

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

Field Detail

hexArray

protected static final char[] hexArray

Constructor Detail

Daemon

public Daemon()

Constructs the Daemon.

Method Detail

getContext

public DaemonContext getContext()

Get the context for this Daemon.

Returns:

DaemonContext

getVersion

public static String getVersion()

Returns the current version of the API.

getReleaseDate

public static Date getReleaseDate()

Returns the release date of the current version.

isStarting

public boolean isStarting()

addShutdownHook

public void addShutdownHook(Runnable r)

startup

public boolean startup()
                throws IOException

Starts the daemon, first calling the #configure(ConfigurationContext) method to allow your server to configure itself.

Returns:

true if at least one interface started, otherwise false.

Throws:

IOException

startup

public boolean startup(boolean propagateErrors)
                throws IOException

Starts the daemon, first calling the #configure(ConfigurationContext) method to allow your server to configure itself.

Parameters:

propagate - Do not consume errors.

Returns:

true if at least one interface started, otherwise false.

Throws:

IOException

startAcceptingConnections

public boolean startAcceptingConnections(boolean propagateErrors)
                                  throws IOException

Throws:

IOException

getLastError

public Throwable getLastError()

If startup failed get the last error.

Returns:

startListeningInterface

protected boolean startListeningInterface(ListeningInterface li,
                                          boolean propagateErrors)
                                   throws IOException

Throws:

IOException

removeAcceptor

public void removeAcceptor(ListeningInterface li)

isStarted

public boolean isStarted()

Get whether the daemon is currently started

Returns:

started

shutdownAsync

public void shutdownAsync(boolean graceful,
                          long forceAfterMs)

Shutdown the server. This does not exit the JVM

shutdownNow

public void shutdownNow(boolean graceful,
                        long forceAfterMs)

This method should be used to shutdown the server from your main thread. If you need to shutdown the server from within a session that is running on a transfer thread use shutdownAsync().

stopAcceptingConnections

public void stopAcceptingConnections()

restart

public void restart()
             throws IOException

Throws:

IOException

restart

public void restart(boolean graceful,
                    long forceAfterMs)
             throws IOException

Throws:

IOException

registerConnector

public void registerConnector(ClientConnector connector,
                              SocketChannel socketChannel)
                       throws IOException

Register a client connector with the daemon.

Parameters:

connector - ClientConnector

socketChannel - SocketChannel

Throws:

IOException

registerAcceptor

public void registerAcceptor(ClientAcceptor acceptor,
                             ServerSocketChannel socketChannel)
                      throws IOException

Register a client acceptor with the daemon.

Parameters:

acceptor - ClientAcceptor

socketChannel - ServerSocketChannel

Throws:

IOException

registerHandler

public void registerHandler(SocketHandler handler,
                            SelectableChannel channel,
                            ProtocolEngine engine)
                     throws IOException

Register a socket handler with the daemon.

Parameters:

handler - SocketHandler

channel - SelectableChannel

Throws:

IOException

registerHandler

public void registerHandler(SocketHandler handler,
                            SelectableChannel channel)
                     throws IOException

Throws:

IOException

registerHandler

public void registerHandler(SocketHandler handler,
                            SelectableChannel channel,
                            SelectorThread thread,
                            ProtocolEngine engine)
                     throws IOException

Register a socket handler with the daemon.

Parameters:

handler - SocketHandler

channel - SelectableChannel

thread - SelectorThread

Throws:

IOException

registerHandler

public void registerHandler(SocketHandler handler,
                            SelectableChannel channel,
                            SelectorThread thread)
                     throws IOException

Throws:

IOException

configure

protected abstract void configure(DaemonContext context)
                           throws IOException,
                                  SshException

Called before the server is started so that you can configure the server to your own requirements.

Parameters:

context -

Throws:

IOException

SshException

getDaemonListeners

public List<DaemonListener> getDaemonListeners()

addListener

public void addListener(DaemonListener listener)

removeListener

public void removeListener(DaemonListener listener)