Create connections to the TIBCO Patterns Engine.


Namespace: NetricsServerInterface
Assembly: NetricsServerInterface (in NetricsServerInterface.dll)

Syntax

Visual Basic (Declaration)
Public Class NetricsConMgr
C#
public class NetricsConMgr
C++
ref class NetricsConMgr
J#
public class NetricsConMgr
JScript
public class NetricsConMgr

Remarks

This is a factory class used to create a connection to the TIBCO Patterns Engine. Each object of this class is associated with a particular TIBCO Patterns Engine and contains all of the information necessary to connect to the engine. All of this information has default values, and an associated environment variable. Methods are provided to override these settings. If a value is set via a method call that value takes precedence, otherwise the value of the associated environment variable is used, if the environment variable does not exist in the environment the default value is used. The values are listed below.

Host Machine. An IP address or name resolvable to an IP address of the machine the TIBCO Patterns Engine is on.
Environment Variable: TIBCOPatternsServerHost
Default value: localhost

Host Port. The port number the TIBCO Patterns Engine is listening on. If the environment variable does not contain an integer string value it is ignored.
Environment Variable: TIBCOPatternsServerPort
Default value: 5051

Connection Pooling. The type of connection pooling to be used. The environment variable must have a value of: "common", "local" or "none". Other values are ignored.
Environment Variable: TIBCOPatternsConnectionPooling
Default value: common

Protocol Selection. Whether communications should use IPv4, IPv6, or defer the choice to network configuration. The environment variable must have a value of: "ipv4" or "ipv6" or "mixed". Other values are ignored.
Environment Variable: TIBCOPatternsConnectionProtocols
Default value: mixed, except on Windows Server 2003 (and Windows XP), where the default is ipv4.

Debug Logging. Whether all communications should be logged to standard error. These logs will be very large and verbose, they are only used for debugging. The environment variable must have a value of: "on" or "off". Other values are ignored.
Environment Variable: TIBCOPatternsConnectionDebug
Default value: off

None of the following methods should be called on an object that is being shared across multiple threads:

  • setHost
  • setPort
  • setDebugOn
  • setDebugOff
  • setConnectionPoolingOff
  • setConnectionPoolingCommon
  • setConnectionPoolingLocal
The recommended procedure is to create and initialize a NetricsConMgr object in the main thread, it may then be passed to other threads, which may use it to create NetricsServerInterface or NetricsTransaction objects, but once shared between threads the NetricsConMgr object should never be updated by calling any of the methods listed above.

Inheritance Hierarchy

System.Object
   NetricsServerInterface.NetricsConMgr

Thread Safety

Public static (Shared in Visual Basic)staticShared members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread-safe.

See Also