hmbdc
simplify-high-performance-messaging-programming
Public Member Functions | Friends | List of all members
hmbdc::app::netmap::RecvTransportEngine< OutBuffer, MsgArbitrator > Struct Template Reference

impl class, More...

#include <RecvTransportEngine.hpp>

Inheritance diagram for hmbdc::app::netmap::RecvTransportEngine< OutBuffer, MsgArbitrator >:
hmbdc::app::netmap::RecvTransport hmbdc::app::Client< RecvTransportEngine< OutBuffer, MsgArbitrator > > hmbdc::app::MessageHandler< RecvTransportEngine< OutBuffer, MsgArbitrator >, Subscribe, Unsubscribe > hmbdc::app::MessageHandler< RecvTransportEngine< OutBuffer, MsgArbitrator >, Messages... > hmbdc::pattern::PoolConsumer

Public Member Functions

void invokedCb (uint16_t threadSerialNumber) HMBDC_RESTRICT override
 
void handleMessageCb (Subscribe const &t)
 
void handleMessageCb (Unsubscribe const &t)
 
void stoppedCb (std::exception const &e) override
 
char const * hmbdcName () const
 
std::tuple< char const *, int > schedSpec () const
 
- Public Member Functions inherited from hmbdc::app::Client< RecvTransportEngine< OutBuffer, MsgArbitrator > >
 Client ()
 trivial constructor
 
void messageDispatchingStartedCb (uint16_t threadSerialNumber) override
 called before any messages got dispatched - only once More...
 
void stoppedCb (std::exception const &e) override
 callback called when this Client is taken out of message dispatching More...
 
bool droppedCb () override
 callback called after the Client is safely taken out of the Context More...
 
void invokedCb (uint16_t threadSerialNumber) override
 this callback is called all the time (frequently) More...
 
char const * hmbdcName () const
 return the name of thread that runs this client, override if necessary More...
 
std::tuple< char const *, int > schedSpec () const
 an overrideable method. returns the schedule policy and priority, override if necessary priority is only used when policy is "SCHED_RR", or "SCHED_FIFO" More...
 
size_t maxBatchMessageCount () const
 an overridable method. client receives events in batches and the max batch size is controllable when running in direct mode Context. Here is to specify the max size. More...
 
void handleRangeImpl (BufIt &it, BufIt const &end, uint16_t threadSerialNumber) override
 internal use, don't change or override
 
- Public Member Functions inherited from hmbdc::app::MessageHandler< RecvTransportEngine< OutBuffer, MsgArbitrator >, Messages... >
void handleMessage (MessageHead &w)
 
- Public Member Functions inherited from hmbdc::pattern::PoolConsumer
 PoolConsumer (bool interestedInMessages=true)
 
void stopped (std::exception const &) noexcept
 
bool dropped () noexcept
 
void messageDispatchingStarted (uint16_t threadId)
 
void invoked (uint16_t threadId)
 
- Public Member Functions inherited from hmbdc::app::MessageHandler< RecvTransportEngine< OutBuffer, MsgArbitrator >, Subscribe, Unsubscribe >
void handleMessage (MessageHead &w)
 

Friends

struct hmbdc::app::netmap::NetContext
 

Additional Inherited Members

- Public Types inherited from hmbdc::app::netmap::RecvTransport
using ptr = std::shared_ptr< RecvTransport >
 
- Public Types inherited from hmbdc::app::Client< RecvTransportEngine< OutBuffer, MsgArbitrator > >
enum  
 
- Static Public Member Functions inherited from hmbdc::app::MessageHandler< RecvTransportEngine< OutBuffer, MsgArbitrator >, Messages... >
static void tryDispatch (RecvTransportEngine< OutBuffer, MsgArbitrator > *p, MessageHead &w)
 
- Static Public Member Functions inherited from hmbdc::app::MessageHandler< RecvTransportEngine< OutBuffer, MsgArbitrator >, Subscribe, Unsubscribe >
static void tryDispatch (RecvTransportEngine< OutBuffer, MsgArbitrator > *p, MessageHead &w)
 
- Protected Types inherited from hmbdc::pattern::PoolConsumer
using BufIt = lf_misc::iterator< HMBDC_SEQ_TYPE >
 

Detailed Description

template<typename OutBuffer, typename MsgArbitrator = RecvTransport::NoOpArb>
struct hmbdc::app::netmap::RecvTransportEngine< OutBuffer, MsgArbitrator >

impl class,

this needs to be created using NetContext and start in an app::Context

Template Parameters
OutputBuffertype of buffer to hold resulting network messages
MsgArbitratorarbitrator to decide drop or keep messages, suited to arbitrate between different recv transports. By default, keeping all

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