TIBCO eFTL™
Instance Methods | List of all members
<eFTLConnectionListener> Protocol Reference

Connection event handler. More...

Inheritance diagram for <eFTLConnectionListener>:

Instance Methods

(void) - connection:didDisconnectWithCode:reason:
 A connection to the eFTL server has closed. More...
 
(void) - connection:didFailWithCode:reason:
 An error prevented an operation. The connection remains open. More...
 
(void) - connectionDidConnect:
 A new connection to the eFTL server is ready to use. More...
 
(void) - connectionDidReconnect:
 A connection to the eFTL server has re-opened and is ready to use. More...
 

Detailed Description

Connection event handler.

You must implement this protocol to process connection events.

Supply an instance when you call connect:properties:listener: (eFTL).

Programs that reconnect must maintain a strong reference to the connection object. Otherwise the eFTL library releases the connection object upon disconnect.

Method Documentation

- (void) connection: (eFTLConnection *)  connection
didDisconnectWithCode: (NSInteger)  code
reason: (NSString *)  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) connection: (eFTLConnection *)  connection
didFailWithCode: (NSInteger)  code
reason: (NSString *)  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) connectionDidConnect: (eFTLConnection *)  connection

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

The eFTL library invokes this method only after your program calls connect:properties:listener: (eFTL) (and not after reconnectWithProperties: (eFTLConnection)).

Parameters
connectionThis connection is ready to use.
- (void) connectionDidReconnect: (eFTLConnection *)  connection
optional

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 connect:properties:listener: (eFTL) (and not after reconnectWithProperties: (eFTLConnection)).

Parameters
connectionThis connection is ready to use.

The documentation for this protocol was generated from the following file: