Lightstreamer iOS Client  2.0.1
Native iOS Client library for Lightstreamer
Instance Methods | List of all members
<LSClientMessageDelegate> Protocol Reference

Protocol to be implemented to receive LSLightstreamerClient::sendMessage events reporting a message processing outcome. More...

#import <LSClientMessageDelegate.h>

Inheritance diagram for <LSClientMessageDelegate>:

Instance Methods

(void) - client:didAbortMessage:sentOnNetwork:
 Event handler that is called by Lightstreamer when any notifications of the processing outcome of the related message haven't been received yet and can no longer be received. More...
 
(void) - client:didDenyMessage:withCode:error:
 Event handler that is called by Lightstreamer when the related message has been processed by the Server but the expected processing outcome could not be achieved for any reason. More...
 
(void) - client:didDiscardMessage:
 Event handler that is called by Lightstreamer to notify that the related message has been discarded by the Server. More...
 
(void) - client:didFailMessage:
 Event handler that is called by Lightstreamer when the related message has been processed by the Server but the processing has failed for any reason. More...
 
(void) - client:didProcessMessage:
 Event handler that is called by Lightstreamer when the related message has been processed by the Server with success. More...
 

Detailed Description

Protocol to be implemented to receive LSLightstreamerClient::sendMessage events reporting a message processing outcome.


Events for these delegates are dispatched by a different thread than the one that generates them. All the notifications for a single LSLightstreamerClient, including notifications to LSClientDelegate s, LSSubscriptionDelegate s and LSClientMessageDelegate s will be dispatched by the same thread. Only one event per message is fired on this delegate.

Method Documentation

- (void) client: (nonnull LSLightstreamerClient *)  client
didAbortMessage: (nonnull NSString *)  originalMessage
sentOnNetwork: (BOOL)  sentOnNetwork 
optional

Event handler that is called by Lightstreamer when any notifications of the processing outcome of the related message haven't been received yet and can no longer be received.


Typically, this happens after the session has been closed. In this case, the client has no way of knowing the processing outcome and any outcome is possible.

Parameters
clientthe LSLightstreamerClient instance.
originalMessagethe message to which this notification is related.
sentOnNetworkYES if the message was sent on the network, false otherwise. Even if the flag is YES, it is not possible to infer whether the message actually reached the Lightstreamer Server or not.
- (void) client: (nonnull LSLightstreamerClient *)  client
didDenyMessage: (nonnull NSString *)  originalMessage
withCode: (NSInteger)  code
error: (nullable NSString *)  error 
optional

Event handler that is called by Lightstreamer when the related message has been processed by the Server but the expected processing outcome could not be achieved for any reason.

Parameters
clientthe LSLightstreamerClient instance.
originalMessagethe message to which this notification is related.
codethe error code sent by the Server. It can be one of the following:
  • <= 0 - the Metadata Adapter has refused the message; the code value is dependent on the specific Metadata Adapter implementation.
errorthe description of the error sent by the Server.
- (void) client: (nonnull LSLightstreamerClient *)  client
didDiscardMessage: (nonnull NSString *)  originalMessage 
optional

Event handler that is called by Lightstreamer to notify that the related message has been discarded by the Server.


This means that the message has not reached the Metadata Adapter and the message next in the sequence is considered enabled for processing.

Parameters
clientthe LSLightstreamerClient instance.
originalMessagethe message to which this notification is related.
- (void) client: (nonnull LSLightstreamerClient *)  client
didFailMessage: (nonnull NSString *)  originalMessage 
optional

Event handler that is called by Lightstreamer when the related message has been processed by the Server but the processing has failed for any reason.


The level of completion of the processing by the Metadata Adapter cannot be determined.

Parameters
clientthe LSLightstreamerClient instance.
originalMessagethe message to which this notification is related.
- (void) client: (nonnull LSLightstreamerClient *)  client
didProcessMessage: (nonnull NSString *)  originalMessage 
optional

Event handler that is called by Lightstreamer when the related message has been processed by the Server with success.

Parameters
clientthe LSLightstreamerClient instance.
originalMessagethe message to which this notification is related.

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