org.epics.ca.impl

Class ProtocolConfiguration

java.lang.Object

org.epics.ca.impl.ProtocolConfiguration

@Immutable
public class ProtocolConfiguration
extends java.lang.Object

Holds the standard EPICS parameters that the user configures to control the behaviour of the CA library with respect to channel-access protocol handling. These parameters can be set differently for each CA Context.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProtocolConfiguration.PropertyNames

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EPICS_CA_ADDR_LIST_DEFAULT Default address list
static boolean	EPICS_CA_AUTO_ADDR_LIST_DEFAULT Default address list
static float	EPICS_CA_CONN_TMO_DEFAULT Default connection timeout.
static int	EPICS_CA_MAX_ARRAY_BYTES_DEFAULT Default maximum size of array passed through CA.
static int	EPICS_CA_REPEATER_PORT_DEFAULT Default CA repeater port.
static int	EPICS_CA_SERVER_PORT_DEFAULT Default CA server port.

Constructor Summary

Constructors

Constructor and Description
ProtocolConfiguration() Constructs a new instance whose default values may be overrideen by environmental variables only.
ProtocolConfiguration(java.util.Properties properties) Constructs a new instance whose default values may be overridden by environmental variables or values set in the supplied properties object.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddressList() Returns a space-separated list of broadcast addresses which can be used for process variable name resolution.
boolean	getAutoAddressList() Defines whether or not the network interfaces should be discovered at runtime.
float	getConnectionTimeout() If the context doesn't see a beacon from a server that it is connected to for connectionTimeout seconds then a state-of-health message is sent to the server over TCP/IP.
int	getMaxArrayBytes() Returns the length in bytes of the maximum array size that may pass through CA.
int	getRepeaterPort() Returns the port number that the CA library will contact when attempting to register with the CA Repeater.
int	getServerPort() Returns the port number that the CA library will use when broadcasting channel search requests.

Methods inherited from class java.lang.Object

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

Field Detail

EPICS_CA_ADDR_LIST_DEFAULT

public static final java.lang.String EPICS_CA_ADDR_LIST_DEFAULT

Default address list

See Also:

Constant Field Values

EPICS_CA_AUTO_ADDR_LIST_DEFAULT

public static final boolean EPICS_CA_AUTO_ADDR_LIST_DEFAULT

Default address list

See Also:

Constant Field Values

EPICS_CA_CONN_TMO_DEFAULT

public static final float EPICS_CA_CONN_TMO_DEFAULT

Default connection timeout.

See Also:

Constant Field Values

EPICS_CA_REPEATER_PORT_DEFAULT

public static final int EPICS_CA_REPEATER_PORT_DEFAULT

Default CA repeater port.

See Also:

Constant Field Values

EPICS_CA_SERVER_PORT_DEFAULT

public static final int EPICS_CA_SERVER_PORT_DEFAULT

Default CA server port.

See Also:

Constant Field Values

EPICS_CA_MAX_ARRAY_BYTES_DEFAULT

public static final int EPICS_CA_MAX_ARRAY_BYTES_DEFAULT

Default maximum size of array passed through CA. (<=0 means unlimited).

See Also:

Constant Field Values

Constructor Detail

ProtocolConfiguration

public ProtocolConfiguration()

Constructs a new instance whose default values may be overrideen by environmental variables only.

ProtocolConfiguration

public ProtocolConfiguration(java.util.Properties properties)

Constructs a new instance whose default values may be overridden by environmental variables or values set in the supplied properties object.

Parameters:

properties - an object providing property overrides.

Throws:

java.lang.NullPointerException - if the properties argument was null.

Method Detail

getAddressList

public java.lang.String getAddressList()

Returns a space-separated list of broadcast addresses which can be used for process variable name resolution. Each address must be of the form: ip.number:port or host.name:port

Returns:

the configured value.

getAutoAddressList

public boolean getAutoAddressList()

Defines whether or not the network interfaces should be discovered at runtime.

Returns:

the configured value.

getConnectionTimeout

public float getConnectionTimeout()

If the context doesn't see a beacon from a server that it is connected to for connectionTimeout seconds then a state-of-health message is sent to the server over TCP/IP. If this state-of-health message isn't promptly replied to then the context will assume that the server is no longer present on the network and disconnect.

Returns:

the configured value.

getRepeaterPort

public int getRepeaterPort()

Returns the port number that the CA library will contact when attempting to register with the CA Repeater.

Returns:

the configured value.

getServerPort

public int getServerPort()

Returns the port number that the CA library will use when broadcasting channel search requests.

Returns:

the configured value.

getMaxArrayBytes

public int getMaxArrayBytes()

Returns the length in bytes of the maximum array size that may pass through CA. Defaults to 0 (<=0 means unlimited).

Returns:

the configured value.