net.officefloor.plugin.socket.server.tcp.protocol

Class TcpCommunicationProtocol

java.lang.Object

net.officefloor.plugin.socket.server.tcp.protocol.TcpCommunicationProtocol

All Implemented Interfaces:

CommunicationProtocol, CommunicationProtocolSource

public class TcpCommunicationProtocol
extends Object
implements CommunicationProtocolSource, CommunicationProtocol

TCP CommunicationProtocolSource.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAXIMUM_IDLE_TIME Default time before an idle Connection is closed.
static String	PROPERTY_MAXIMUM_IDLE_TIME Property to obtain the maximum idle time before the Connection is closed.

Constructor Summary

Constructors

Constructor and Description
TcpCommunicationProtocol()

Method Summary

Modifier and Type	Method and Description
CommunicationProtocol	createCommunicationProtocol(AbstractAsyncManagedObjectSource.MetaDataContext<None,Indexed> configurationContext, CommunicationProtocolContext protocolContext) Creates the CommunicationProtocol.
TcpConnectionHandler	createConnectionHandler(Connection connection) Creates a ConnectionHandler for a new Connection.
void	loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context) Loads any specifications for this communication protocol.
void	serviceConnection(TcpConnectionHandler connectionHandler) Triggers a ProcessState to service the Connection.
void	setManagedObjectExecuteContext(ManagedObjectExecuteContext<Indexed> executeContext) Provides the CommunicationProtocol the ManagedObjectExecuteContext to enable it to invoke ProcessState instances to process input.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_MAXIMUM_IDLE_TIME

public static final String PROPERTY_MAXIMUM_IDLE_TIME

Property to obtain the maximum idle time before the Connection is closed.

See Also:

Constant Field Values

DEFAULT_MAXIMUM_IDLE_TIME

public static final int DEFAULT_MAXIMUM_IDLE_TIME

Default time before an idle Connection is closed.

See Also:

Constant Field Values

Constructor Detail

TcpCommunicationProtocol

public TcpCommunicationProtocol()

Method Detail

serviceConnection

public void serviceConnection(TcpConnectionHandler connectionHandler)

Triggers a ProcessState to service the Connection.

Parameters:

connectionHandler - TcpConnectionHandler for the ConnectException.

loadSpecification

public void loadSpecification(AbstractAsyncManagedObjectSource.SpecificationContext context)

Description copied from interface: CommunicationProtocolSource

Loads any specifications for this communication protocol.

Specified by:

loadSpecification in interface CommunicationProtocolSource

Parameters:

context - AbstractAsyncManagedObjectSource.SpecificationContext.

createCommunicationProtocol

public CommunicationProtocol createCommunicationProtocol(AbstractAsyncManagedObjectSource.MetaDataContext<None,Indexed> configurationContext,
                                                         CommunicationProtocolContext protocolContext)
                                                  throws Exception

Description copied from interface: CommunicationProtocolSource

Creates the CommunicationProtocol.

Specified by:

createCommunicationProtocol in interface CommunicationProtocolSource

Parameters:

configurationContext - AbstractAsyncManagedObjectSource.MetaDataContext.

protocolContext - CommunicationProtocolSource.

Returns:

CommunicationProtocol.

Throws:

Exception - If fails to create the CommunicationProtocol.

setManagedObjectExecuteContext

public void setManagedObjectExecuteContext(ManagedObjectExecuteContext<Indexed> executeContext)

Description copied from interface: CommunicationProtocol

Provides the CommunicationProtocol the ManagedObjectExecuteContext to enable it to invoke ProcessState instances to process input.

Specified by:

setManagedObjectExecuteContext in interface CommunicationProtocol

Parameters:

executeContext - ManagedObjectExecuteContext.

createConnectionHandler

public TcpConnectionHandler createConnectionHandler(Connection connection)

Description copied from interface: CommunicationProtocol

Creates a ConnectionHandler for a new Connection.

Specified by:

createConnectionHandler in interface CommunicationProtocol

Parameters:

connection - A new Connection requiring handling.

Returns:

ConnectionHandler to handle the new Connection.