azure-core-amqp
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Azure::Core::Amqp::Models::AmqpComposite Class Referencefinal

An AmqpComposite represents a sequentially ordered list of values. The values of the composite may have different types. More...

#include <amqp_value.hpp>

Inheritance diagram for Azure::Core::Amqp::Models::AmqpComposite:

Public Member Functions

 AmqpComposite ()
 Construct a new AmqpComposite object.
 
 AmqpComposite (AmqpValue const &descriptor, std::initializer_list< AmqpValue > const &values)
 Construct a new AmqpComposite object with an initializer list.
 
 AmqpComposite (const AmqpComposite &other)=default
 Construct a new AmqpComposite object from another.
 
AmqpCompositeoperator= (const AmqpComposite &other)=default
 Copy assignment operator.
 
 AmqpComposite (AmqpComposite &&other) noexcept=default
 Move constructor.
 
AmqpCompositeoperator= (AmqpComposite &&other) noexcept=default
 Move assignment operator.
 
 AmqpComposite (AmqpValue const &value)
 Construct a new AmqpComposite object from an existing uAMQP AMQP_VALUE item.
 
bool operator== (AmqpComposite const &that) const
 Compare this AmqpComposite value with another.
 
bool operator!= (AmqpComposite const &that) const
 Compare this AmqpComposite value with another.
 
AmqpValue const & GetDescriptor () const
 Returns the descriptor for this composite type.
 

Detailed Description

Remarks
An AMQP Composite type is a composite value where each value consists of an ordered sequence of fields, each with a specified name, type and multiplicity. They roughly correspond to a C or C++ "struct" type.
Note
The AMQP Composite type representation does NOT include the underlying field names, just the field values.

Constructor & Destructor Documentation

◆ AmqpComposite() [1/2]

Azure::Core::Amqp::Models::AmqpComposite::AmqpComposite ( AmqpComposite &&  other)
defaultnoexcept
Parameters
othercomposite value to move.

◆ AmqpComposite() [2/2]

Azure::Core::Amqp::Models::AmqpComposite::AmqpComposite ( AmqpValue const &  value)
Remarks
Note that this does NOT capture the passed in AMQP_VALUE object, the caller is responsible for freeing that object.
This is an internal accessor and should never be used by code outside the AMQP implementation.
Parameters
value- the AMQP array value to capture.

Member Function Documentation

◆ GetDescriptor()

AmqpValue const & Azure::Core::Amqp::Models::AmqpComposite::GetDescriptor ( ) const
inline
Returns
The descriptor for this composite type.

◆ operator!=()

bool Azure::Core::Amqp::Models::AmqpComposite::operator!= ( AmqpComposite const &  that) const
inline
Parameters
that- the AmqpComposite to compare with.

◆ operator=() [1/2]

AmqpComposite & Azure::Core::Amqp::Models::AmqpComposite::operator= ( AmqpComposite &&  other)
defaultnoexcept
Parameters
othercomposite value to move.
Returns
reference to this composite value.

◆ operator=() [2/2]

AmqpComposite & Azure::Core::Amqp::Models::AmqpComposite::operator= ( const AmqpComposite other)
default
Parameters
othercomposite value to copy.
Returns
reference to this composite value.

◆ operator==()

bool Azure::Core::Amqp::Models::AmqpComposite::operator== ( AmqpComposite const &  that) const
inline
Parameters
that- the AmqpComposite to compare with.

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