so_5::mchain_props Namespace Reference

Various properties and parameters of message chains. More...

Namespaces
namespace	details
	Implementation details.

Classes
class	capacity_t
	Parameters for defining chain size. More...
struct	demand_t
	Description of one demand in message chain. More...
class	mchain_template
	Template-based implementation of message chain. More...
class	select_case_t
	Base class for representation of one case in multi chain select. More...
class	select_notificator_t
	An interface of select_case notificator. More...

Typedefs
using	duration_t = std::chrono::high_resolution_clock::duration
	An alias for type for repesenting timeout values.
using	not_empty_notification_func_t = std::function< void() >
	Type of functor for notifies about arrival of a message to the empty chain.
using	empty_notification_func_t = std::function< void() >
	Type of functor to be called when a mchain becomes empty.
using	select_case_unique_ptr_t = std::unique_ptr< select_case_t >
	An alias of unique_ptr for select_case.

Enumerations
enum class	memory_usage_t { dynamic , preallocated }
	Memory allocation for storage for size-limited chains. More...
enum class	overflow_reaction_t { abort_app , throw_exception , drop_newest , remove_oldest }
	What reaction must be performed on attempt to push new message to the full message chain. More...
enum class	extraction_status_t { no_messages , msg_extracted , chain_closed }
	Result of extraction of message from a message chain. More...
enum class	push_status_t { not_stored , stored , deffered , chain_closed }
	Result of attempt of pushing a message into a message chain. More...
enum class	close_mode_t { drop_content , retain_content }
	What to do with chain's content at close. More...
enum class	msg_count_status_t { undefined , defined }
	Status of limit for messages to be extracted/handled during a bulk operation on a mchain. More...

Detailed Description

Various properties and parameters of message chains.

Since

v.5.5.13

Typedef Documentation

duration_t

using so_5::mchain_props::duration_t = std::chrono::high_resolution_clock::duration

An alias for type for repesenting timeout values.

Since

v.5.5.13

Definition at line 35 of file mchain.hpp.

empty_notification_func_t

using so_5::mchain_props::empty_notification_func_t = std::function< void() >

Type of functor to be called when a mchain becomes empty.

Attention

This function must be noexcept.

Since

v.5.8.5

Definition at line 441 of file mchain.hpp.

not_empty_notification_func_t

using so_5::mchain_props::not_empty_notification_func_t = std::function< void() >

Type of functor for notifies about arrival of a message to the empty chain.

Attention

This function must be noexcept.

Since

v.5.5.13

Definition at line 429 of file mchain.hpp.

select_case_unique_ptr_t

using so_5::mchain_props::select_case_unique_ptr_t = std::unique_ptr< select_case_t >

An alias of unique_ptr for select_case.

Since

v5.5.16

Definition at line 266 of file mchain_select_ifaces.hpp.

Enumeration Type Documentation

close_mode_t

enum class so_5::mchain_props::close_mode_t

strong

What to do with chain's content at close.

Since

v.5.5.13

Enumerator
drop_content	All messages must be removed from chain.
retain_content	All messages must be retained until they will be processed at receiver's side.

Definition at line 409 of file mchain.hpp.

extraction_status_t

enum class so_5::mchain_props::extraction_status_t

strong

Result of extraction of message from a message chain.

Since

v.5.5.13

Enumerator
no_messages	No available messages in the chain.
msg_extracted	Message extracted successfully.
chain_closed	Message cannot be extracted because chain is closed.

Definition at line 370 of file mchain.hpp.

memory_usage_t

enum class so_5::mchain_props::memory_usage_t

strong

Memory allocation for storage for size-limited chains.

Since

v.5.5.13

Enumerator
dynamic	Storage can be allocated and deallocated dynamically.
preallocated	Storage must be preallocated once and doesn't change after that.

Definition at line 181 of file mchain.hpp.

msg_count_status_t

enum class so_5::mchain_props::msg_count_status_t

strong

Status of limit for messages to be extracted/handled during a bulk operation on a mchain.

Since

v.5.6.0

Enumerator
undefined	Message count limit is not set yet.
defined	Message count limit is set.

Definition at line 1081 of file mchain.hpp.

overflow_reaction_t

enum class so_5::mchain_props::overflow_reaction_t

strong

What reaction must be performed on attempt to push new message to the full message chain.

Since

v.5.5.13

Enumerator
abort_app	Application must be aborted.
throw_exception	An exception must be thrown. Note Since v.5.5.18 this value leads to an exception only if ordinary send is used for pushing message to overloaded message chain. If there is an attempt to push delayed or periodic message to overloaded message chain then throw_exception reaction is replaced by drop_newest. It is becasue the context of timer thread is a special contex. No exceptions should be thrown on it.
drop_newest	New message must be ignored and droped.
remove_oldest	Oldest message in chain must be removed.

Definition at line 198 of file mchain.hpp.

push_status_t

enum class so_5::mchain_props::push_status_t

strong

Result of attempt of pushing a message into a message chain.

Since

v.5.7.0

Enumerator
not_stored	Message wasn't stored.
stored	Message stored into a message chain.
deffered	Message is not stored but the store operation is registered into a message chain.
chain_closed	Message wasn't stored because chain is closed.

Definition at line 388 of file mchain.hpp.