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

Subscription event handler. More...

Public Member Functions

void OnError (String subscriptionId, int code, String reason)
 Process subscription errors. More...
 
void OnMessages (IMessage[] messages)
 Process inbound messages. More...
 
void OnSubscribe (String subscriptionId)
 A new subscription is ready to receive messages. More...
 

Detailed Description

Subscription event handler.

You must implement this interface to process inbound messages and other subscription events.

Supply an instance when you call IConnection.Subscribe(String, String, ISubscriptionListener) or IConnection.Subscribe(String, ISubscriptionListener).

Member Function Documentation

void TIBCO.EFTL.ISubscriptionListener.OnError ( String  subscriptionId,
int  code,
String  reason 
)

Process subscription errors.

Possible returned codes include:

Parameters
subscriptionIdeFTL could not establish this subscription.
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.ISubscriptionListener.OnMessages ( IMessage[]  messages)

Process inbound messages.

The eFTL library presents inbound messages to this method for processing. You must implement this method to process the messages.

The messages are not thread-safe. You may access a message in any thread, but in only one thread at a time.

Parameters
messagesInbound messages.
void TIBCO.EFTL.ISubscriptionListener.OnSubscribe ( String  subscriptionId)

A new subscription is ready to receive messages.

The eFTL library may invoke this method after the first message arrives.

To close the subscription, call IConnection.Unsubscribe with this subscription identifier.

Parameters
subscriptionIdThis subscription is ready.