http://git-wip-us.apache.org/repos/asf/qpid-site/blob/eff0fe55/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Connection.html ---------------------------------------------------------------------- diff --git a/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Connection.html b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Connection.html new file mode 100644 index 0000000..a14aca1 --- /dev/null +++ b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Connection.html @@ -0,0 +1,380 @@ + + + + + + +Qpid C++ Messaging API: qpid::messaging::Connection Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
Qpid C++ Messaging API +  1.35.0 +
+
+ + + + + + +
+
+
+ + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
+
qpid::messaging::Connection Class Reference
+
+
+ +

#include <Connection.h>

+
+Inheritance diagram for qpid::messaging::Connection:
+
+
+ + +qpid::messaging::Handle< ConnectionImpl > + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+QPID_MESSAGING_EXTERN Connection (ConnectionImpl *impl)
 
+QPID_MESSAGING_EXTERN Connection (const Connection &)
 
QPID_MESSAGING_EXTERN Connection (const std::string &url, const qpid::types::Variant::Map &options=qpid::types::Variant::Map())
 
QPID_MESSAGING_EXTERN Connection (const std::string &url, const std::string &options)
 
+QPID_MESSAGING_EXTERN Connectionoperator= (const Connection &)
 
+QPID_MESSAGING_EXTERN void setOption (const std::string &name, const qpid::types::Variant &value)
 
+QPID_MESSAGING_EXTERN void open ()
 
+QPID_MESSAGING_EXTERN bool isOpen ()
 
+QPID_MESSAGING_EXTERN bool isOpen () const
 
QPID_MESSAGING_EXTERN void reconnect (const std::string &url)
 
QPID_MESSAGING_EXTERN void reconnect ()
 
QPID_MESSAGING_EXTERN std::string getUrl () const
 
QPID_MESSAGING_EXTERN void close ()
 
+QPID_MESSAGING_EXTERN Session createTransactionalSession (const std::string &name=std::string())
 
+QPID_MESSAGING_EXTERN Session createSession (const std::string &name=std::string())
 
+QPID_MESSAGING_EXTERN Session getSession (const std::string &name) const
 
+QPID_MESSAGING_EXTERN std::string getAuthenticatedUsername ()
 
- Public Member Functions inherited from qpid::messaging::Handle< ConnectionImpl >
QPID_MESSAGING_INLINE_EXTERN bool isValid () const
 
QPID_MESSAGING_INLINE_EXTERN bool isNull () const
 
QPID_MESSAGING_INLINE_EXTERN operator bool () const
 
QPID_MESSAGING_INLINE_EXTERN bool operator! () const
 
+void swap (Handle< ConnectionImpl > &h)
 
+ + + +

+Friends

+class qpid::messaging::PrivateImplRef< Connection >
 
+ + + + + + + +

+Additional Inherited Members

- Protected Types inherited from qpid::messaging::Handle< ConnectionImpl >
+typedef ConnectionImpl Impl
 
- Protected Attributes inherited from qpid::messaging::Handle< ConnectionImpl >
+Impl * impl
 
+

Detailed Description

+

A connection represents a network connection to a remote endpoint.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
QPID_MESSAGING_EXTERN qpid::messaging::Connection::Connection (const std::string & url,
const qpid::types::Variant::Map & options = qpid::types::Variant::Map() 
)
+
+

Current implementation supports the following options:

+
    +
  • heartbeat: the heartbeat interval in seconds
  • +
  • tcp_nodelay: true/false, whether nagle should be disabled or not
  • +
  • transport: the underlying transport to use (e.g. tcp, ssl, rdma)
  • +
  • protocol: the version of AMQP to use (e.g. amqp0-10 or amqp1.0)
  • +
+

(Note: the transports and/or protocols recognised may depend on which plugins are loaded. AT present support for heartbeats is missing in AMQP 1.0)

+
    +
  • username: the username to authenticate as
  • +
  • password: the password to use if required by the selected authentication mechanism
  • +
  • sasl_mechanisms: a space separated list of acceptable SASL mechanisms
  • +
  • sasl_min_ssf: the minimum acceptable security strength factor
  • +
  • sasl_max_ssf: the maximum acceptable security strength factor
  • +
  • sasl_service: the service name if needed by the SASL mechanism in use
  • +
+

Reconnect behaviour can be controlled through the following options:

+
    +
  • reconnect: true/false (enables/disables reconnect entirely)
  • +
  • reconnect_timeout: seconds (give up and report failure after specified time)
  • +
  • reconnect_limit: n (give up and report failure after specified number of attempts)
  • +
  • reconnect_interval_min: seconds (initial delay between failed reconnection attempts)
  • +
  • reconnect_interval_max: seconds (maximum delay between failed reconnection attempts)
  • +
  • reconnect_interval: shorthand for setting the same reconnect_interval_min/max
  • +
  • reconnect_urls: list of alternate urls to try when connecting
  • +
+

The reconnect_interval is the time that the client waits for after a failed attempt to reconnect before retrying. It starts at the value of the min_retry_interval and is doubled every failure until the value of max_retry_interval is reached.

+

Values in seconds can be fractional, for example 0.001 is a millisecond delay.

+

If the SSL transport is used, the following options apply:

+
    +
  • ssl_cert_name: the name of the certificate to use for a given
  • +
  • connection ssl_ignore_hostname_verification_failure: if set to true, will allow client to connect to server even if the hostname used (or ip address) doesn't match what is in the servers certificate. I.e. this disables authentication of the server to the client (and should be used only as a last resort)
  • +
+

When AMQP 1.0 is used, the following options apply:

+
    +
  • container_id: sets the container id to use for the connection
  • +
  • nest_annotations: if true, any annotations in received messages will be presented as properties with keys x-amqp-delivery-annotations or x-amqp-delivery-annotations and values that are nested maps containing the annotations. If false, the annotations will simply be merged in with the properties.
  • +
  • set_to_on_send: If true, all sent messages will have the to field set to the node name of the sender
  • +
  • properties or client_properties: the properties to include in the open frame sent
  • +
+

The following options can be used to tune behaviour if needed (these are not yet supported over AMQP 1.0):

+
    +
  • tcp_nodelay: disables Nagle's algorithm on the underlying tcp socket
  • +
  • max_channels: restricts the maximum number of channels supported
  • +
  • max_frame_size: restricts the maximum frame size supported
  • +
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
QPID_MESSAGING_EXTERN qpid::messaging::Connection::Connection (const std::string & url,
const std::string & options 
)
+
+

Creates a connection using an option string of the form {name:value,name2:value2...}, see above for options supported.

+
Exceptions
+ + +
InvalidOptionStringif the string does not match the correct syntax
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + +
QPID_MESSAGING_EXTERN void qpid::messaging::Connection::close ()
+
+

Closes a connection and all sessions associated with it. An opened connection must be closed before the last handle is allowed to go out of scope.

+ +
+
+ +
+
+ + + + + + + +
QPID_MESSAGING_EXTERN std::string qpid::messaging::Connection::getUrl () const
+
+

returns a url reprsenting the broker the client is currently connected to (or an empty string if it is not connected).

+ +
+
+ +
+
+ + + + + + + + +
QPID_MESSAGING_EXTERN void qpid::messaging::Connection::reconnect (const std::string & url)
+
+

Attempts to reconnect to the specified url, re-establish existing sessions, senders and receivers and resend any indoubt messages.

+

This can be used to directly control reconnect behaviour rather than using the reconnect option for automatically handling that.

+ +
+
+ +
+
+ + + + + + + +
QPID_MESSAGING_EXTERN void qpid::messaging::Connection::reconnect ()
+
+

Attempts to reconnect to the original url, including any specified reconnect_urls, re-establish existing sessions, senders and receivers and resend any indoubt messages.

+

This can be used to directly control reconnect behaviour rather than using the reconnect option for automatically handling that.

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/eff0fe55/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Connection.js ---------------------------------------------------------------------- diff --git a/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Connection.js b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Connection.js new file mode 100644 index 0000000..2c3aae8 --- /dev/null +++ b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Connection.js @@ -0,0 +1,23 @@ +var classqpid_1_1messaging_1_1Connection = +[ + [ "Connection", "classqpid_1_1messaging_1_1Connection.html#ae52937fa9e15ceaf48091111c92df20a", null ], + [ "Connection", "classqpid_1_1messaging_1_1Connection.html#a9fe3af4ad4a25621065c30a677dcbabe", null ], + [ "Connection", "classqpid_1_1messaging_1_1Connection.html#ae74dacaa22c1171661ecde23328c7a42", null ], + [ "Connection", "classqpid_1_1messaging_1_1Connection.html#a4d3f1bacc02722f3d2ae43efaa880db6", null ], + [ "Connection", "classqpid_1_1messaging_1_1Connection.html#a7ed5f335b7614cd7b2b580ad92cbf3d2", null ], + [ "~Connection", "classqpid_1_1messaging_1_1Connection.html#a071c3ead15e6cde8217a5a2fc203bac6", null ], + [ "close", "classqpid_1_1messaging_1_1Connection.html#a57c6b7c5b7f99fe3b6e287f906a59b7b", null ], + [ "createSession", "classqpid_1_1messaging_1_1Connection.html#a2a966954dee57fd345547390f9919887", null ], + [ "createTransactionalSession", "classqpid_1_1messaging_1_1Connection.html#a80f1657463f9ed06f3f045ec5dc7bc5f", null ], + [ "getAuthenticatedUsername", "classqpid_1_1messaging_1_1Connection.html#a7934780583b5ac5f89e79f07423b52e4", null ], + [ "getSession", "classqpid_1_1messaging_1_1Connection.html#a1ec71cf620373cacbb7ffb14260244f4", null ], + [ "getUrl", "classqpid_1_1messaging_1_1Connection.html#a37a0bb2470e17aeb8257e1b1513fa0b6", null ], + [ "isOpen", "classqpid_1_1messaging_1_1Connection.html#a044525254da9ad9820a6e38ae8cb2d9e", null ], + [ "isOpen", "classqpid_1_1messaging_1_1Connection.html#a7e64496ab8722deecc24e1488aa6c287", null ], + [ "open", "classqpid_1_1messaging_1_1Connection.html#ae3edb48dd0f93bb27dc986820bd042d5", null ], + [ "operator=", "classqpid_1_1messaging_1_1Connection.html#abcdcdeddf5285cfc4ecb2675119c3f21", null ], + [ "reconnect", "classqpid_1_1messaging_1_1Connection.html#a2fba4dbb2563544316f3050d340c02dd", null ], + [ "reconnect", "classqpid_1_1messaging_1_1Connection.html#ac64520572413ec653b0d20c61887f0cc", null ], + [ "setOption", "classqpid_1_1messaging_1_1Connection.html#aed260d368e7a61444bd20536dd8ee0a8", null ], + [ "qpid::messaging::PrivateImplRef< Connection >", "classqpid_1_1messaging_1_1Connection.html#afcda8a5ddde952c834a8cd1bb7771b69", null ] +]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/eff0fe55/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Connection.png ---------------------------------------------------------------------- diff --git a/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Connection.png b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Connection.png new file mode 100644 index 0000000..1844bda Binary files /dev/null and b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Connection.png differ http://git-wip-us.apache.org/repos/asf/qpid-site/blob/eff0fe55/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Duration-members.html ---------------------------------------------------------------------- diff --git a/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Duration-members.html b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Duration-members.html new file mode 100644 index 0000000..437bc7a --- /dev/null +++ b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Duration-members.html @@ -0,0 +1,116 @@ + + + + + + +Qpid C++ Messaging API: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
Qpid C++ Messaging API +  1.35.0 +
+
+ + + + + + +
+
+
+ + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
qpid::messaging::Duration Member List
+
+
+ +

This is the complete list of members for qpid::messaging::Duration, including all inherited members.

+ + + + + + + +
Duration(uint64_t milliseconds) (defined in qpid::messaging::Duration)qpid::messaging::Durationexplicit
FOREVER (defined in qpid::messaging::Duration)qpid::messaging::Durationstatic
getMilliseconds() const (defined in qpid::messaging::Duration)qpid::messaging::Duration
IMMEDIATE (defined in qpid::messaging::Duration)qpid::messaging::Durationstatic
MINUTE (defined in qpid::messaging::Duration)qpid::messaging::Durationstatic
SECOND (defined in qpid::messaging::Duration)qpid::messaging::Durationstatic
+
+ + + + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/eff0fe55/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Duration.html ---------------------------------------------------------------------- diff --git a/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Duration.html b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Duration.html new file mode 100644 index 0000000..7145dda --- /dev/null +++ b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Duration.html @@ -0,0 +1,144 @@ + + + + + + +Qpid C++ Messaging API: qpid::messaging::Duration Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
Qpid C++ Messaging API +  1.35.0 +
+
+ + + + + + +
+
+
+ + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
+
qpid::messaging::Duration Class Reference
+
+
+ +

#include <Duration.h>

+ + + + + + +

+Public Member Functions

+QPID_MESSAGING_EXTERN Duration (uint64_t milliseconds)
 
+QPID_MESSAGING_EXTERN uint64_t getMilliseconds () const
 
+ + + + + + + + + +

+Static Public Attributes

+static QPID_MESSAGING_EXTERN const Duration FOREVER
 
+static QPID_MESSAGING_EXTERN const Duration IMMEDIATE
 
+static QPID_MESSAGING_EXTERN const Duration SECOND
 
+static QPID_MESSAGING_EXTERN const Duration MINUTE
 
+

Detailed Description

+

A duration is a time in milliseconds.

+

The documentation for this class was generated from the following file: +
+
+ + + + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/eff0fe55/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Duration.js ---------------------------------------------------------------------- diff --git a/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Duration.js b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Duration.js new file mode 100644 index 0000000..0e5d683 --- /dev/null +++ b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Duration.js @@ -0,0 +1,5 @@ +var classqpid_1_1messaging_1_1Duration = +[ + [ "Duration", "classqpid_1_1messaging_1_1Duration.html#a043c3696e7f124763204a6da14f874d8", null ], + [ "getMilliseconds", "classqpid_1_1messaging_1_1Duration.html#ab1346e5ea9b94dc82104826749632ab2", null ] +]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/eff0fe55/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1FailoverUpdates-members.html ---------------------------------------------------------------------- diff --git a/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1FailoverUpdates-members.html b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1FailoverUpdates-members.html new file mode 100644 index 0000000..8acd700 --- /dev/null +++ b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1FailoverUpdates-members.html @@ -0,0 +1,112 @@ + + + + + + +Qpid C++ Messaging API: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
Qpid C++ Messaging API +  1.35.0 +
+
+ + + + + + +
+
+
+ + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
qpid::messaging::FailoverUpdates Member List
+
+
+ +

This is the complete list of members for qpid::messaging::FailoverUpdates, including all inherited members.

+ + + +
FailoverUpdates(Connection &connection) (defined in qpid::messaging::FailoverUpdates)qpid::messaging::FailoverUpdates
~FailoverUpdates() (defined in qpid::messaging::FailoverUpdates)qpid::messaging::FailoverUpdates
+
+ + + + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/eff0fe55/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1FailoverUpdates.html ---------------------------------------------------------------------- diff --git a/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1FailoverUpdates.html b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1FailoverUpdates.html new file mode 100644 index 0000000..09fa7b4 --- /dev/null +++ b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1FailoverUpdates.html @@ -0,0 +1,125 @@ + + + + + + +Qpid C++ Messaging API: qpid::messaging::FailoverUpdates Class Reference + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
Qpid C++ Messaging API +  1.35.0 +
+
+ + + + + + +
+
+
+ + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
+
qpid::messaging::FailoverUpdates Class Reference
+
+
+ +

#include <FailoverUpdates.h>

+ + + + +

+Public Member Functions

+QPID_MESSAGING_EXTERN FailoverUpdates (Connection &connection)
 
+

Detailed Description

+

A utility to listen for updates on cluster membership and update the list of known urls for a connection accordingly.

+

The documentation for this class was generated from the following file: +
+
+ + + + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/eff0fe55/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1FailoverUpdates.js ---------------------------------------------------------------------- diff --git a/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1FailoverUpdates.js b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1FailoverUpdates.js new file mode 100644 index 0000000..f4ada19 --- /dev/null +++ b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1FailoverUpdates.js @@ -0,0 +1,5 @@ +var classqpid_1_1messaging_1_1FailoverUpdates = +[ + [ "FailoverUpdates", "classqpid_1_1messaging_1_1FailoverUpdates.html#a4042cc9b3ab0592a67e704ffcd97d56a", null ], + [ "~FailoverUpdates", "classqpid_1_1messaging_1_1FailoverUpdates.html#a24ce01b159ba534fe8d13883d425c399", null ] +]; \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/eff0fe55/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Handle-members.html ---------------------------------------------------------------------- diff --git a/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Handle-members.html b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Handle-members.html new file mode 100644 index 0000000..420eaf7 --- /dev/null +++ b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Handle-members.html @@ -0,0 +1,119 @@ + + + + + + +Qpid C++ Messaging API: Member List + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
Qpid C++ Messaging API +  1.35.0 +
+
+ + + + + + +
+
+
+ + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
qpid::messaging::Handle< T > Member List
+
+
+ +

This is the complete list of members for qpid::messaging::Handle< T >, including all inherited members.

+ + + + + + + + + + +
Handle() (defined in qpid::messaging::Handle< T >)qpid::messaging::Handle< T >inlineprotected
Impl typedef (defined in qpid::messaging::Handle< T >)qpid::messaging::Handle< T >protected
impl (defined in qpid::messaging::Handle< T >)qpid::messaging::Handle< T >protected
isNull() const qpid::messaging::Handle< T >inline
isValid() const qpid::messaging::Handle< T >inline
operator bool() const qpid::messaging::Handle< T >inline
operator!() const qpid::messaging::Handle< T >inline
PrivateImplRef< T > (defined in qpid::messaging::Handle< T >)qpid::messaging::Handle< T >friend
swap(Handle< T > &h) (defined in qpid::messaging::Handle< T >)qpid::messaging::Handle< T >inline
+
+ + + + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/eff0fe55/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Handle.html ---------------------------------------------------------------------- diff --git a/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Handle.html b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Handle.html new file mode 100644 index 0000000..2eb2878 --- /dev/null +++ b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Handle.html @@ -0,0 +1,263 @@ + + + + + + +Qpid C++ Messaging API: qpid::messaging::Handle< T > Class Template Reference + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
Qpid C++ Messaging API +  1.35.0 +
+
+ + + + + + +
+
+
+ + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+ +
+
qpid::messaging::Handle< T > Class Template Reference
+
+
+ +

#include <Handle.h>

+ + + + + + + + + + + + +

+Public Member Functions

QPID_MESSAGING_INLINE_EXTERN bool isValid () const
 
QPID_MESSAGING_INLINE_EXTERN bool isNull () const
 
QPID_MESSAGING_INLINE_EXTERN operator bool () const
 
QPID_MESSAGING_INLINE_EXTERN bool operator! () const
 
+void swap (Handle< T > &h)
 
+ + + +

+Protected Types

+typedef T Impl
 
+ + + +

+Protected Attributes

+Impl * impl
 
+ + + +

+Friends

+class PrivateImplRef< T >
 
+

Detailed Description

+

template<class T>
+class qpid::messaging::Handle< T >

+ +

A handle is like a pointer: refers to an underlying implementation object. Copying the handle does not copy the object.

+

Handles can be null, like a 0 pointer. Use isValid(), isNull() or the conversion to bool to test for a null handle.

+

Member Function Documentation

+ +
+
+
+template<class T>
+ + + + + +
+ + + + + + + +
QPID_MESSAGING_INLINE_EXTERN bool qpid::messaging::Handle< T >::isNull () const
+
+inline
+
+
Returns
true if handle is null. It is an error to call any function on a null handle.
+ +
+
+ +
+
+
+template<class T>
+ + + + + +
+ + + + + + + +
QPID_MESSAGING_INLINE_EXTERN bool qpid::messaging::Handle< T >::isValid () const
+
+inline
+
+
Returns
true if handle is valid, i.e. not null.
+ +
+
+ +
+
+
+template<class T>
+ + + + + +
+ + + + + + + +
QPID_MESSAGING_INLINE_EXTERN qpid::messaging::Handle< T >::operator bool () const
+
+inline
+
+

Conversion to bool supports idiom if (handle) { handle->... }

+ +
+
+ +
+
+
+template<class T>
+ + + + + +
+ + + + + + + +
QPID_MESSAGING_INLINE_EXTERN bool qpid::messaging::Handle< T >::operator! () const
+
+inline
+
+

Operator ! supports idiom if (!handle) { do_if_handle_is_null(); }

+ +
+
+
The documentation for this class was generated from the following file: +
+
+ + + + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/eff0fe55/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Handle.js ---------------------------------------------------------------------- diff --git a/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Handle.js b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Handle.js new file mode 100644 index 0000000..b17a578 --- /dev/null +++ b/input/releases/qpid-cpp-1.35.0/messaging-api/cpp/api/classqpid_1_1messaging_1_1Handle.js @@ -0,0 +1,12 @@ +var classqpid_1_1messaging_1_1Handle = +[ + [ "Impl", "classqpid_1_1messaging_1_1Handle.html#aae44d218cffcb40859af8702e4635d3f", null ], + [ "Handle", "classqpid_1_1messaging_1_1Handle.html#ac760dc55cf344bde4e67ecd3cba8253e", null ], + [ "isNull", "classqpid_1_1messaging_1_1Handle.html#a85d30ccb081c4b15dc3bedeb40ffbf52", null ], + [ "isValid", "classqpid_1_1messaging_1_1Handle.html#ad6666ec615c78a110d36011aaa7f74f9", null ], + [ "operator bool", "classqpid_1_1messaging_1_1Handle.html#a75949c9b0035ce83928ae1bb877ff252", null ], + [ "operator!", "classqpid_1_1messaging_1_1Handle.html#a79cc121e1185d3d90a2d36e43ac8d82b", null ], + [ "swap", "classqpid_1_1messaging_1_1Handle.html#a65237851b8de03d0a366f5e02c3ca5c4", null ], + [ "PrivateImplRef< T >", "classqpid_1_1messaging_1_1Handle.html#a3e9193fac9bbd96b21f336891b3e5d76", null ], + [ "impl", "classqpid_1_1messaging_1_1Handle.html#a56e6095295d9b798d9df9f4c53e80e32", null ] +]; \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org For additional commands, e-mail: commits-help@qpid.apache.org