Signbit MPSCQ  0.5.0
Public Member Functions | Protected Member Functions | List of all members
sbit::mpscq::Processor< Payload > Class Template Referenceabstract

#include <mpscq.h>

Inheritance diagram for sbit::mpscq::Processor< Payload >:
Inheritance graph
[legend]
Collaboration diagram for sbit::mpscq::Processor< Payload >:
Collaboration graph
[legend]

Public Member Functions

 Processor (Queue &queue)
 
- Public Member Functions inherited from sbit::mpscq::ProcessorBase
 ProcessorBase (Queue &queue)
 
virtual void afterBatch ()
 
virtual void onIdle ()
 
void startProcessing ()
 
void interrupt ()
 
 ProcessorBase (const ProcessorBase &other)=delete
 
ProcessorBaseoperator= (const ProcessorBase &other)=delete
 
 ProcessorBase (ProcessorBase &&other)=delete
 
ProcessorBaseoperator= (ProcessorBase &&other)=delete
 

Protected Member Functions

virtual void process (const Payload &payload)=0
 

Detailed Description

template<typename Payload>
class sbit::mpscq::Processor< Payload >

Strongly-typed consumer

Wraps the cast from the Queue::Envelope type to the Payload type

Template Parameters
PayloadIs the type of the useful payload processed via the queue

Constructor & Destructor Documentation

◆ Processor()

template<typename Payload >
sbit::mpscq::Processor< Payload >::Processor ( Queue queue)
inlineexplicit

Constructs a processor

Parameters
queueIs the queue from which elements are consumed

Member Function Documentation

◆ process()

template<typename Payload >
virtual void sbit::mpscq::Processor< Payload >::process ( const Payload &  payload)
protectedpure virtual

Process a message

Parameters
payloadIs the message contents to be processed
Returns
nothing

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