CBOE Emulator  1.0
Public Member Functions | List of all members
DataFeed::Receiver< Handler > Class Template Reference

A multi-cast receiver for recreating a LOB::LimitOrderBook from network messages. More...

#include <receiver.hpp>

Public Member Functions

 Receiver (asio::io_context &io_context, const asio::ip::address &listen, const asio::ip::address &group, uint16_t port, Handler &handler_, bool reuse_enabled=true)
 Initialize a new data feed receiver. More...
 
const LOB::LimitOrderBookget_book ()
 Return the limit order book for this receiver. More...
 
bool is_session_active () const
 Return whether the trading session is active. More...
 
const Handler & get_handler () const
 Return the handler connected to this feed receiver. More...
 

Detailed Description

template<typename Handler>
class DataFeed::Receiver< Handler >

A multi-cast receiver for recreating a LOB::LimitOrderBook from network messages.

Template Parameters
Handlera callback type for handling messages from the receiver

Constructor & Destructor Documentation

◆ Receiver()

template<typename Handler >
DataFeed::Receiver< Handler >::Receiver ( asio::io_context &  io_context,
const asio::ip::address &  listen,
const asio::ip::address &  group,
uint16_t  port,
Handler &  handler_,
bool  reuse_enabled = true 
)
inline

Initialize a new data feed receiver.

Parameters
io_contextthe IO context to listen on
listenthe host address to listen on
groupthe address of the multi-cast address to join
portthe port to listen for packets on
handler_a callback for handling messages from the receiver
reuse_enabledwhether reuse is enabled for the listening host

Member Function Documentation

◆ get_book()

template<typename Handler >
const LOB::LimitOrderBook& DataFeed::Receiver< Handler >::get_book ( )
inline

Return the limit order book for this receiver.

Returns
a constant reference to this receiver's limit order book

◆ get_handler()

template<typename Handler >
const Handler& DataFeed::Receiver< Handler >::get_handler ( ) const
inline

Return the handler connected to this feed receiver.

Returns
a reference to the handler associated with this receiver

◆ is_session_active()

template<typename Handler >
bool DataFeed::Receiver< Handler >::is_session_active ( ) const
inline

Return whether the trading session is active.

Returns
true if the trading session has been started by the server

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