SObjectizer  5.7
Public Member Functions | Private Attributes | List of all members
so_5::mchain_receive_result_t Class Reference

A result of receive from mchain. More...

#include <mchain.hpp>

Public Member Functions

 mchain_receive_result_t () noexcept
 Default constructor. More...
 
 mchain_receive_result_t (std::size_t extracted, std::size_t handled, mchain_props::extraction_status_t status) noexcept
 Initializing constructor. More...
 
std::size_t extracted () const noexcept
 Count of extracted messages. More...
 
std::size_t handled () const noexcept
 Count of handled messages. More...
 
mchain_props::extraction_status_t status () const noexcept
 Extraction status (e.g. no messages, chain closed and so on). More...
 

Private Attributes

std::size_t m_extracted
 Count of extracted messages. More...
 
std::size_t m_handled
 Count of handled messages. More...
 
mchain_props::extraction_status_t m_status
 Extraction status (e.g. no messages, chain closed and so on). More...
 

Detailed Description

A result of receive from mchain.

Since
v.5.5.13

Constructor & Destructor Documentation

◆ mchain_receive_result_t() [1/2]

so_5::mchain_receive_result_t::mchain_receive_result_t ( )
inlinenoexcept

Default constructor.

◆ mchain_receive_result_t() [2/2]

so_5::mchain_receive_result_t::mchain_receive_result_t ( std::size_t  extracted,
std::size_t  handled,
mchain_props::extraction_status_t  status 
)
inlinenoexcept

Initializing constructor.

Parameters
extractedCount of extracted messages.
handledCount of handled messages.
statusStatus of extraction operation.

Member Function Documentation

◆ extracted()

std::size_t so_5::mchain_receive_result_t::extracted ( ) const
inlinenoexcept

Count of extracted messages.

◆ handled()

std::size_t so_5::mchain_receive_result_t::handled ( ) const
inlinenoexcept

Count of handled messages.

◆ status()

mchain_props::extraction_status_t so_5::mchain_receive_result_t::status ( ) const
inlinenoexcept

Extraction status (e.g. no messages, chain closed and so on).

Member Data Documentation

◆ m_extracted

std::size_t so_5::mchain_receive_result_t::m_extracted
private

Count of extracted messages.

◆ m_handled

std::size_t so_5::mchain_receive_result_t::m_handled
private

Count of handled messages.

◆ m_status

mchain_props::extraction_status_t so_5::mchain_receive_result_t::m_status
private

Extraction status (e.g. no messages, chain closed and so on).


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