com.sshtools.nio

Class ProtocolContext

java.lang.Object

com.sshtools.nio.ProtocolContext

Direct Known Subclasses:

SshContext

public abstract class ProtocolContext
extends Object

A protocol context defines the behaviour for a listening interface.

Author:

Lee David Painter

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	keepAlive
protected int	receiveBufferSize
protected boolean	reuseAddress
protected int	sendBufferSize
protected boolean	tcpNoDelay

Constructor Summary

Constructors

Constructor and Description
ProtocolContext()

Method Summary

Modifier and Type	Method and Description
SocketHandler	createConnection(SshEngine daemon) Create a socket handler for this protocol.
protected SocketHandler	createConnectionImpl() Creates a socket handler from the configured implementation class.
protected abstract ProtocolEngine	createEngine() Create a protocol engine.
int	getReceiveBufferSize() Get the socket receive buffer size.
int	getSendBufferSize() Get the socket send buffer size.
SocketConnectionFactory	getSocketConnectionFactory()
boolean	getSocketOptionKeepAlive() Indicates whether the SO_KEEPALIVE socket option is set on connected sockets.
boolean	getSocketOptionReuseAddress() Indicates whether the SO_REUSEADDR socket option will be set on a server socket.
boolean	getSocketOptionTcpNoDelay() Indicates whether the TCP_NODELAY socket option is set on connected sockets.
void	setReceiveBufferSize(int receiveBufferSize) Set the receive buffer size for sockets.
void	setSendBufferSize(int sendBufferSize) Set the send buffer size for sockets.
void	setSocketConnectionFactory(SocketConnectionFactory socketConnectionFactory)
void	setSocketHandlerImpl(Class<? extends SocketConnection> socketConnectionImpl) Sets the socket handler implementation class for this context.
void	setSocketOptionKeepAlive(boolean keepAlive) Set the SO_KEEPALIVE socket option on connected sockets.
void	setSocketOptionReuseAddress(boolean reuseAddress) Indicates whether the SO_REUSEADDR socket option will be set on a server socket.
void	setSocketOptionTcpNoDelay(boolean tcpNoDelay) Set the TCP_NODELAY socket option on connected sockets.
abstract void	shutdown()

Methods inherited from class java.lang.Object

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

Field Detail

keepAlive

protected boolean keepAlive

tcpNoDelay

protected boolean tcpNoDelay

reuseAddress

protected boolean reuseAddress

receiveBufferSize

protected int receiveBufferSize

sendBufferSize

protected int sendBufferSize

Constructor Detail

ProtocolContext

public ProtocolContext()

Method Detail

createConnection

public SocketHandler createConnection(SshEngine daemon)
                               throws IOException

Create a socket handler for this protocol.

Parameters:

daemon - Daemon

Returns:

SocketHandler

Throws:

IOException

createEngine

protected abstract ProtocolEngine createEngine()
                                        throws IOException

Create a protocol engine.

Returns:

ProtocolEngine

Throws:

IOException

getSocketOptionKeepAlive

public boolean getSocketOptionKeepAlive()

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

Returns:

boolean

getSocketOptionReuseAddress

public boolean getSocketOptionReuseAddress()

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

Returns:

boolean

setSocketOptionReuseAddress

public void setSocketOptionReuseAddress(boolean reuseAddress)

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

Parameters:

reuseAddress - boolean

setSocketHandlerImpl

public void setSocketHandlerImpl(Class<? extends SocketConnection> socketConnectionImpl)
                          throws IOException

Sets the socket handler implementation class for this context.

Parameters:

socketConnectionImpl - Class

Throws:

IOException

createConnectionImpl

protected SocketHandler createConnectionImpl()
                                      throws IOException

Creates a socket handler from the configured implementation class.

Returns:

SocketHandler

Throws:

IOException

setSocketOptionKeepAlive

public void setSocketOptionKeepAlive(boolean keepAlive)

Set the SO_KEEPALIVE socket option on connected sockets.

Parameters:

keepAlive - boolean

getSocketOptionTcpNoDelay

public boolean getSocketOptionTcpNoDelay()

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

Returns:

boolean

setSocketOptionTcpNoDelay

public void setSocketOptionTcpNoDelay(boolean tcpNoDelay)

Set the TCP_NODELAY socket option on connected sockets.

Parameters:

tcpNoDelay - boolean

setReceiveBufferSize

public void setReceiveBufferSize(int receiveBufferSize)

Set the receive buffer size for sockets.

Parameters:

receiveBufferSize - int

setSendBufferSize

public void setSendBufferSize(int sendBufferSize)

Set the send buffer size for sockets.

Parameters:

sendBufferSize - int

getReceiveBufferSize

public int getReceiveBufferSize()

Get the socket receive buffer size.

Returns:

int

getSendBufferSize

public int getSendBufferSize()

Get the socket send buffer size.

Returns:

int

getSocketConnectionFactory

public SocketConnectionFactory getSocketConnectionFactory()

setSocketConnectionFactory

public void setSocketConnectionFactory(SocketConnectionFactory socketConnectionFactory)

shutdown

public abstract void shutdown()