Qpid Proton C++ API  0.38.0
terminus

One end of a link, either a source or a target. More...

#include <terminus.hpp>

Inheritance diagram for terminus:
source target

Public Types

enum  durability_mode { NONDURABLE , CONFIGURATION , UNSETTLED_STATE }
 The persistence mode of the source or target. More...
 
enum  expiry_policy { LINK_CLOSE , SESSION_CLOSE , CONNECTION_CLOSE , NEVER }
 When expiration of the source or target begins. More...
 
typedef map< symbol, valuedynamic_property_map
 

Public Member Functions

enum expiry_policy expiry_policy () const
 Get the policy for when expiration begins.
 
duration timeout () const
 The period after which the source is discarded on expiry. More...
 
enum durability_mode durability_mode ()
 Get the durability flag.
 
bool dynamic () const
 True if the remote node is created dynamically.
 
bool anonymous () const
 True if the remote node is an anonymous-relay.
 
value node_properties () const
 Obtain the AMQP dynamic node properties for the terminus as a single value. More...
 
std::vector< symbolcapabilities () const
 Unsettled API Extension capabilities that are supported/requested
 
dynamic_property_map dynamic_properties () const
 Unsettled API Obtain the AMQP dynamic node properties for the terminus as a map.
 

Detailed Description

One end of a link, either a source or a target.

The source terminus is where messages originate; the target terminus is where they go.

See also
proton::link

Member Enumeration Documentation

◆ durability_mode

The persistence mode of the source or target.

Enumerator
NONDURABLE 

No persistence.

CONFIGURATION 

Only configuration is persisted.

UNSETTLED_STATE 

Configuration and unsettled state are persisted.

◆ expiry_policy

When expiration of the source or target begins.

Enumerator
LINK_CLOSE 

When the link is closed.

SESSION_CLOSE 

When the containing session is closed.

CONNECTION_CLOSE 

When the containing connection is closed.

NEVER 

The terminus never expires.

Member Function Documentation

◆ timeout()

duration timeout ( ) const

The period after which the source is discarded on expiry.

The duration is rounded to the nearest second.

◆ node_properties()

value node_properties ( ) const

Obtain the AMQP dynamic node properties for the terminus as a single value.

See also lifetime_policy.

Deprecated:
in favor of dynamic_properties()

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