Qpid Proton C++ API  0.17.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
terminus Class Reference

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...
 

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.
 
value node_properties () const
 Obtain a reference to the AMQP dynamic node properties for the terminus. More...
 

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

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.

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

value node_properties ( ) const

Obtain a reference to the AMQP dynamic node properties for the terminus.

See also lifetime_policy.

duration timeout ( ) const

The period after which the source is discarded on expiry.

The duration is rounded to the nearest second.


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