OnixS C++ CME Market Data Handler  5.4.0
API documentation
NetFeedConsumer Class Referenceabstract

#include <OnixS/CME/MDH/FeedConsumer.h>

Public Member Functions

virtual bool tryAcquire ()=0
 
virtual void release ()=0
 
virtual void onPacket (const NetPacket &)=0
 
virtual void onTimeout (const NetFeed &)=0
 
virtual void onExpiration (const NetFeed &)=0
 
virtual void onFailure (const NetFeed &, const Char *)=0
 

Protected Member Functions

 NetFeedConsumer ()
 
virtual ~NetFeedConsumer ()
 

Detailed Description

Represents an interface through which the Feed Engine pushes market data received for the feeds.

Definition at line 35 of file FeedConsumer.h.

Constructor & Destructor Documentation

NetFeedConsumer ( )
inlineprotected

Protected construction for descendants.

Definition at line 46 of file FeedConsumer.h.

virtual ~NetFeedConsumer ( )
inlineprotectedvirtual

Lifetime of the instance is not maintained through the interface of the given class.

Definition at line 52 of file FeedConsumer.h.

Member Function Documentation

virtual void onExpiration ( const NetFeed )
pure virtual

Invoked by the feed engine machinery when the feed associated with the given consumer has reached its expiration time. The expiration time for the feed is defined by the 'expirationTime' member.

The given member must be invoked only when the consumer was already successfully acquired.

virtual void onFailure ( const NetFeed ,
const Char  
)
pure virtual

Invoked by the feed engine machinery when it experienced an issue while receiving data for the feed associated with the given consumer.

The given member must be invoked only when the consumer was already successfully acquired.

virtual void onPacket ( const NetPacket )
pure virtual

Invoked by the feed engine machinery when a packet is received for the feed associated with the given consumer.

The given member must be invoked only when the consumer was already successfully acquired.

virtual void onTimeout ( const NetFeed )
pure virtual

Invoked by the feed engine machinery when any packet wasn't received for the feed associated with the given consumer for a predefined amount of time.

The given member must be invoked only when the consumer was already successfully acquired.

virtual void release ( )
pure virtual

Releases previously acquired consumer.

virtual bool tryAcquire ( )
pure virtual

Tries to gain access to the given consumer.

Before invoking any other member, the consumer must be successfully acquired. This is because the consumer may be busy while handling the other event from the other source.


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