com.sshtools.synergy.nio

Interface SocketHandler

All Superinterfaces:

SelectionKeyAware, SelectorRegistrationListener

All Known Implementing Classes:

LocalForwardingChannel, RemoteForwardingChannel, SocketConnection, SocketForwardingChannel, SSLContextConnection, SSLSocketConnection

public interface SocketHandler
extends SelectorRegistrationListener, SelectionKeyAware

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

Method Summary

Modifier and Type	Method and Description
void	addTask(ConnectionAwareTask task) Add a task to the executor
Connection<? extends SshContext>	getConnection() Get the Connection for this handler
SshContext	getContext() Get the current context
int	getInitialOps() Returns the current operations the handler is interested in
java.lang.String	getName() A name for this Socket
SelectorThread	getSelectorThread() Get the selector thread this handler is connected to.
void	initialize(ProtocolEngine engine, SshEngine daemon, java.nio.channels.SelectableChannel channel) Initialise this socket with a ProtocolEngine and the current SshEngine.
boolean	processReadEvent() The selector is ready to be read.
boolean	processWriteEvent() The selector is ready to be written to.
void	setThread(SelectorThread thread) Sets the selector thread this handler runs upon
boolean	wantsRead() Tell the selector that the handler wants to read.
boolean	wantsWrite() Tell the selector that the handler wants to write.

Methods inherited from interface com.sshtools.synergy.nio.SelectorRegistrationListener

registrationCompleted

Methods inherited from interface com.sshtools.synergy.nio.SelectionKeyAware

setSelectionKey

Method Detail

initialize

void initialize(ProtocolEngine engine,
                SshEngine daemon,
                java.nio.channels.SelectableChannel channel)
         throws java.io.IOException

Initialise this socket with a ProtocolEngine and the current SshEngine.

Parameters:

engine - ProtocolEngine

daemon - Daemon

Throws:

java.io.IOException

processReadEvent

boolean processReadEvent()

The selector is ready to be read.

Returns:

boolean indicating ??

processWriteEvent

boolean processWriteEvent()

The selector is ready to be written to.

Returns:

boolean

getInitialOps

int getInitialOps()

Returns the current operations the handler is interested in

Returns:

int

setThread

void setThread(SelectorThread thread)

Sets the selector thread this handler runs upon

Parameters:

thread -

addTask

void addTask(ConnectionAwareTask task)

Add a task to the executor

wantsWrite

boolean wantsWrite()

Tell the selector that the handler wants to write.

Returns:

getSelectorThread

SelectorThread getSelectorThread()

Get the selector thread this handler is connected to.

Returns:

getName

java.lang.String getName()

A name for this Socket

Returns:

getContext

SshContext getContext()

Get the current context

Returns:

getConnection

Connection<? extends SshContext> getConnection()

Get the Connection for this handler

Returns:

wantsRead

boolean wantsRead()

Tell the selector that the handler wants to read.

Returns: