A B C D E F G I K L O P R S T W

A

add(ByteBuffer) - Method in class com.maverick.nio.ByteBufferPool

Add a buffer back to the pool.

addEventListener(EventListener) - Static method in class com.maverick.nio.DaemonContext

addEventListener(String, EventListener) - Static method in class com.maverick.nio.DaemonContext

addEventListener(EventListener) - Static method in class com.maverick.nio.DaemonContext

addListeningInterface(String, int, ProtocolContextFactory) - Method in class com.maverick.nio.DaemonContext

Add an interface and port to the listening socket list and provide the protocol context.

addListeningInterface(InetAddress, int, ProtocolContextFactory) - Method in class com.maverick.nio.DaemonContext

Add an interface and port to the listening socket list and provide the protocol context.

addSelectorOperation(Runnable) - Method in class com.maverick.nio.SelectorThread

Add an operation to the selector.

ATTRIBUTE_IP - Static variable in class com.maverick.nio.EventCodes

ATTRIBUTE_LOG_MESSAGE - Static variable in class com.maverick.nio.EventCodes

This attribute is the key for the log message previously passes to log.info()/log.debug() calls

ATTRIBUTE_THROWABLE - Static variable in class com.maverick.nio.EventCodes

This attribute is the key for the throwable object previously passed in some log.info() calls.

B

BY_APPLICATION - Static variable in interface com.maverick.nio.ProtocolEngine

Disconnect reason: The application disconnected

ByteBufferPool - Class in com.maverick.nio

This class provides a pool for either direct or non direct ByteBuffers.

ByteBufferPool() - Constructor for class com.maverick.nio.ByteBufferPool

Create a default pool of ByteBuffers with 4k capacity

ByteBufferPool(int, boolean) - Constructor for class com.maverick.nio.ByteBufferPool

Create a pool of ByteBuffers.

C

ClientAcceptor - Class in com.maverick.nio

An abstract class for the NIO framework to accept client connections.

ClientAcceptor(ProtocolContextFactory) - Constructor for class com.maverick.nio.ClientAcceptor

Construct an acceptor with a protocol context.

ClientConnector - Interface in com.maverick.nio

An interface for the NIO framework to connect outgoing sockets.

clone() - Method in class com.maverick.nio.ProtocolContext

closeConnection() - Method in class com.maverick.nio.SocketConnection

Close this socket connection.

closed - Variable in class com.maverick.nio.SocketConnection

com.maverick.nio - package com.maverick.nio

This package contains a generic framework for Java NIO daemons.

completedWrite() - Method in interface com.maverick.nio.SocketWriteCallback

configure(DaemonContext) - Method in class com.maverick.nio.Daemon

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

createConnection(Daemon) - Method in class com.maverick.nio.ProtocolContext

Create a socket handler for this protocol.

createConnectionImpl() - Method in class com.maverick.nio.ProtocolContext

Creates a socket handler from the configured implementation class.

createContext(InetAddress, InetAddress) - Method in interface com.maverick.nio.ProtocolContextFactory

createEngine() - Method in class com.maverick.nio.ProtocolContext

Create a protocol engine.

D

Daemon - Class in com.maverick.nio

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

Daemon() - Constructor for class com.maverick.nio.Daemon

Constructs the Daemon.

daemon - Variable in class com.maverick.nio.SocketConnection

DaemonContext - Class in com.maverick.nio

Each instance of a Daemon has a single configuration context.

daemonContext - Variable in class com.maverick.nio.SocketConnection

disconnect(int, String) - Method in interface com.maverick.nio.ProtocolEngine

Disconnect the Engine

E

Event - Class in com.maverick.nio

Superclass of all events that may be fired during the life of SSHD.

Event(Object, int, boolean) - Constructor for class com.maverick.nio.Event

EVENT_CONNECTION_ATTEMPT - Static variable in class com.maverick.nio.EventCodes

A connection has been made

EVENT_DAEMON_START - Static variable in class com.maverick.nio.EventCodes

The SSHD daemon has been started (or has failed to start)

EVENT_DAEMON_STARTING - Static variable in class com.maverick.nio.EventCodes

The SSHD daemon is starting

EVENT_DAEMON_STOP - Static variable in class com.maverick.nio.EventCodes

The SSHD daemon has been stopped (or has failed to stop)

EVENT_DAEMON_STOPPING - Static variable in class com.maverick.nio.EventCodes

The SSHD daemon is stopping

EVENT_DEBUG_LOG - Static variable in class com.maverick.nio.EventCodes

Logging event, this event replaces log.debug(String) calls

EVENT_ERROR_LOG - Static variable in class com.maverick.nio.EventCodes

Logging event, this event replaces log.error(String) calls

EVENT_EXCEPTION_LOG - Static variable in class com.maverick.nio.EventCodes

Logging event, this event replaces log.info(String,Throwable) calls

EVENT_LOG - Static variable in class com.maverick.nio.EventCodes

Logging event, this event replaces log.info(String) calls

EventCodes - Class in com.maverick.nio

List of unique SSHD Event codes

EventCodes() - Constructor for class com.maverick.nio.EventCodes

EventListener - Interface in com.maverick.nio

Interface to be implemented by classes interested in receiving SSHDEvent events.

EventService - Interface in com.maverick.nio

Interface to be implemented by an event service implementation.

EventServiceImplementation - Class in com.maverick.nio

Event Service Implementation singleton, that manages SSHD Event Listeners, and allows events to be fired.

EventServiceImplementation() - Constructor for class com.maverick.nio.EventServiceImplementation

F

finishAccept(SelectionKey) - Method in class com.maverick.nio.ClientAcceptor

Called by the framework when the OP_ACCEPT event is fired for this acceptor.

finishAccept(SelectionKey, ProtocolContextFactory) - Method in class com.maverick.nio.ClientAcceptor

Complete the accept operation.

finishConnect(SelectionKey) - Method in interface com.maverick.nio.ClientConnector

Complete the connect operation.

forwardingFactories - Variable in class com.maverick.nio.ForwardingManager

ForwardingManager - Class in com.maverick.nio

ForwardingManager() - Constructor for class com.maverick.nio.ForwardingManager

G

get() - Method in class com.maverick.nio.ByteBufferPool

Get a free buffer from the pool.

getAddressToBind() - Method in class com.maverick.nio.ListeningInterface

getAllocatedBuffers() - Method in class com.maverick.nio.ByteBufferPool

Get the number of buffers currently allocated out.

getBufferPool() - Method in class com.maverick.nio.DaemonContext

Returns a direct buffer pool.

getCapacity() - Method in class com.maverick.nio.ByteBufferPool

Get the capacity of buffers in this pool.

getContext() - Method in class com.maverick.nio.Daemon

Get the context for this Daemon.

getContextFactory() - Method in class com.maverick.nio.ListeningInterface

getDaemonContext() - Method in class com.maverick.nio.SocketConnection

Get the daemon process for this socket.

getEventService() - Method in class com.maverick.nio.Daemon

Get the event service this daemon uses.

getFreeBuffers() - Method in class com.maverick.nio.ByteBufferPool

Get the number of buffers that are ready to be allocated.

getIdleServiceRunPeriod() - Method in class com.maverick.nio.DaemonContext

Get the time in seconds for each idle period service run.

getIdleStates() - Method in class com.maverick.nio.SocketConnection

Get the idle state manager.

getInactiveServiceRunsPerIdleEvent() - Method in class com.maverick.nio.DaemonContext

To determine whether any channels are idle a service run is performed to evaluate the state of each channel.

getInstance(Class) - Static method in class com.maverick.nio.ForwardingManager

Get the singleton instance of a remote forwarding manager implementation.

getInterestedOps() - Method in class com.maverick.nio.SocketConnection

Get the initial interested ops for this socket.

getInterestedOps() - Method in interface com.maverick.nio.SocketHandler

Returns the current operations the handler is interested in

getListeningInterfaces() - Method in class com.maverick.nio.DaemonContext

Get the listening socket list.

getLocalAddress() - Method in class com.maverick.nio.SocketConnection

Returns the local address to which the remote socket is connected.

getLocalPort() - Method in class com.maverick.nio.SocketConnection

Returns the local port to which the remote socket is connected.

getMaximumChannelsPerThread() - Method in class com.maverick.nio.DaemonContext

Get the maximum number of channels that can be serviced by a single selector thread.

getMaximumLoad() - Method in class com.maverick.nio.SelectorThread

Get the maximum number of channels that this thread can service.

getName() - Method in interface com.maverick.nio.SelectorThreadImpl

Get the name of the implementation.

getPermanentAcceptThreads() - Method in class com.maverick.nio.DaemonContext

Get the number of permanent accept threads.

getPermanentConnectThreads() - Method in class com.maverick.nio.DaemonContext

Get the number of permanent connect threads.

getPermanentTransferThreads() - Method in class com.maverick.nio.DaemonContext

Get the number of permanent transfer threads.

getPort() - Method in class com.maverick.nio.SocketConnection

Returns the local port to which the remote socket is connected.

getProduct() - Method in class com.maverick.nio.DaemonContext

Get the product name used to prefix thread names

getProtocolEngine() - Method in class com.maverick.nio.SocketConnection

Get the protocol engine for this socket.

getReceiveBufferSize() - Method in class com.maverick.nio.ProtocolContext

Get the socket receive buffer size.

getRemoteAddress() - Method in class com.maverick.nio.SocketConnection

Returns the address of the remote socket.

getSelectorId() - Method in class com.maverick.nio.SelectorThread

Get the id of this selector thread.

getSelectorProvider() - Method in class com.maverick.nio.DaemonContext

Get the SelectorProvider used to create Selector instances.

getSendBufferSize() - Method in class com.maverick.nio.ProtocolContext

Get the socket send buffer size.

getServer() - Method in class com.maverick.nio.DaemonContext

Get the instance of the SSHD for this context.

getSocketChannel() - Method in class com.maverick.nio.SocketConnection

Get the SocketChannel for this socket.

getSocketConnection() - Method in interface com.maverick.nio.ProtocolEngine

Get the SocketConnection for this connection.

getSocketOptionKeepAlive() - Method in class com.maverick.nio.ProtocolContext

Indicates whether the SO_KEEPALIVE socket option is set on connected sockets.

getSocketOptionReuseAddress() - Method in class com.maverick.nio.ProtocolContext

Indicates whether the SO_REUSEADDR socket option will be set on a server socket.

getSocketOptionTcpNoDelay() - Method in class com.maverick.nio.ProtocolContext

Indicates whether the TCP_NODELAY socket option is set on connected sockets.

getThread() - Method in class com.maverick.nio.SocketConnection

Get the selector thread for this connection

getThreadLoad() - Method in class com.maverick.nio.SelectorThread

Get the current thread load.

getTotalMemoryAllocated() - Method in class com.maverick.nio.ByteBufferPool

Calculate the total memory allocated by this pool.

getTotalMemoryInUse() - Method in class com.maverick.nio.ByteBufferPool

Calculate the total memory in use by this pool.

I

idle() - Method in interface com.maverick.nio.IdleStateListener

Process an idle event.

IdleStateListener - Interface in com.maverick.nio

A class implementing this interface is notified when the selector it is registered with becomes idle.

IdleStateManager - Class in com.maverick.nio

Class that checks the idle state of another class.

IdleStateManager(int, int) - Constructor for class com.maverick.nio.IdleStateManager

initialize(ProtocolEngine, Daemon) - Method in class com.maverick.nio.SocketConnection

Initialize the socket with the protocol engine and the daemon process.

initialize(ProtocolEngine, Daemon) - Method in interface com.maverick.nio.SocketHandler

Initialize this socket with a ProtocolEngine and the current Daemon.

isConnected() - Method in interface com.maverick.nio.ProtocolEngine

Is the protocol connected.

isConnected() - Method in class com.maverick.nio.SocketConnection

Is the socket still connected?

isPermanent() - Method in class com.maverick.nio.SelectorThread

Is this a permanent thread?

isReady() - Method in class com.maverick.nio.IdleStateManager

Called by a selector to determine when the service run is ready to be executed.

isSelectorThread() - Method in class com.maverick.nio.SocketConnection

Is the current thread this sockets SelectorThread?

isStarted() - Method in class com.maverick.nio.Daemon

Get whether the daemon is currently started

isUsingDirectBuffers() - Method in class com.maverick.nio.DaemonContext

Determine whether the daemon is using direct byte buffers.

K

keepAlive - Variable in class com.maverick.nio.ProtocolContext

key - Variable in class com.maverick.nio.SocketConnection

L

ListeningInterface - Class in com.maverick.nio

ListeningInterface(InetSocketAddress, ProtocolContextFactory) - Constructor for class com.maverick.nio.ListeningInterface

listeningPorts - Variable in class com.maverick.nio.ForwardingManager

O

onShutdown() - Method in class com.maverick.nio.Daemon

onSocketClose() - Method in interface com.maverick.nio.ProtocolEngine

The socket has closed.

onSocketConnect(SocketConnection) - Method in interface com.maverick.nio.ProtocolEngine

The socket is connected and the protocol can now start.

onSocketRead(ByteBuffer) - Method in interface com.maverick.nio.ProtocolEngine

Data has arrived on the socket.

onSocketWrite(ByteBuffer) - Method in interface com.maverick.nio.ProtocolEngine

The socket is ready for writing.

onStart() - Method in class com.maverick.nio.Daemon

P

processReadEvent() - Method in class com.maverick.nio.SocketConnection

The selector is ready to be read.

processReadEvent() - Method in interface com.maverick.nio.SocketHandler

The selector is ready to be read.

processSelectionKey(SelectionKey) - Method in interface com.maverick.nio.SelectorThreadImpl

Process a selection key.

processWriteEvent() - Method in class com.maverick.nio.SocketConnection

The selector is ready to be written to.

processWriteEvent() - Method in interface com.maverick.nio.SocketHandler

The selector is ready to be written to.

ProtocolContext - Class in com.maverick.nio

A protocol context defines the behaviour for a listening interface.

ProtocolContext() - Constructor for class com.maverick.nio.ProtocolContext

ProtocolContextFactory - Interface in com.maverick.nio

ProtocolEngine - Interface in com.maverick.nio

This interface defines the contract for a protocol implementation.

protocolEngine - Variable in class com.maverick.nio.SocketConnection

R

receiveBufferSize - Variable in class com.maverick.nio.ProtocolContext

register(IdleStateListener) - Method in class com.maverick.nio.IdleStateManager

register(SelectableChannel, int, Object, boolean) - Method in class com.maverick.nio.SelectorThread

Register a channel with the selector.

registerAcceptor(ClientAcceptor, ServerSocketChannel) - Method in class com.maverick.nio.Daemon

Register a client acceptor with the daemon.

registerConnector(ClientConnector, SocketChannel) - Method in class com.maverick.nio.Daemon

Register a client connector with the daemon.

registerHandler(SocketHandler, SelectableChannel) - Method in class com.maverick.nio.Daemon

Register a socket handler with the daemon.

registerHandler(SocketHandler, SelectableChannel, SelectorThread) - Method in class com.maverick.nio.Daemon

Register a socket handler with the daemon.

registrationCompleted(SelectableChannel, SelectionKey, SelectorThread) - Method in interface com.maverick.nio.SelectorRegistrationListener

The registration completed and its selector added to an available SelectorThread

registrationCompleted(SelectableChannel, SelectionKey, SelectorThread) - Method in class com.maverick.nio.SocketConnection

The sockets channel has completed registration.

remove(IdleStateListener) - Method in class com.maverick.nio.IdleStateManager

Called by a listener when they want to remove themselves

removeAcceptor(ListeningInterface) - Method in class com.maverick.nio.Daemon

removeEventListener(String) - Static method in class com.maverick.nio.DaemonContext

removeEventListener(EventListener) - Static method in class com.maverick.nio.DaemonContext

removeEventListener(EventListener) - Static method in class com.maverick.nio.DaemonContext

removeListeningInterface(InetAddress, int) - Method in class com.maverick.nio.DaemonContext

Remove a listening interface from the daemon at runtime.

removeListeningInterface(String, int) - Method in class com.maverick.nio.DaemonContext

Remove a listening interface from the daemon at runtime.

removeListeningInterface(String) - Method in class com.maverick.nio.DaemonContext

Deprecated. use DaemonContext.removeListeningInterface(String, int) instead.

reset(IdleStateListener) - Method in class com.maverick.nio.IdleStateManager

Called by a listener when they want their idle state to be reset.

reuseAddress - Variable in class com.maverick.nio.ProtocolContext

run() - Method in class com.maverick.nio.SelectorThread

The threads main.

S

selectNextThread() - Method in class com.maverick.nio.SelectorThreadPool

Select the next available thread with the minimum load.

SelectorRegistrationListener - Interface in com.maverick.nio

Allows an object to receive notification that a registration has completed on a SelectorThread.

SelectorThread - Class in com.maverick.nio

Provides management of a single selector.

SelectorThread(SelectorThreadPool, SelectorThreadImpl, boolean, int, int, int, int, SelectorProvider) - Constructor for class com.maverick.nio.SelectorThread

Construct a new selector thread.

selectorThread - Variable in class com.maverick.nio.SocketConnection

SelectorThreadImpl - Interface in com.maverick.nio

Each SelectorThread requires an implementation of this interface to pass selection events.

SelectorThreadPool - Class in com.maverick.nio

Maintains a pool of SelectoThreads increasing the pool when required and always maintaining the minimum number of permanent threads required.

SelectorThreadPool(SelectorThreadImpl, int, int, int, int, SelectorProvider) - Constructor for class com.maverick.nio.SelectorThreadPool

Construct a thread pool.

sendBufferSize - Variable in class com.maverick.nio.ProtocolContext

service() - Method in class com.maverick.nio.IdleStateManager

Called by a thread which is managing idle states

setBufferPoolArraySize(int) - Method in class com.maverick.nio.DaemonContext

Set the size of the byte buffers in the pool.

setEventService(EventService) - Method in class com.maverick.nio.Daemon

Set the event service this daemon uses.

setIdleServiceRunPeriod(int) - Method in class com.maverick.nio.DaemonContext

setInactiveServiceRunsPerIdleEvent(int) - Method in class com.maverick.nio.DaemonContext

To determine whether any channels are idle a service run is performed to evaluate the state of each channel.

setMaximumChannelsPerThread(int) - Method in class com.maverick.nio.DaemonContext

Set the maximum number of channels that can be serviced by a single selector thread.

setPermanentAcceptThreads(int) - Method in class com.maverick.nio.DaemonContext

Set the number of permanent accept threads.

setPermanentConnectThreads(int) - Method in class com.maverick.nio.DaemonContext

Set the number of permanent connect threads.

setPermanentTransferThreads(int) - Method in class com.maverick.nio.DaemonContext

Set the number of permanent transfer threads.

setProduct(String) - Method in class com.maverick.nio.DaemonContext

Set the product name used to prefix thread names

setReceiveBufferSize(int) - Method in class com.maverick.nio.ProtocolContext

Set the receive buffer size for sockets.

setSelectorProvider(SelectorProvider) - Method in class com.maverick.nio.DaemonContext

Set the SelectorProvider used by the Selector threads.

setSendBufferSize(int) - Method in class com.maverick.nio.ProtocolContext

Set the send buffer size for sockets.

setSocketHandlerImpl(Class) - Method in class com.maverick.nio.ProtocolContext

Sets the socket handler implementation class for this context.

setSocketOptionKeepAlive(boolean) - Method in class com.maverick.nio.ProtocolContext

Set the SO_KEEPALIVE socket option on connected sockets.

setSocketOptionReuseAddress(boolean) - Method in class com.maverick.nio.ProtocolContext

Indicates whether the SO_REUSEADDR socket option will be set on a server socket.

setSocketOptionTcpNoDelay(boolean) - Method in class com.maverick.nio.ProtocolContext

Set the TCP_NODELAY socket option on connected sockets.

setThread(SelectorThread) - Method in class com.maverick.nio.SocketConnection

Set the selector thread for this connection

setThread(SelectorThread) - Method in interface com.maverick.nio.SocketHandler

Sets the selector thread this handler runs upon

setUsingDirectBuffers(boolean) - Method in class com.maverick.nio.DaemonContext

Configure the byte buffer pool to use direct byte buffers.

setWriteState(boolean) - Method in class com.maverick.nio.SocketConnection

Sets the write state of the socket.

shutdown() - Method in class com.maverick.nio.Daemon

Shutdown the server.

shutdown() - Method in class com.maverick.nio.SelectorThread

Shutdown the thread.

shutdown() - Method in class com.maverick.nio.SelectorThreadPool

Shutdown all threads in the pool.

socketChannel - Variable in class com.maverick.nio.SocketConnection

SocketConnection - Class in com.maverick.nio

This class implements a SocketHandler using a standard socket.

SocketConnection() - Constructor for class com.maverick.nio.SocketConnection

Construct the socket.

socketDataIn - Variable in class com.maverick.nio.SocketConnection

socketDataOut - Variable in class com.maverick.nio.SocketConnection

SocketHandler - Interface in com.maverick.nio

An interface used by the SelectorThread to notify an object of when a read or write event has occurred.

SocketWriteCallback - Interface in com.maverick.nio

startListeningInterface(ListeningInterface) - Method in class com.maverick.nio.Daemon

startup() - Method in class com.maverick.nio.Daemon

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

stopAccepting() - Method in class com.maverick.nio.ClientAcceptor

Stop accepting clients

T

tcpNoDelay - Variable in class com.maverick.nio.ProtocolContext

W

wakeup() - Method in class com.maverick.nio.SelectorThread

Wakeup the selector.

wantsToWrite() - Method in interface com.maverick.nio.ProtocolEngine

Determines whether the protocol wants to write to the socket.

WriteOperationRequest - Class in com.maverick.nio

A throwble Object used to notify the read process that the no further messages should be processed and to allow the write process to write outstanding messages.

WriteOperationRequest() - Constructor for class com.maverick.nio.WriteOperationRequest

A B C D E F G I K L O P R S T W