Entry to subscribe/unsubscribe to/from an event-group. More...

#include <eventgroup_entry.h>

Inheritance diagram for ara::com::entry::EventgroupEntry:

Public Member Functions
	EventgroupEntry (EventgroupEntry &&other)

EventgroupEntry &	operator= (EventgroupEntry &&other)

uint8_t	Counter () const noexcept
	Get the subscriber counter. More...

uint16_t	EventgroupId () const noexcept
	Get event-group ID. More...

virtual std::vector< uint8_t >	Payload (uint8_t &optionIndex) const override
	Get entity payload. More...

Public Member Functions inherited from ara::com::entry::Entry
	Entry (Entry &&other)

Entry &	operator= (Entry &&other)

EntryType	Type () const noexcept
	Get entry type. More...

uint16_t	ServiceId () const noexcept
	Get service ID. More...

uint16_t	InstanceId () const noexcept
	Get instance ID. More...

uint8_t	MajorVersion () const noexcept
	Get major version. More...

uint32_t	TTL () const noexcept
	Get TTL. More...

const std::vector< std::unique_ptr< option::Option > > &	FirstOptions () const noexcept
	Get first (general) options. More...

void	AddFirstOption (std::unique_ptr< option::Option > firstOption)
	Add a first (general) option. More...

const std::vector< std::unique_ptr< option::Option > > &	SecondOptions () const noexcept
	Get second (specific) options. More...

void	AddSecondOption (std::unique_ptr< option::Option > secondOption)
	Add a second (specific) option. More...

Static Public Member Functions
static std::unique_ptr< EventgroupEntry >	CreateSubscribeEventEntry (uint16_t serviceId, uint16_t instanceId, uint8_t majorVersion, uint8_t counter, uint16_t eventgroupId)
	Subscribe to an event-group entry factory. More...

static std::unique_ptr< EventgroupEntry >	CreateUnsubscribeEventEntry (uint16_t serviceId, uint16_t instanceId, uint8_t majorVersion, uint8_t counter, uint16_t eventgroupId)
	Unsubscribe from an event-group entry factory. More...

static std::unique_ptr< EventgroupEntry >	CreateAcknowledgeEntry (const EventgroupEntry *eventgroupEntry)
	Positive acknowledge of an event-group entry factory. More...

static std::unique_ptr< EventgroupEntry >	CreateNegativeAcknowledgeEntry (const EventgroupEntry *eventgroupEntry)
	Negative acknowledge of an event-group entry factory. More...

static std::unique_ptr< EventgroupEntry >	Deserialize (const std::vector< uint8_t > &payload, std::size_t &offset, EntryType type, uint16_t serviceId, uint16_t instanceId, uint32_t ttl, uint8_t majorVersion)
	Deserialize a entry payload. More...

Protected Member Functions
virtual bool	ValidateOption (const option::Option *option) const noexcept override
	Validate an option for adding. More...

Protected Member Functions inherited from ara::com::entry::Entry
	Entry (EntryType type, uint16_t serviceId, uint16_t instanceId, uint32_t ttl, uint8_t majorVersion=cAnyMajorVersion) noexcept
	Constructor. More...

bool	ContainsOption (option::OptionType optionType) const noexcept
	Indicate whether the entry contains a specific option type or not. More...

virtual std::vector< uint8_t >	BasePayload (uint8_t &optionIndex) const
	Get baseentity payload. More...

Additional Inherited Members
Static Public Attributes inherited from ara::com::entry::Entry
static const uint16_t	cAnyInstanceId = 0xffff
	Any service instance ID.

static const uint8_t	cAnyMajorVersion = 0xff
	Any service major version.

static const uint8_t	cOptionSizeBitLength = 4
	Option number field bit size.

Detailed Description

Entry to subscribe/unsubscribe to/from an event-group.

Member Function Documentation

◆ Counter()

uint8_t ara::com::entry::EventgroupEntry::Counter ( ) const

noexcept

Get the subscriber counter.

Returns: A 4-bit unsinged integer wrapped as a byte

◆ CreateAcknowledgeEntry()

std::unique_ptr< EventgroupEntry > ara::com::entry::EventgroupEntry::CreateAcknowledgeEntry ( const EventgroupEntry * eventgroupEntry )

static

Positive acknowledge of an event-group entry factory.

Parameters

eventgroupEntry Received subscribe event-group entry

Returns: Acknowledge event-group subscription entry

◆ CreateNegativeAcknowledgeEntry()

std::unique_ptr< EventgroupEntry > ara::com::entry::EventgroupEntry::CreateNegativeAcknowledgeEntry ( const EventgroupEntry * eventgroupEntry )

static

Negative acknowledge of an event-group entry factory.

Parameters

eventgroupEntry Received subscribe event-group entry

Returns: Negative acknowledge event-group subscription entry

◆ CreateSubscribeEventEntry()

std::unique_ptr< EventgroupEntry > ara::com::entry::EventgroupEntry::CreateSubscribeEventEntry	(	uint16_t	serviceId,
		uint16_t	instanceId,
		uint8_t	majorVersion,
		uint8_t	counter,
		uint16_t	eventgroupId
	)

static

Subscribe to an event-group entry factory.

Parameters

serviceId	Service in interest ID
instanceId	Service in interest instance ID
majorVersion	Service in interest major version
counter	Counter to distinguish between subscribers
eventgroupId	Event-group in interest ID

Returns: Subscribe event-group entry

Exceptions

std::out_of_range Throws if counter is greater than 4 bits

◆ CreateUnsubscribeEventEntry()

std::unique_ptr< EventgroupEntry > ara::com::entry::EventgroupEntry::CreateUnsubscribeEventEntry	(	uint16_t	serviceId,
		uint16_t	instanceId,
		uint8_t	majorVersion,
		uint8_t	counter,
		uint16_t	eventgroupId
	)

static

Unsubscribe from an event-group entry factory.

Parameters

serviceId	Service in interest ID
instanceId	Service in interest instance ID
majorVersion	Service in interest major version
counter	Counter to distinguish between subscribers
eventgroupId	Event-group in interest ID

Returns: Unsubscribe event-group entry

Exceptions

std::out_of_range Throws if counter is greater than 4 bits

◆ Deserialize()

std::unique_ptr< EventgroupEntry > ara::com::entry::EventgroupEntry::Deserialize	(	const std::vector< uint8_t > &	payload,
		std::size_t &	offset,
		EntryType	type,
		uint16_t	serviceId,
		uint16_t	instanceId,
		uint32_t	ttl,
		uint8_t	majorVersion
	)

static

Deserialize a entry payload.

Parameters

payload	Serialized entry payload byte array
offset	Deserializing offset in the payload
type	Entry type
serviceId	Service in interest ID
instanceId	Service in interest instance ID
ttl	Entry time to live
majorVersion	Service in interest major version

Returns: Deserialized entry

Exceptions

std::out_of_range Throws when the entry type is not an event-group entry

◆ EventgroupId()

uint16_t ara::com::entry::EventgroupEntry::EventgroupId ( ) const

noexcept

Get event-group ID.

Returns: Event-group ID for subscription/unsubscription

◆ Payload()

std::vector< uint8_t > ara::com::entry::EventgroupEntry::Payload ( uint8_t & optionIndex ) const

overridevirtual

Get entity payload.

Parameters

optionIndex Index of the last added option

Returns: Byte array

Implements ara::com::entry::Entry.

◆ ValidateOption()

bool ara::com::entry::EventgroupEntry::ValidateOption ( const option::Option * option ) const

overrideprotectedvirtualnoexcept

Validate an option for adding.

Parameters

option Option of interest

Returns: True if the option is valid; otherwise false

Reimplemented from ara::com::entry::Entry.

Woman, Life, Freedom

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Counter()

◆ CreateAcknowledgeEntry()

◆ CreateNegativeAcknowledgeEntry()

◆ CreateSubscribeEventEntry()

◆ CreateUnsubscribeEventEntry()

◆ Deserialize()

◆ EventgroupId()

◆ Payload()

◆ ValidateOption()