Azure::Core::Amqp::Models::AmqpDescribed Class Reference

An AmqpDescribed represents an AMQP described type. More...

#include <amqp_value.hpp>

Public Member Functions
	AmqpDescribed (AmqpSymbol const &descriptor, AmqpValue const &value)
	Construct a new AmqpDescribed object.
	AmqpDescribed (AmqpDescribed &&other) noexcept=default
	Construct a new AmqpDescribed object by moving the contents of another AmqpDescribed object.
	AmqpDescribed (const AmqpDescribed &other)=default
	Copy constructor for AmqpDescribed.
AmqpDescribed &	operator= (AmqpDescribed &&other) noexcept=default
	Move assignment operator for AmqpDescribed.
AmqpDescribed &	operator= (const AmqpDescribed &other)=default
	Copy assignment operator for AmqpDescribed.
	AmqpDescribed (uint64_t descriptor, AmqpValue const &value)
	Construct a new AmqpDescribed object with a 64bit descriptor.
	AmqpDescribed (AmqpValue const &value)
	Construct a new AmqpDescribed object from an existing uAMQP AMQP_VALUE item.
bool	operator== (AmqpDescribed const &that) const
	Compare this AmqpDescribed value with another.
bool	operator!= (AmqpDescribed const &that) const
	Compare this AmqpDescribed value with another.
	operator AmqpValue const () const
	Convert an existing AmqpComposite to an AmqpValue.
AmqpValue const &	GetDescriptor () const
	Returns the descriptor for this composite type.
AmqpValue const &	GetValue () const
	Returns the descriptor for this composite type.
AmqpValue	AsAmqpValue () const
	Convert this AmqpDescribed to an AmqpValue.
bool	operator< (AmqpDescribed const &that) const
	Compare this AmqpDescribed value with another.

Detailed Description

Remarks

An AMQP Described type is a tuple consisting of a type and a "descriptor" for that type. The "descriptor" indicates that the AMQP object is a representation of the type.

Constructor & Destructor Documentation

AmqpDescribed() [1/5]

Azure::Core::Amqp::Models::AmqpDescribed::AmqpDescribed	(	AmqpSymbol const &	descriptor,
		AmqpValue const &	value
	)

By convention, AMQP Descriptor values are either symbolic or numeric. Other types are reserved.

Parameters

descriptor	- the Descriptor for the described value.
value	- the Value for the described value.

AmqpDescribed() [2/5]

Azure::Core::Amqp::Models::AmqpDescribed::AmqpDescribed ( AmqpDescribed &&  other )

defaultnoexcept

Parameters

other

- the AmqpDescribed object to move.

AmqpDescribed() [3/5]

Azure::Core::Amqp::Models::AmqpDescribed::AmqpDescribed ( const AmqpDescribed &  other )

default

Parameters

other

- the AmqpDescribed object to copy.

AmqpDescribed() [4/5]

Azure::Core::Amqp::Models::AmqpDescribed::AmqpDescribed	(	uint64_t	descriptor,
		AmqpValue const &	value
	)

Parameters

descriptor	- the Descriptor for the described value. The descriptor value SHOULD be one of the values from the AMQP specification.
value	- the Value for the described value.

AmqpDescribed() [5/5]

Azure::Core::Amqp::Models::AmqpDescribed::AmqpDescribed

(

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

AsAmqpValue()

AmqpValue Azure::Core::Amqp::Models::AmqpDescribed::AsAmqpValue

(

)

const

Returns

An AmqpValue containing this AmqpDescribed.

GetDescriptor()

AmqpValue const & Azure::Core::Amqp::Models::AmqpDescribed::GetDescriptor ( ) const

inline

Returns

The descriptor for this composite type.

GetValue()

AmqpValue const & Azure::Core::Amqp::Models::AmqpDescribed::GetValue ( ) const

inline

Returns

The descriptor for this composite type.

operator!=()

bool Azure::Core::Amqp::Models::AmqpDescribed::operator!= ( AmqpDescribed const &  that ) const

inline

Parameters

that	- the AmqpDescribed to compare with.

operator<()

bool Azure::Core::Amqp::Models::AmqpDescribed::operator< ( AmqpDescribed const &  that ) const

inline

Parameters

that	- the AmqpDescribed to compare with.

Returns

true if this AmqpDescribed is less than the other.

operator=() [1/2]

AmqpDescribed & Azure::Core::Amqp::Models::AmqpDescribed::operator= ( AmqpDescribed &&  other )

defaultnoexcept

Parameters

other

- the AmqpDescribed object to move.

Returns

reference to this AmqpDescribed object.

operator=() [2/2]

AmqpDescribed & Azure::Core::Amqp::Models::AmqpDescribed::operator= ( const AmqpDescribed &  other )

default

Parameters

other

- the AmqpDescribed object to copy.

Returns

reference to this AmqpDescribed object.

operator==()

bool Azure::Core::Amqp::Models::AmqpDescribed::operator== ( AmqpDescribed const &  that ) const

inline

Parameters

that	- the AmqpDescribed to compare with.

---

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

• inc/azure/core/amqp/models/amqp_value.hpp
• src/models/amqp_value.cpp