toolbox.socket
Interface SocketClientManager

All Known Implementing Classes:

SocketClientManagerImpl

public interface SocketClientManager

Defines an interface for developing a client socket manager.

Implementations of this interface will provide the following:

• Access to managed client socket connections through an implementation of the SocketConnectionManager interface.
• Access to an implementation of the SocketProtocolHandler interface to facilitate low level socket communications.
• Access to a SocketClient implementation.

Method Summary

void	destroy() Destroy this manager.
java.lang.String	getName() Return the name of this manager.
SocketClient	getSocketClient() Returns an implementation of the SocketClient interface.
void	init(java.lang.String name, XMLProperties xmlProps) Initialise this manager with the XML configuration containing the client infrastructure configuration.
void	setName(java.lang.String name) Set the name of this manager.

Method Detail

init

void init(java.lang.String name,
          XMLProperties xmlProps)
          throws SocketClientException

Initialise this manager with the XML configuration containing the client infrastructure configuration.

Parameters:

name - String containing the name of this manager.

xmlProps - XML configuration properties.

Throws:

SocketClientException - if the manager cannot be initialised.

setName

void setName(java.lang.String name)

Set the name of this manager.

Parameters:

name - String containing manager name.

getName

java.lang.String getName()

Return the name of this manager.

Returns:

String containing the name of this manager.

getSocketClient

SocketClient getSocketClient()

Returns an implementation of the SocketClient interface.

Returns:

SocketClient instance.

destroy

void destroy()

Destroy this manager.