TIBCO eFTL™
Public Member Functions | List of all members
TIBCO.EFTL.IConnectionListener Interface Reference

Connection event handler. More...

Public Member Functions

void OnConnect (IConnection connection)
 A new connection to the eFTL server is ready to use. More...
 
void OnDisconnect (IConnection connection, int code, String reason)
 A connection to the eFTL server has closed. More...
 
void OnError (IConnection connection, int code, String reason)
 An error prevented an operation. The connection remains open. More...
 
void OnReconnect (IConnection connection)
 A connection to the eFTL server has re-opened and is ready to use. More...
 

Detailed Description

Connection event handler.

You must implement this interface to process connection events.

Supply an instance when you call EFTL.Connect(String, Hashtable, IConnectionListener).

Member Function Documentation

void TIBCO.EFTL.IConnectionListener.OnConnect ( IConnection  connection)

A new connection to the eFTL server is ready to use.

The eFTL library invokes this method only after your program calls EFTL.Connect (and not after IConnection.Reconnect).

Parameters
connectionThis connection is ready to use.
void TIBCO.EFTL.IConnectionListener.OnDisconnect ( IConnection  connection,
int  code,
String  reason 
)

A connection to the eFTL server has closed.

Possible codes include:

Parameters
connectionThis connection has closed.
codeThis code categorizes the condition. Your program can use this value in its response logic.
reasonThis string provides more detail. Your program can use this value in error reporting and logging.
void TIBCO.EFTL.IConnectionListener.OnError ( IConnection  connection,
int  code,
String  reason 
)

An error prevented an operation. The connection remains open.

Your implementation could alert the user.

Possible codes include:

Parameters
connectionThis connection reported an error.
codeThis code categorizes the error. Your program can use this value in its response logic.
reasonThis string provides more detail. Your program can use this value in error reporting and logging.
void TIBCO.EFTL.IConnectionListener.OnReconnect ( IConnection  connection)

A connection to the eFTL server has re-opened and is ready to use.

The eFTL library invokes this method only after your program calls IConnection.Reconnect (and not after EFTL.Connect).

Parameters
connectionThis connection is ready to use.