Programs use class EFTL to connect to an eFTL server. More...

Static Public Member Functions
static void	Connect (String url, Hashtable props, IConnectionListener listener)
	Connect to an eFTL server. More...

static String	GetVersion ()
	Get the version of the eFTL .NET client library. More...

Static Public Attributes
static readonly String	PROPERTY_ACKNOWLEDGE_MODE = "ack"
	Create a subscription with a specific acknowledgment mode. More...

static readonly String	PROPERTY_AUTO_RECONNECT_ATTEMPTS = "auto_reconnect_attempts"
	Autoreconnect maximum attempts; property name. More...

static readonly String	PROPERTY_AUTO_RECONNECT_MAX_DELAY = "auto_reconnect_max_delay"
	Autoreconnect maximum delay; property name. More...

static readonly String	PROPERTY_CLIENT_ID = "client_id"
	Connect using this client identifier; property name. More...

static readonly String	PROPERTY_DURABLE_KEY = "key"
	Specify the key field of a last-value durable subscription; property name. More...

static readonly String	PROPERTY_DURABLE_TYPE = "type"
	Create a durable subscription of this type; property name. More...

static readonly String	PROPERTY_MAX_PENDING_ACKS = "max_pending_acks"
	Maximum number of unacknowledged messages allowed for the client; property name. More...

static readonly String	PROPERTY_PASSWORD = "password"
	Connect using this password; property name. More...

static readonly String	PROPERTY_TIMEOUT = "timeout"
	Connection attempt timeout; property name. More...

static readonly String	PROPERTY_TRUST_ALL = "trust_all"
	Trust any eFTL server certificate; property name. More...

static readonly String	PROPERTY_USERNAME = "user"
	Connect as this user; property name. More...

Protected Member Functions
	EFTL ()

Detailed Description

Programs use class EFTL to connect to an eFTL server.

Constructor & Destructor Documentation

TIBCO.EFTL.EFTL.EFTL ( )

inlineprotected

Member Function Documentation

static void TIBCO.EFTL.EFTL.Connect	(	String	url,
		Hashtable	props,
		IConnectionListener	listener
	)

inlinestatic

Connect to an eFTL server.

This call returns immediately; connecting continues asynchronously. When the connection is ready to use, the eFTL library calls your IConnectionListener.OnConnect method, passing an IConnection object that you can use to publish and subscribe.

When a pipe-separated list of URLs is specified this call will attempt a connection to each in turn, in a random order, until one is connected.

A program that uses more than one server channel must connect separately to each channel.

Parameters

url

The call connects to the eFTL server at this URL. This can be a single URL, or a pipe ('|') separated list of URLs. URLs can be in either of these forms:

ws://host:port/channel
wss://host:port/channel

Optionally, the URL can contain the username, password, and/or client identifier:

ws://username:password:port/channel?clientId=<identifier>
wss://username:password:port/channel?clientId=<identifier>

props

These properties affect the connection attempt:

listener Connection events invoke methods of this listener.

See Also: IConnectionListener

static String TIBCO.EFTL.EFTL.GetVersion ( )

inlinestatic

Get the version of the eFTL .NET client library.

Returns: The version of the eFTL .NET client library.

Member Data Documentation

readonly String TIBCO.EFTL.EFTL.PROPERTY_ACKNOWLEDGE_MODE = "ack"

static

Create a subscription with a specific acknowledgment mode.

Programs use this property to specify how messages received by the subscription are acknowledged. The following acknowledgment modes are supported:

If you omit this property, the subscription is created with an acknowledgment mode of AcknowledgeMode.AUTO.

See Also: IConnection.Subscribe(String, String, Hashtable, ISubscriptionListener), AcknowledgeMode.AUTO, AcknowledgeMode.CLIENT, AcknowledgeMode.NONE

readonly String TIBCO.EFTL.EFTL.PROPERTY_AUTO_RECONNECT_ATTEMPTS = "auto_reconnect_attempts"

static

Autoreconnect maximum attempts; property name.

Programs use this property to supply the maximum number of autoreconnect attempts to the EFTL.Connect call. If the connection is lost, the client will attempt to automatically reconnect to the server. If the number of autoreconnect attempts exceeds this value, it stops trying to autoreconnect and invokes your IConnectionListener.OnDisconnect method with a ConnectionListenerConstants.CONNECTION_ERROR code.

If you omit this property, the default number of attempts is 5.

See Also: EFTL.Connect

readonly String TIBCO.EFTL.EFTL.PROPERTY_AUTO_RECONNECT_MAX_DELAY = "auto_reconnect_max_delay"

static

Autoreconnect maximum delay; property name.

Programs use this property to supply the maximum delay (in seconds) between autoreconnect attempts to the EFTL.Connect call. If the connection is lost, the client will attempt to automatically reconnect to the server after a delay of 1 second. For each subsequent attempt, the delay is doubled, to a maximum determined by this property.

If you omit this property, the default maximum delay is 30 seconds.

See Also: EFTL.Connect

readonly String TIBCO.EFTL.EFTL.PROPERTY_CLIENT_ID = "client_id"

static

Connect using this client identifier; property name.

Programs use this property to supply a client identifier to the EFTL.Connect call if the client identifier is not specified with the URL. The server uses the client identifier to associate a particular client with a durable subscription.

If you omit this property, the server assigns a unique client identifier.

readonly String TIBCO.EFTL.EFTL.PROPERTY_DURABLE_KEY = "key"

static

Specify the key field of a last-value durable subscription; property name.

Programs use this property to supply a key field to the IConnection.Subscribe(String, String, Hashtable, ISubscriptionListener) call when the EFTL.PROPERTY_DURABLE_TYPE property is of type DurableType.LAST_VALUE. Note that the supplied key field must be a part of the durable subscription's matcher.

readonly String TIBCO.EFTL.EFTL.PROPERTY_DURABLE_TYPE = "type"

static

Create a durable subscription of this type; property name.

Programs use this optional property to supply a durable type to the IConnection.Subscribe(String, String, Hashtable, ISubscriptionListener) call. If not specified the default durable type will be used.

See Also: DurableType.SHARED, DurableType.LAST_VALUE

readonly String TIBCO.EFTL.EFTL.PROPERTY_MAX_PENDING_ACKS = "max_pending_acks"

static

Maximum number of unacknowledged messages allowed for the client; property name.

Programs use this property to specify the maximum number of unacknowledged messages allowed for the client. Once the maximum number of unacknowledged messages is reached the client will stop receiving additional messages until previously received messages are acknowledged.

If you omit this property, the server's configured value will be used.

See Also: EFTL.Connect

readonly String TIBCO.EFTL.EFTL.PROPERTY_PASSWORD = "password"

static

Connect using this password; property name.

Programs use this property to supply a password credential to the EFTL.Connect call if the password is not specified with the URL. The server authenticates the user and password.

readonly String TIBCO.EFTL.EFTL.PROPERTY_TIMEOUT = "timeout"

static

Connection attempt timeout; property name.

Programs use this property to supply a timeout to the EFTL.Connect call. If the client cannot connect to the server within this time limit (in seconds), it stops trying to connect and invokes your IConnectionListener.OnDisconnect method with a ConnectionListenerConstants.CONNECTION_ERROR code.

If you omit this property, the default timeout is 15.0 seconds.

See Also: EFTL.Connect

readonly String TIBCO.EFTL.EFTL.PROPERTY_TRUST_ALL = "trust_all"

static

Trust any eFTL server certificate; property name.

When present with value true, the client accepts any eFTL server certificate. Use this setting only in development environments. It is not secure, so it is unsuitable for production environments.

When absent or false, the client trusts only certificates installed on the client host computer.

readonly String TIBCO.EFTL.EFTL.PROPERTY_USERNAME = "user"

static

Connect as this user; property name.

Programs use this property to supply a username credential to the EFTL.Connect call if the username is not specified with the URL. The server authenticates the user and password.

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation