target_options Class Reference

Options for creating a target node for a sender or receiver. More...

#include <target_options.hpp>

List of all members.

Public Member Functions

 target_options ()
 Create an empty set of options.
 target_options (const target_options &)
 Copy options.
target_optionsoperator= (const target_options &)
 Copy options.
target_optionsaddress (const std::string &addr)
 Set the address for the target.
target_optionsdynamic (bool)
 Request that a node be dynamically created by the remote peer.
target_optionsanonymous (bool)
 Request an anonymous node on the remote peer.
target_optionsdurability_mode (enum target::durability_mode)
 Control the persistence of the target node.
target_optionstimeout (duration)
 The expiry period after which the target is discarded.
target_optionsexpiry_policy (enum target::expiry_policy)
 Control when the clock for expiration begins.
target_optionscapabilities (const std::vector< symbol > &)
 Extension capabilities that are supported/requested.

Detailed Description

Options for creating a target node for a sender or receiver.

Options can be "chained". For more information see proton::connection_options.

Normal value semantics: copy or assign creates a separate copy of the options.


Member Function Documentation

target_options& address ( const std::string &  addr  ) 

Set the address for the target.

It is unset by default. The address is ignored if dynamic() is true.

target_options& dynamic ( bool   ) 

Request that a node be dynamically created by the remote peer.

The default is false. Any specified target address() is ignored if true.

target_options& anonymous ( bool   ) 

Request an anonymous node on the remote peer.

The default is false. Any specified target address() is ignored if true.

target_options& durability_mode ( enum target::durability_mode   ) 

Control the persistence of the target node.

The default is target::NONDURABLE, meaning non-persistent.

target_options& timeout ( duration   ) 

The expiry period after which the target is discarded.

The default is no timeout.

target_options& expiry_policy ( enum target::expiry_policy   ) 

Control when the clock for expiration begins.

The default is target::LINK_CLOSE.


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

Generated on 8 Oct 2019 for Qpid Proton C++ by  doxygen 1.6.1