Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
Bus< MessageType > Class Template Reference

This is a namespace class that contains a variety of related classes for handling a bus that needs a polling loop. More...

#include <BusMaster.hxx>

Classes

class  Activity
 Abstract class that gets scheduled for polling and when the master decides to take it, gets a buffer to fill in with a packet. More...
 
class  Master
 The Bus Master class. More...
 

Public Types

using Packet = Buffer< MessageType >
 The buffer type that is handed around to the different participants.
 
using PacketPtr = BufferPtr< MessageType >
 Self-owned buffer type.
 
using PacketSink = FlowInterface< Packet >
 This is the consumer of the generated packets.
 

Private Member Functions

 Bus ()
 This class cannot be instantiated.
 

Detailed Description

template<class MessageType>
class Bus< MessageType >

This is a namespace class that contains a variety of related classes for handling a bus that needs a polling loop.

Definition at line 45 of file BusMaster.hxx.

Member Typedef Documentation

◆ Packet

template<class MessageType >
using Bus< MessageType >::Packet = Buffer<MessageType>

The buffer type that is handed around to the different participants.

Definition at line 49 of file BusMaster.hxx.

◆ PacketPtr

template<class MessageType >
using Bus< MessageType >::PacketPtr = BufferPtr<MessageType>

Self-owned buffer type.

Definition at line 52 of file BusMaster.hxx.

◆ PacketSink

template<class MessageType >
using Bus< MessageType >::PacketSink = FlowInterface<Packet>

This is the consumer of the generated packets.

Usually a device driver or something like that.

Definition at line 56 of file BusMaster.hxx.


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