OnixS C++ CME MDP Conflated UDP Handler  1.1.2
API documentation
NetFeedLink Class Referenceabstract

#include <OnixS/CME/ConflatedUDP/FeedLink.h>

Public Member Functions

virtual void link (const NetFeed &, UInt32, std::string &)=0
 
virtual void unlink (const NetFeed &)=0
 
virtual void send (const NetFeed &, const void *, size_t, UInt32)=0
 
virtual void release (const NetFeed &)=0
 

Protected Member Functions

 NetFeedLink ()
 
virtual ~NetFeedLink ()
 

Detailed Description

Abstraction of a link used by the NetFeed instances to cover transportation layer.

The actual implementations are provided by a particular feed engine, whereas the NetFeed class interacts with the feed engine through the given abstraction.

Definition at line 38 of file FeedLink.h.

Constructor & Destructor Documentation

NetFeedLink ( )
inlineprotected

Instances are constructed through descendants.

Definition at line 49 of file FeedLink.h.

virtual ~NetFeedLink ( )
inlineprotectedvirtual

Instances aren't destructed in a regular way. The 'release()' member serves for that purpose.

Definition at line 55 of file FeedLink.h.

Member Function Documentation

virtual void link ( const NetFeed ,
UInt32  ,
std::string &   
)
pure virtual

Establishes connection for the given feed.

The timeout parameter specifies amount of time allocated for the link to get into connected/linked state. The string parameter is used by the feed engine to report on non-critical issues which may take place while establishing communication link.

virtual void release ( const NetFeed )
pure virtual

Releases the link used by the given feed. Once invoked, no other members are invoked afterwards any more.

virtual void send ( const NetFeed ,
const void *  ,
size_t  ,
UInt32   
)
pure virtual

Sends the given message to the counterpart.

The given member is invoked by Handler only for the feeds assuming bi-directional communication like the historical ones. Multicast links aren't supposed to provide the given functionality and thus may raise an exception.

virtual void unlink ( const NetFeed )
pure virtual

Closes communication link for the given feed.


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