com.maverick.sshd

Class ThreadedProtocolEngine

java.lang.Object

com.maverick.ssh.ExecutorOperationSupport<SshContext>

com.maverick.sshd.ThreadedProtocolEngine

All Implemented Interfaces:

ProtocolEngine

public class ThreadedProtocolEngine
extends com.maverick.ssh.ExecutorOperationSupport<SshContext>
implements ProtocolEngine

Field Summary

Fields inherited from interface com.maverick.nio.ProtocolEngine

BY_APPLICATION

Constructor Summary

Constructors

Constructor and Description
ThreadedProtocolEngine(TransportProtocol engine)

Method Summary

Modifier and Type	Method and Description
void	disconnect(int reason, String description) Disconnect the Engine
SshContext	getContext()
SocketConnection	getSocketConnection() Get the SocketConnection for this connection.
boolean	isConnected() Is the protocol connected.
void	onPostMessage()
void	onSocketClose() The socket has closed.
void	onSocketConnect(SocketConnection connection) The socket is connected and the protocol can now start.
boolean	onSocketRead(ByteBuffer applicationData) Data has arrived on the socket.
SocketWriteCallback	onSocketWrite(ByteBuffer applicationData) The socket is ready for writing.
boolean	wantsToWrite() Determines whether the protocol wants to write to the socket.

Methods inherited from class com.maverick.ssh.ExecutorOperationSupport

addTask, cleanupOperations, getOperationsCount

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadedProtocolEngine

public ThreadedProtocolEngine(TransportProtocol engine)

Method Detail

onSocketConnect

public void onSocketConnect(SocketConnection connection)

Description copied from interface: ProtocolEngine

The socket is connected and the protocol can now start.

Specified by:

onSocketConnect in interface ProtocolEngine

Parameters:

connection - SocketConnection

onSocketClose

public void onSocketClose()

Description copied from interface: ProtocolEngine

The socket has closed.

Specified by:

onSocketClose in interface ProtocolEngine

onSocketRead

public final boolean onSocketRead(ByteBuffer applicationData)

Description copied from interface: ProtocolEngine

Data has arrived on the socket.

Specified by:

onSocketRead in interface ProtocolEngine

Parameters:

applicationData - ByteBuffer

Returns:

boolean to determine if protocol wants to write to the socket

onSocketWrite

public final SocketWriteCallback onSocketWrite(ByteBuffer applicationData)

Description copied from interface: ProtocolEngine

The socket is ready for writing.

Specified by:

onSocketWrite in interface ProtocolEngine

Parameters:

applicationData - ByteBuffer

wantsToWrite

public boolean wantsToWrite()

Description copied from interface: ProtocolEngine

Determines whether the protocol wants to write to the socket. The value of this method determines the write state of the socket. Only return a true value when the protocol needs to write data to the socket.

Specified by:

wantsToWrite in interface ProtocolEngine

Returns:

boolean

isConnected

public boolean isConnected()

Description copied from interface: ProtocolEngine

Is the protocol connected.

Specified by:

isConnected in interface ProtocolEngine

Returns:

boolean

getSocketConnection

public SocketConnection getSocketConnection()

Description copied from interface: ProtocolEngine

Get the SocketConnection for this connection.

Specified by:

getSocketConnection in interface ProtocolEngine

Returns:

SocketConnection

disconnect

public void disconnect(int reason,
                       String description)

Description copied from interface: ProtocolEngine

Disconnect the Engine

Specified by:

disconnect in interface ProtocolEngine

getContext

public SshContext getContext()

Specified by:

getContext in class com.maverick.ssh.ExecutorOperationSupport<SshContext>

onPostMessage

public void onPostMessage()