1.0.0/api/SubscriptionListener_8h_source.html

#ifndef INCLUDED_Lightstreamer_SubscriptionListener

#define INCLUDED_Lightstreamer_SubscriptionListener


#include "Lightstreamer/ItemUpdate.h"

#include <string>


namespace Lightstreamer {


class SubscriptionListener {

public:

  virtual ~SubscriptionListener() {}

  virtual void onClearSnapshot(const std::string& itemName, int itemPos) {}

  virtual void onCommandSecondLevelItemLostUpdates(int lostUpdates, const std::string& key) {}

  virtual void onCommandSecondLevelSubscriptionError(int code, const std::string& message, const std::string& key) {}

  virtual void onEndOfSnapshot(const std::string& itemName, int itemPos) {}

  virtual void onItemLostUpdates(const std::string& itemName, int itemPos, int lostUpdates) {}

  virtual void onItemUpdate(ItemUpdate& update) {}

  virtual void onListenEnd() {}

  virtual void onListenStart() {}

  virtual void onSubscription() {}

  virtual void onSubscriptionError(int code, const std::string& message) {}

  virtual void onUnsubscription() {}

  virtual void onRealMaxFrequency(const std::string& frequency) {}

};


} // namespace Lightstreamer


#endif // INCLUDED_Lightstreamer_SubscriptionListener

Lightstreamer::ItemUpdate
Contains all the information related to an update of the field values for an item.
Definition ItemUpdate.h:32

Lightstreamer::SubscriptionListener
Interface to be implemented to listen to Subscription events comprehending notifications of subscript...
Definition SubscriptionListener.h:18

Lightstreamer::SubscriptionListener::onClearSnapshot
virtual void onClearSnapshot(const std::string &itemName, int itemPos)
Event handler that is called by Lightstreamer each time a request to clear the snapshot pertaining to...
Definition SubscriptionListener.h:41

Lightstreamer::SubscriptionListener::onCommandSecondLevelItemLostUpdates
virtual void onCommandSecondLevelItemLostUpdates(int lostUpdates, const std::string &key)
Event handler that is called by Lightstreamer to notify that, due to internal resource limitations,...
Definition SubscriptionListener.h:56

Lightstreamer::SubscriptionListener::onUnsubscription
virtual void onUnsubscription()
Event handler that is called by Lightstreamer to notify that a Subscription has been successfully uns...
Definition SubscriptionListener.h:215

Lightstreamer::SubscriptionListener::onListenStart
virtual void onListenStart()
Event handler that receives a notification when the SubscriptionListener instance is added to a Subsc...
Definition SubscriptionListener.h:149

Lightstreamer::SubscriptionListener::onSubscriptionError
virtual void onSubscriptionError(int code, const std::string &message)
Event handler that is called when the Server notifies an error on a Subscription.
Definition SubscriptionListener.h:201

Lightstreamer::SubscriptionListener::onCommandSecondLevelSubscriptionError
virtual void onCommandSecondLevelSubscriptionError(int code, const std::string &message, const std::string &key)
Event handler that is called when the Server notifies an error on a second-level subscription.
Definition SubscriptionListener.h:89

Lightstreamer::SubscriptionListener::onListenEnd
virtual void onListenEnd()
Event handler that receives a notification when the SubscriptionListener instance is removed from a S...
Definition SubscriptionListener.h:144

Lightstreamer::SubscriptionListener::onItemLostUpdates
virtual void onItemLostUpdates(const std::string &itemName, int itemPos, int lostUpdates)
Event handler that is called by Lightstreamer to notify that, due to internal resource limitations,...
Definition SubscriptionListener.h:131

Lightstreamer::SubscriptionListener::onSubscription
virtual void onSubscription()
Event handler that is called by Lightstreamer to notify that a Subscription has been successfully sub...
Definition SubscriptionListener.h:164

Lightstreamer::SubscriptionListener::onEndOfSnapshot
virtual void onEndOfSnapshot(const std::string &itemName, int itemPos)
Event handler that is called by Lightstreamer to notify that all snapshot events for an item in the S...
Definition SubscriptionListener.h:109

Lightstreamer::SubscriptionListener::onItemUpdate
virtual void onItemUpdate(ItemUpdate &update)
Event handler that is called by Lightstreamer each time an update pertaining to an item in the Subscr...
Definition SubscriptionListener.h:139

Lightstreamer::SubscriptionListener::onRealMaxFrequency
virtual void onRealMaxFrequency(const std::string &frequency)
Event handler that is called by Lightstreamer to notify the client with the real maximum update frequ...
Definition SubscriptionListener.h:233