com.neeve.client.link
Class ClientLinkManager.Configuration

java.lang.Object
  com.neeve.client.link.ClientLinkManager.Configuration

Enclosing class:

ClientLinkManager

public static final class ClientLinkManager.Configuration
extends Object

A link manager configuration object.

Field Summary

Set<String>	descriptors The links to be managed by the link managers This members contains the link descriptors of the links (links) to be managed by a link manager.
Properties	props Properties used to configure the operation of a link manager.

Constructor Summary

ClientLinkManager.Configuration(Set<String> descriptors, Properties props)

Method Summary

static ClientLinkManager.Configuration	parse(String name) Create a configuration object from a simple configuration entity in the '/clients/linkmanagers' entity container in the default configuration repository.
String	toString() Returns a string representation of this object

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

descriptors

public final Set<String> descriptors

The links to be managed by the link managers

This members contains the link descriptors of the links (links) to be managed by a link manager.

props

public final Properties props

Properties used to configure the operation of a link manager.

This member contains the set of properties used to configure the operation of a link manager. Currently, the following properties are defined for use with a link manager:

Threading Model
This property (ThreadingModelis used to specify the I/O threading model that will be used to read and write data through the links (links) managed by this link manager. Valid values are:
strw
Specifies that the user will be using a single and the same thread to read and write through links managed by a link manager i.e. all writes will be performed using the reader thread associated with the link manager.
strstw
Specifies that the read will be driven by the single reader associated with the link manager and writes will be performed using a single thread potentially different from the reader thread.
strmtw
Specifies that the read will be driven by the single reader associated with the link manager and writes will be concurrently performed using multiple threads.

Default=strw.

Detached Mode of Operation
This property Detached is used to indicate whether the link manager will be operating in the attached or detached mode of operation. In the attached mode of operation, the thread that instantiates the link manageris set as the reader thread for the manager. Otherwise, a separate thread is spun up as the link manager reader thread. In the attached mode of operation, the user is responsible for driving the reader using the appropriate run method supplied with the link manager (LnkSTRRunnableContainer) or by getting the reader and explictly driving the reader's event dispatch loop. In the latter case, the created thread goes directly into the link manager run loop.

Default=false.

CPU Affinity Mask
This property CPUAFfinityMask is used with detached link managers to set the CPU affinity mask of the detached thread.

Default=0.

Constructor Detail

ClientLinkManager.Configuration

public ClientLinkManager.Configuration(Set<String> descriptors,
                                       Properties props)

Method Detail

parse

public static ClientLinkManager.Configuration parse(String name)
                                             throws EClientLinkNotPresentException,
                                                    EClientLinkException

Create a configuration object from a simple configuration entity in the '/clients/linkmanagers' entity container in the default configuration repository.

Parameters:

name - The name of the entity to use.

Throws:

EClientLinkNotPresentException - Thrown in case the configuration entity of the specified name was not found.

EClientLinkException - Thrown in case some other error occurs during the initializing the configuration object from the repository.

This method creates a configuration object from a simple configuration entity in the '/clients/linkmanagers' entity container in the default configuration repository. The descriptors member is initialized from the entity's 'Links' property. The 'Links' property is parsed as a set of comma delimited link descriptors. The remaining properties in the entity are loaded into the props member.

toString

public final String toString()

Returns a string representation of this object

Overrides:

toString in class Object