Collapse All Expand All

.NET Framework Class Library
CFImpl Class See Also

[TIBCO.EMS .NET client library 5.1 documentation]

Get or set the load balancing metric used by the connection factory

Namespace: TIBCO.EMS
Assembly: TIBCO.EMS (in TIBCO.EMS.dll)

# Syntax

    public FactoryLoadBalanceMetric Metric { get; set; }

    Public Property Metric As FactoryLoadBalanceMetric

    public:
    property FactoryLoadBalanceMetric Metric {
    	FactoryLoadBalanceMetric get ();
    	void set (FactoryLoadBalanceMetric value);
    }

# Remarks

Valid metrics are:

- FactoryLoadBalanceMetric.None: not load balanced
- FactoryLoadBalanceMetric.Connections: number of connections on server
- FactoryLoadBalanceMetric.ByteRate: total byte rate (input and output) on server

If the factory is not a load balancing factory then the value returned will be FactoryLoadBalanceMetric.None. If the factory is a load balancing factory but no metric has been set explicitly then the metric returned will be the default metric (FactoryLoadBalanceMetric.Connections) will be returned.

# Exceptions

Exception | Condition
--- | ---
TIBCO.EMS..::.EMSException | If the value of metric to set is invalid

# See Also

CFImpl Class
TIBCO.EMS Namespace