so_5::mchain_props::capacity_t Class Reference

Parameters for defining chain size. More...

#include <mchain.hpp>

Public Member Functions
	capacity_t ()
	Default constructor.
bool	unlimited () const
	Is message chain have no size limit?
std::size_t	max_size () const
	Max size for size-limited chain.
memory_usage_t	memory_usage () const
	Memory allocation type for size-limited chain.
overflow_reaction_t	overflow_reaction () const
	Overflow reaction for size-limited chain.
bool	is_overflow_timeout_defined () const
	Is waiting timeout for overflow case defined?
duration_t	overflow_timeout () const
	Get the value of waiting timeout for overflow case.

Static Public Member Functions
static capacity_t	make_unlimited ()
	Create capacity description for size-unlimited message chain.
static capacity_t	make_limited_without_waiting (std::size_t max_size, memory_usage_t memory_usage, overflow_reaction_t overflow_reaction)
static capacity_t	make_limited_with_waiting (std::size_t max_size, memory_usage_t memory_usage, overflow_reaction_t overflow_reaction, duration_t wait_timeout)

Private Member Functions
	capacity_t (std::size_t max_size, memory_usage_t memory_usage, overflow_reaction_t overflow_reaction, duration_t overflow_timeout)
	Initializing constructor for size-limited message chain.

Private Attributes
bool	m_unlimited = { true }
	Has chain unlimited size?
std::size_t	m_max_size
	Max size of the chain with limited size.
memory_usage_t	m_memory
	Type of the storage for size-limited chain.
overflow_reaction_t	m_overflow_reaction
	Type of reaction for chain overflow.
duration_t	m_overflow_timeout
	Timeout for waiting on full chain during 'message push' operation.

Detailed Description

Parameters for defining chain size.

Since

v.5.5.13

Definition at line 228 of file mchain.hpp.

Constructor & Destructor Documentation

capacity_t() [1/2]

so_5::mchain_props::capacity_t::capacity_t ( std::size_t max_size, memory_usage_t memory_usage, overflow_reaction_t overflow_reaction, duration_t overflow_timeout )

inlineprivate

Initializing constructor for size-limited message chain.

Definition at line 252 of file mchain.hpp.

capacity_t() [2/2]

so_5::mchain_props::capacity_t::capacity_t ( )

inline

Default constructor.

Creates description for size-unlimited chain.

Definition at line 269 of file mchain.hpp.

Member Function Documentation

is_overflow_timeout_defined()

bool so_5::mchain_props::capacity_t::is_overflow_timeout_defined ( ) const

inline

Is waiting timeout for overflow case defined?

Attention

Has sence only for size-limited chain.

Definition at line 346 of file mchain.hpp.

make_limited_with_waiting()

static capacity_t so_5::mchain_props::capacity_t::make_limited_with_waiting ( std::size_t max_size, memory_usage_t memory_usage, overflow_reaction_t overflow_reaction, duration_t wait_timeout )

inlinestatic

Create capacity description for size-limited message chain with waiting on full queue during 'push message' operation.

Parameters

max_size	Max size of the chain.
memory_usage	Type of chain storage.
overflow_reaction	Reaction on chain overflow.
wait_timeout	Waiting time on full message chain.

Definition at line 298 of file mchain.hpp.

make_limited_without_waiting()

static capacity_t so_5::mchain_props::capacity_t::make_limited_without_waiting ( std::size_t max_size, memory_usage_t memory_usage, overflow_reaction_t overflow_reaction )

inlinestatic

Create capacity description for size-limited message chain without waiting on full queue during 'push message' operation.

Parameters

max_size	Max size of the chain.
memory_usage	Type of chain storage.
overflow_reaction	Reaction on chain overflow.

Definition at line 279 of file mchain.hpp.

make_unlimited()

static capacity_t so_5::mchain_props::capacity_t::make_unlimited ( )

inlinestatic

Create capacity description for size-unlimited message chain.

Definition at line 274 of file mchain.hpp.

max_size()

std::size_t so_5::mchain_props::capacity_t::max_size ( ) const

inline

Max size for size-limited chain.

Attention

Has sence only for size-limited chain.

Definition at line 325 of file mchain.hpp.

memory_usage()

memory_usage_t so_5::mchain_props::capacity_t::memory_usage ( ) const

inline

Memory allocation type for size-limited chain.

Attention

Has sence only for size-limited chain.

Definition at line 332 of file mchain.hpp.

overflow_reaction()

overflow_reaction_t so_5::mchain_props::capacity_t::overflow_reaction ( ) const

inline

Overflow reaction for size-limited chain.

Attention

Has sence only for size-limited chain.

Definition at line 339 of file mchain.hpp.

overflow_timeout()

duration_t so_5::mchain_props::capacity_t::overflow_timeout ( ) const

inline

Get the value of waiting timeout for overflow case.

Attention

Has sence only for size-limited chain.

Definition at line 356 of file mchain.hpp.

unlimited()

bool so_5::mchain_props::capacity_t::unlimited ( ) const

inline

Is message chain have no size limit?

Definition at line 318 of file mchain.hpp.

Member Data Documentation

m_max_size

std::size_t so_5::mchain_props::capacity_t::m_max_size

private

Max size of the chain with limited size.

Definition at line 236 of file mchain.hpp.

m_memory

memory_usage_t so_5::mchain_props::capacity_t::m_memory

private

Type of the storage for size-limited chain.

Definition at line 239 of file mchain.hpp.

m_overflow_reaction

overflow_reaction_t so_5::mchain_props::capacity_t::m_overflow_reaction

private

Type of reaction for chain overflow.

Definition at line 242 of file mchain.hpp.

m_overflow_timeout

duration_t so_5::mchain_props::capacity_t::m_overflow_timeout

private

Timeout for waiting on full chain during 'message push' operation.

Note

Value 'zero' means that there must not be waiting on full chain.

Definition at line 249 of file mchain.hpp.

m_unlimited

bool so_5::mchain_props::capacity_t::m_unlimited = { true }

private

Has chain unlimited size?

Definition at line 231 of file mchain.hpp.

---

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

• mchain.hpp