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

Subscription event handler. More...

Inheritance diagram for <eFTLSubscriptionListener>:

Instance Methods

(void) - didReceiveMessages:
 Process inbound messages. More...
 
(void) - subscription:didFailWithCode:reason:
 Process subscription errors. More...
 
(void) - subscriptionDidSubscribe:
 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 subscribeWithMatcher:durable:listener: (eFTLConnection) or subscribeWithMatcher:listener: (eFTLConnection).

Method Documentation

- (void) didReceiveMessages: (NSArray *)  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) subscription: (NSString *)  subscription
didFailWithCode: (NSInteger)  code
reason: (NSString *)  reason 

Process subscription errors.

Subscriptions can fail with the following codes:

Parameters
subscriptioneFTL 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) subscriptionDidSubscribe: (NSString *)  subscription
optional

A new subscription is ready to receive messages.

Your program receives the subscription identifier through this method.

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

To close the subscription, call unsubscribe: (eFTLConnection) with this subscription identifier.

Parameters
subscriptionThis subscription is ready.

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