lintel::EventBusEntry Class Reference

#include <EventBusEntry.h>

Inheritance diagram for lintel::EventBusEntry:

Public Member Functions
	EventBusEntry (const std::string_view &component, std::string eventBusName, std::string segmentName, std::size_t busCapacity, std::size_t subscriberCapacity, std::size_t maxTopics, std::size_t maxSubscribers)
const std::string &	getName () const
const std::string &	getSegment () const
constexpr std::size_t	getBusCapacity () const
constexpr std::size_t	getSubscriberCapacity () const
constexpr std::size_t	getMaxTopics () const
constexpr std::size_t	getMaxSubscribers () const
Public Member Functions inherited from lintel::Entry
	Entry (std::string_view component)
constexpr std::string_view	getConfigurationParserComponent () const

Friends
std::ostream &	operator<< (std::ostream &os, const EventBusEntry &entry)

Detailed Description

Configuration entry for an event bus

Constructor & Destructor Documentation

EventBusEntry()

lintel::EventBusEntry::EventBusEntry	(	const std::string_view &	component,
		std::string	eventBusName,
		std::string	segmentName,
		std::size_t	busCapacity,
		std::size_t	subscriberCapacity,
		std::size_t	maxTopics,
		std::size_t	maxSubscribers
	)

Construct an event bus entry

Parameters

component	The configuration component name
eventBusName	The bus name
segmentName	The shared memory segment name
busCapacity	The point-to-point queue capacity
subscriberCapacity	The per-subscriber queue capacity
maxTopics	The maximum topic count
maxSubscribers	The maximum subscriber count

Member Function Documentation

getBusCapacity()

constexpr std::size_t lintel::EventBusEntry::getBusCapacity ( ) const

inlineconstexpr

Get the point-to-point queue capacity

Returns

The bus capacity

getMaxSubscribers()

constexpr std::size_t lintel::EventBusEntry::getMaxSubscribers ( ) const

inlineconstexpr

Get the maximum subscriber count

Returns

The maximum subscribers

getMaxTopics()

constexpr std::size_t lintel::EventBusEntry::getMaxTopics ( ) const

inlineconstexpr

Get the maximum topic count

Returns

The maximum topics

getName()

const std::string & lintel::EventBusEntry::getName

(

)

const

Get the event bus name

Returns

The bus name

getSegment()

const std::string & lintel::EventBusEntry::getSegment

(

)

const

Get the shared memory segment name

Returns

The segment name

getSubscriberCapacity()

constexpr std::size_t lintel::EventBusEntry::getSubscriberCapacity ( ) const

inlineconstexpr

Get the per-subscriber queue capacity

Returns

The subscriber capacity

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const EventBusEntry &  entry  )

friend

Stream insertion operator

Parameters

os	The output stream
entry	The entry to output

Returns

The output stream

---

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

• src/include/lintel/features/base/configuration/EventBusEntry.h