Vanetza
 
Loading...
Searching...
No Matches
vanetza::dcc::BurstBudget Class Reference

#include <burst_budget.hpp>

Public Member Functions

 BurstBudget (const Runtime &)
 
Clock::duration delay ()
 
void notify ()
 
void burst_messages (std::size_t n)
 
void burst_duration (Clock::duration d)
 
void burst_period (Clock::duration p)
 
Clock::duration burst_period () const
 

Private Attributes

const Runtimem_runtime
 
boost::circular_buffer< Clock::time_point > m_messages
 
Clock::duration m_burst_duration
 
Clock::duration m_burst_period
 

Detailed Description

BurstBudget: TRC restrictions for DP0 message bursts as per C2C-CC BSP.

Definition at line 21 of file burst_budget.hpp.

Constructor & Destructor Documentation

◆ BurstBudget()

vanetza::dcc::BurstBudget::BurstBudget ( const Runtime rt)

Definition at line 19 of file burst_budget.cpp.

◆ ~BurstBudget()

vanetza::dcc::BurstBudget::~BurstBudget ( )

Definition at line 24 of file burst_budget.cpp.

Member Function Documentation

◆ burst_duration()

void vanetza::dcc::BurstBudget::burst_duration ( Clock::duration  d)

Set maximum duration per burst

Parameters
dburst duration

Definition at line 58 of file burst_budget.cpp.

◆ burst_messages()

void vanetza::dcc::BurstBudget::burst_messages ( std::size_t  n)

Set upper limit of messages per burst

Parameters
nburst limit

Definition at line 52 of file burst_budget.cpp.

◆ burst_period() [1/2]

Clock::duration vanetza::dcc::BurstBudget::burst_period ( ) const
inline

Get burst interval

Returns
bust interval

Definition at line 60 of file burst_budget.hpp.

◆ burst_period() [2/2]

void vanetza::dcc::BurstBudget::burst_period ( Clock::duration  p)

Set minimum duration between bursts

Parameters
pburst period

Definition at line 64 of file burst_budget.cpp.

◆ delay()

Clock::duration vanetza::dcc::BurstBudget::delay ( )

Get current delay to remain in budget

Returns
shortest delay not exceeding budget

Definition at line 28 of file burst_budget.cpp.

◆ notify()

void vanetza::dcc::BurstBudget::notify ( )

Notify budget of consumption

Definition at line 47 of file burst_budget.cpp.

Member Data Documentation

◆ m_burst_duration

Clock::duration vanetza::dcc::BurstBudget::m_burst_duration
private

Definition at line 65 of file burst_budget.hpp.

◆ m_burst_period

Clock::duration vanetza::dcc::BurstBudget::m_burst_period
private

Definition at line 66 of file burst_budget.hpp.

◆ m_messages

boost::circular_buffer<Clock::time_point> vanetza::dcc::BurstBudget::m_messages
private

Definition at line 64 of file burst_budget.hpp.

◆ m_runtime

const Runtime& vanetza::dcc::BurstBudget::m_runtime
private

Definition at line 63 of file burst_budget.hpp.


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