OnixS C++ CME MDP Premium Market Data Handler 5.11.1
Users' manual and API documentation
Loading...
Searching...
No Matches
NetFeedEngine Class Referenceabstract

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

Public Member Functions

virtual ~NetFeedEngine ()=default
const std::string & engineId () const noexcept
std::string about ()
virtual void info (std::string &)=0
virtual NetFeedLink & allocate (const NetFeed &)=0
virtual WatchService & watch ()=0
virtual NetFeedEngineProcessResult process ()=0

Protected Member Functions

 NetFeedEngine (const NetFeedEngineSettings &settings=NetFeedEngineSettings{})
Logger & logger () const noexcept

Detailed Description

Abstraction for the Feed Engine machinery.

The given abstract class exposes the interface through which instances of the Handler class manipulate feeds.

Definition at line 127 of file FeedEngine.h.

Constructor & Destructor Documentation

◆ ~NetFeedEngine()

virtual ~NetFeedEngine ( )
virtualdefault

Finalizes the instance.

◆ NetFeedEngine()

NetFeedEngine ( const NetFeedEngineSettings & settings = NetFeedEngineSettings{})
explicitprotected

Constructs an engine and generates its identifier.

Parameters
settingsCommon network feed-engine settings.
Note
A custom logger configured in settings must outlive this engine.
Exceptions
std::bad_allocIf identifier storage allocation fails.

Member Function Documentation

◆ about()

std::string about ( )

Returns information about the actual feed-engine implementation.

Returns
Feed-engine implementation details.

◆ allocate()

virtual NetFeedLink & allocate ( const NetFeed & )
pure virtual

Constructs a link for the given feed.

Caller is responsible for releasing the returned instance using the NetFeedLink::release() member.

Implemented in SocketFeedEngine, and SolarflareFeedEngine.

◆ engineId()

const std::string & engineId ( ) const
inlinenoexcept

Returns the identifier generated for this engine.

Returns
Process-wide unique identifier.

Definition at line 189 of file FeedEngine.h.

◆ info()

virtual void info ( std::string & )
pure virtual

Provides information about the actual implementation of the feed engine.

Implemented in SocketFeedEngine, and SolarflareFeedEngine.

◆ logger()

Logger & logger ( ) const
inlineprotectednoexcept

Returns the logger selected when this engine was constructed.

Returns
Effective logger used by derived feed-engine implementations.

Definition at line 184 of file FeedEngine.h.

◆ process()

virtual NetFeedEngineProcessResult process ( )
pure virtual

Carries out pending actions like data retrieval and event dispatching.

The particular implementation of the feed engine concept may have own specific on returned value. Thus, see the documentation for the particular feed engine on the behavior and returned value.

Implemented in SocketFeedEngine, and SolarflareFeedEngine.

◆ watch()

virtual WatchService & watch ( )
pure virtual

A watch service used by the Feed Engine to assign timestamps for received packets and to track heartbeats.

Implemented in SocketFeedEngine, and SolarflareFeedEngine.