YAMI4 Core Library 2.0.0
Messaging Solution for Distributed Systems
Loading...
Searching...
No Matches
Public Member Functions | List of all members
yami::core::channel_descriptor Class Reference

Descriptor handle for the physical channel. More...

#include <channel_descriptor.h>

Public Member Functions

 channel_descriptor ()
 Constructor. More...
 
 channel_descriptor (std::size_t index, std::size_t sequence_number)
 
void get_details (std::size_t &index, std::size_t &sequence_number) const
 
bool operator== (const channel_descriptor &other) const
 Comparison operator. More...
 
bool operator!= (const channel_descriptor &other) const
 Comparison operator. More...
 

Detailed Description

Descriptor handle for the physical channel.

The descriptor handle for the physical channel that provides immediate access to the underlying channel object.

The descriptor provides safe access in the sense that dangling descriptors are recognized and reported.

Constructor & Destructor Documentation

◆ channel_descriptor()

yami::core::channel_descriptor::channel_descriptor ( )
inline

Constructor.

Creates a default descriptor that is not associated with any existing channel.

Two default descriptors are considered equal.

Member Function Documentation

◆ operator!=()

bool yami::core::channel_descriptor::operator!= ( const channel_descriptor other) const
inline

Comparison operator.

Compares two descriptors.

Returns
Reverse to operator==

◆ operator==()

bool yami::core::channel_descriptor::operator== ( const channel_descriptor other) const
inline

Comparison operator.

Compares two descriptors for equality.

Returns
  • true if the other descriptor points to the same physical channel
  • false otherwise

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