Qpid Proton C++  0.12.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Types | Public Member Functions | List of all members
terminus Class Reference

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

#include <terminus.hpp>

Public Types

enum  type { TYPE_UNSPECIFIED, SOURCE, TARGET, COORDINATOR }
 Type of terminus. More...
 
enum  durability { NONDURABLE, CONFIGURATION, DELIVERIES }
 Durability.
 
enum  expiry_policy { EXPIRE_WITH_LINK, EXPIRE_WITH_SESSION, EXPIRE_WITH_CONNECTION, EXPIRE_NEVER }
 Expiry policy.
 
enum  distribution_mode { MODE_UNSPECIFIED, COPY, MOVE }
 Distribution mode.
 

Public Member Functions

enum type type () const
 Get the terminus type.
 
void type (enum type)
 Set the terminus type.
 
enum expiry_policy expiry_policy () const
 Get the expiration policy.
 
void expiry_policy (enum expiry_policy)
 Set the expiration policy.
 
enum distribution_mode distribution_mode () const
 Get the distribution mode.
 
void distribution_mode (enum distribution_mode)
 Set the distribution mode.
 
enum durability durability ()
 Get the durability flag.
 
void durability (enum durability)
 Set the durability flag.
 
std::string address () const
 Get the source or target address.
 
void address (const std::string &)
 Set the source or target address.
 
bool dynamic () const
 True if the remote node is created dynamically.
 
void dynamic (bool)
 Enable or disable dynamic creation of the remote node.
 
valuenode_properties ()
 Obtain a reference to the AMQP dynamic node properties for the terminus. More...
 
const valuenode_properties () const
 Obtain a reference to the AMQP dynamic node properties for the terminus. More...
 
valuefilter ()
 Obtain a reference to the AMQP filter set for the terminus. More...
 
const valuefilter () const
 Obtain a reference to the AMQP filter set 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
Examples:
broker.hpp.

Member Enumeration Documentation

enum type

Type of terminus.

Enumerator
COORDINATOR 

Transaction coordinator.

Member Function Documentation

value& filter ( )

Obtain a reference to the AMQP filter set for the terminus.

See also link_options::selector.

const value& filter ( ) const

Obtain a reference to the AMQP filter set for the terminus.

See also link_options::selector.

value& node_properties ( )

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

See also link_options::lifetime_policy.

const value& node_properties ( ) const

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

See also link_options::lifetime_policy.


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