hmbdc
simplify-high-performance-messaging-programming
Public Member Functions | List of all members
hmbdc::app::mcast::RecvTransportEngineImpl< OutputBuffer, MsgArbitrator > Struct Template Reference

impl class More...

#include <RecvTransportEngine.hpp>

Inheritance diagram for hmbdc::app::mcast::RecvTransportEngineImpl< OutputBuffer, MsgArbitrator >:
hmbdc::app::mcast::RecvTransportImpl< OutputBuffer, MsgArbitrator > hmbdc::app::detail::single_thread_powered_client hmbdc::app::Client< RecvTransportEngineImpl< OutputBuffer, MsgArbitrator > > hmbdc::app::mcast::RecvTransport hmbdc::app::MessageHandler< RecvTransportImpl< OutputBuffer, MsgArbitrator >, Subscribe, Unsubscribe > hmbdc::app::MessageHandler< RecvTransportEngineImpl< OutputBuffer, MsgArbitrator >, Messages... > hmbdc::pattern::PoolConsumer hmbdc::app::mcast::Transport

Public Member Functions

char const * hmbdcName () const
 
std::tuple< char const *, int > schedSpec () const
 
void invokedCb (uint16_t) __restrict__ override
 power the io_service and other things
 
void messageDispatchingStartedCb (uint16_t threadSerialNumber) override
 start the show by schedule the mesage recv
 
void stoppedCb (std::exception const &e) override
 should not happen ever unless an exception thrown More...
 
- Public Member Functions inherited from hmbdc::app::mcast::RecvTransportImpl< OutputBuffer, MsgArbitrator >
 RecvTransportImpl (Config const &cfg, OutputBuffer &outputBuffer, MsgArbitrator arb=NoOpArb())
 ctor More...
 
void start ()
 start the show by schedule the mesage recv
 
void runOnce () __restrict__
 power the io_service and other things
 
void handleMessageCb (Subscribe const &t)
 only used by MH
 
void handleMessageCb (Unsubscribe const &t)
 only used by MH
 
void listenTo (Topic const &t) override
 
void stopListenTo (Topic const &t) override
 
boost::asio::ip::udp::socket & asioSocket ()
 expose so user can manipulate it More...
 
void initInThread ()
 
- Public Member Functions inherited from hmbdc::app::mcast::Transport
 Transport (Config const &cfg)
 
void initInThread ()
 
bool operator== (Transport const &other) const
 
bool operator< (Transport const &other) const
 
- Public Member Functions inherited from hmbdc::app::MessageHandler< RecvTransportImpl< OutputBuffer, MsgArbitrator >, Subscribe, Unsubscribe >
void handleMessage (MessageHead &w)
 
- Public Member Functions inherited from hmbdc::app::Client< RecvTransportEngineImpl< OutputBuffer, 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< RecvTransportEngineImpl< OutputBuffer, 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)
 

Additional Inherited Members

- Public Types inherited from hmbdc::app::mcast::RecvTransportImpl< OutputBuffer, MsgArbitrator >
using SELF = RecvTransportImpl
 
using MH = MessageHandler< SELF, Subscribe, Unsubscribe >
 
- Public Types inherited from hmbdc::app::mcast::RecvTransport
using ptr = std::shared_ptr< RecvTransport >
 
- Public Types inherited from hmbdc::app::mcast::Transport
using ptr = std::shared_ptr< Transport >
 
- Public Types inherited from hmbdc::app::Client< RecvTransportEngineImpl< OutputBuffer, MsgArbitrator > >
enum  
 
- Static Public Member Functions inherited from hmbdc::app::MessageHandler< RecvTransportImpl< OutputBuffer, MsgArbitrator >, Subscribe, Unsubscribe >
static void tryDispatch (RecvTransportImpl< OutputBuffer, MsgArbitrator > *p, MessageHead &w)
 
- Static Public Member Functions inherited from hmbdc::app::MessageHandler< RecvTransportEngineImpl< OutputBuffer, MsgArbitrator >, Messages... >
static void tryDispatch (RecvTransportEngineImpl< OutputBuffer, MsgArbitrator > *p, MessageHead &w)
 
- Protected Types inherited from hmbdc::app::mcast::Transport
using Buffer = hmbdc::pattern::LockFreeBufferT< 1 >
 
- Protected Types inherited from hmbdc::pattern::PoolConsumer
using BufIt = lf_misc::iterator< HMBDC_SEQ_TYPE >
 
- Protected Attributes inherited from hmbdc::app::mcast::Transport
string hmbdcName_
 
string schedPolicy_
 
int schedPriority_
 
Config const config_
 
std::shared_ptr< io_service > pIos_
 

Detailed Description

template<typename OutputBuffer, typename MsgArbitrator = RecvTransport::NoOpArb>
struct hmbdc::app::mcast::RecvTransportEngineImpl< OutputBuffer, 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, sued to arbitrate between difefrent recv transports. By default, keep all

Member Function Documentation

template<typename OutputBuffer, typename MsgArbitrator = RecvTransport::NoOpArb>
void hmbdc::app::mcast::RecvTransportEngineImpl< OutputBuffer, MsgArbitrator >::stoppedCb ( std::exception const &  e)
inlineoverridevirtual

should not happen ever unless an exception thrown

Parameters
eexception thown

Reimplemented from hmbdc::pattern::PoolConsumer.


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