From commits-return-45872-archive-asf-public=cust-asf.ponee.io@qpid.apache.org Mon Jul 2 13:23:21 2018 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx-eu-01.ponee.io (Postfix) with SMTP id DC0721807A5 for ; Mon, 2 Jul 2018 13:23:18 +0200 (CEST) Received: (qmail 57009 invoked by uid 500); 2 Jul 2018 11:23:17 -0000 Mailing-List: contact commits-help@qpid.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@qpid.apache.org Delivered-To: mailing list commits@qpid.apache.org Received: (qmail 56677 invoked by uid 99); 2 Jul 2018 11:23:17 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 02 Jul 2018 11:23:17 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 4183DE109D; Mon, 2 Jul 2018 11:23:17 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: robbie@apache.org To: commits@qpid.apache.org Date: Mon, 02 Jul 2018 11:23:25 -0000 Message-Id: <84b5a44d13414e1096669d79660a44c4@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [09/52] [partial] qpid-site git commit: update site content for proton-0.24.0 http://git-wip-us.apache.org/repos/asf/qpid-site/blob/ba8436ae/content/releases/qpid-proton-0.24.0/proton/c/api/messenger_8h.html ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.24.0/proton/c/api/messenger_8h.html b/content/releases/qpid-proton-0.24.0/proton/c/api/messenger_8h.html new file mode 100755 index 0000000..89cda87 --- /dev/null +++ b/content/releases/qpid-proton-0.24.0/proton/c/api/messenger_8h.html @@ -0,0 +1,362 @@ + + + + + + + +Qpid Proton C API: proton/messenger.h File Reference + + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
Qpid Proton C API +  0.24.0 +
+
+ + + + + + +
+
+
+ + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+Macros | +Typedefs | +Enumerations | +Functions
+
+
messenger.h File Reference
+
+
+ +

Deprecated - Use the Proactor API or Qpid Proton C++. +More...

+
#include <proton/import_export.h>
+#include <proton/message.h>
+#include <proton/selectable.h>
+#include <proton/link.h>
+#include <proton/transport.h>
+#include <proton/ssl.h>
+
+

Go to the source code of this file.

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

+Macros

+#define PN_CUMULATIVE
 Indicates that an accept or reject should operate cumulatively.
 
+#define PN_FLAGS_CHECK_ROUTES
 Messenger flag to indicate that a call \ to pn_messenger_start should check that \ any defined routes are valid.
 
+#define PN_FLAGS_ALLOW_INSECURE_MECHS
 Messenger flag to indicate that the PLAIN \ mechanism is allowed on an unencrypted \ connection.
 
+ + + + + + + + + + +

+Typedefs

typedef struct pn_messenger_t pn_messenger_t
 A pn_messenger_t provides a high level interface for sending and receiving messages (See pn_message_t). More...
 
+typedef struct pn_subscription_t pn_subscription_t
 A subscription is a request for incoming messages.
 
+typedef int64_t pn_tracker_t
 Trackers provide a lightweight handle used to track the status of incoming and outgoing deliveries.
 
+ + + + +

+Enumerations

enum  pn_status_t {
+  PN_STATUS_UNKNOWN, +PN_STATUS_PENDING, +PN_STATUS_ACCEPTED, +PN_STATUS_REJECTED, +
+  PN_STATUS_RELEASED, +PN_STATUS_MODIFIED, +PN_STATUS_ABORTED, +PN_STATUS_SETTLED +
+ }
 Describes all the possible states for a message associated with a given tracker. More...
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Functions

pn_messenger_t * pn_messenger (const char *name)
 Construct a new pn_messenger_t with the given name. More...
 
const char * pn_messenger_name (pn_messenger_t *messenger)
 Get the name of a messenger. More...
 
int pn_messenger_set_certificate (pn_messenger_t *messenger, const char *certificate)
 Sets the path that will be used to get the certificate that will be used to identify this messenger to its peers. More...
 
const char * pn_messenger_get_certificate (pn_messenger_t *messenger)
 Get the certificate path. More...
 
int pn_messenger_set_private_key (pn_messenger_t *messenger, const char *private_key)
 Set path to the private key that was used to sign the certificate. More...
 
const char * pn_messenger_get_private_key (pn_messenger_t *messenger)
 Gets the private key file for a messenger. More...
 
int pn_messenger_set_password (pn_messenger_t *messenger, const char *password)
 Sets the private key password for a messenger. More...
 
const char * pn_messenger_get_password (pn_messenger_t *messenger)
 Gets the private key file password for a messenger. More...
 
int pn_messenger_set_trusted_certificates (pn_messenger_t *messenger, const char *cert_db)
 Sets the trusted certificates database for a messenger. More...
 
const char * pn_messenger_get_trusted_certificates (pn_messenger_t *messenger)
 Gets the trusted certificates database for a messenger. More...
 
int pn_messenger_set_timeout (pn_messenger_t *messenger, int timeout)
 Set the default timeout for a messenger. More...
 
int pn_messenger_get_timeout (pn_messenger_t *messenger)
 Gets the timeout for a messenger object. More...
 
bool pn_messenger_is_blocking (pn_messenger_t *messenger)
 Check if a messenger is in blocking mode. More...
 
int pn_messenger_set_blocking (pn_messenger_t *messenger, bool blocking)
 Enable or disable blocking behavior for a messenger during calls to pn_messenger_send and pn_messenger_recv. More...
 
bool pn_messenger_is_passive (pn_messenger_t *messenger)
 Check if a messenger is in passive mode. More...
 
int pn_messenger_set_passive (pn_messenger_t *messenger, bool passive)
 Set the passive mode for a messenger. More...
 
void pn_messenger_free (pn_messenger_t *messenger)
 Frees a Messenger. More...
 
int pn_messenger_errno (pn_messenger_t *messenger)
 Get the code for a messenger's most recent error. More...
 
pn_error_t * pn_messenger_error (pn_messenger_t *messenger)
 Get a messenger's error object. More...
 
int pn_messenger_get_outgoing_window (pn_messenger_t *messenger)
 Get the size of a messenger's outgoing window. More...
 
int pn_messenger_set_outgoing_window (pn_messenger_t *messenger, int window)
 Set the size of a messenger's outgoing window. More...
 
int pn_messenger_get_incoming_window (pn_messenger_t *messenger)
 Get the size of a messenger's incoming window. More...
 
int pn_messenger_set_incoming_window (pn_messenger_t *messenger, int window)
 Set the size of a messenger's incoming window. More...
 
int pn_messenger_start (pn_messenger_t *messenger)
 Currently a no-op placeholder. More...
 
int pn_messenger_stop (pn_messenger_t *messenger)
 Stops a messenger. More...
 
bool pn_messenger_stopped (pn_messenger_t *messenger)
 Returns true if a messenger is in the stopped state. More...
 
pn_subscription_t * pn_messenger_subscribe (pn_messenger_t *messenger, const char *source)
 Subscribes a messenger to messages from the specified source. More...
 
pn_subscription_t * pn_messenger_subscribe_ttl (pn_messenger_t *messenger, const char *source, pn_seconds_t timeout)
 Subscribes a messenger to messages from the specified source with the given timeout for the subscription's lifetime. More...
 
pn_link_t * pn_messenger_get_link (pn_messenger_t *messenger, const char *address, bool sender)
 Get a link based on link name and whether the link is a sender or receiver. More...
 
void * pn_subscription_get_context (pn_subscription_t *sub)
 Get a subscription's application context. More...
 
void pn_subscription_set_context (pn_subscription_t *sub, void *context)
 Set an application context for a subscription. More...
 
const char * pn_subscription_address (pn_subscription_t *sub)
 Get the source address of a subscription. More...
 
int pn_messenger_put (pn_messenger_t *messenger, pn_message_t *msg)
 Puts a message onto the messenger's outgoing queue. More...
 
pn_status_t pn_messenger_status (pn_messenger_t *messenger, pn_tracker_t tracker)
 Track the status of a delivery. More...
 
pn_delivery_t * pn_messenger_delivery (pn_messenger_t *messenger, pn_tracker_t tracker)
 Get delivery information about a delivery. More...
 
bool pn_messenger_buffered (pn_messenger_t *messenger, pn_tracker_t tracker)
 Check if the delivery associated with a given tracker is still waiting to be sent. More...
 
int pn_messenger_settle (pn_messenger_t *messenger, pn_tracker_t tracker, int flags)
 Frees a Messenger from tracking the status associated with a given tracker. More...
 
pn_tracker_t pn_messenger_outgoing_tracker (pn_messenger_t *messenger)
 Get a tracker for the outgoing message most recently given to pn_messenger_put. More...
 
int pn_messenger_work (pn_messenger_t *messenger, int timeout)
 Sends or receives any outstanding messages queued for a messenger. More...
 
int pn_messenger_interrupt (pn_messenger_t *messenger)
 Interrupt a messenger object that may be blocking in another thread. More...
 
int pn_messenger_send (pn_messenger_t *messenger, int n)
 Send messages from a messenger's outgoing queue. More...
 
int pn_messenger_recv (pn_messenger_t *messenger, int limit)
 Retrieve messages into a messenger's incoming queue. More...
 
int pn_messenger_receiving (pn_messenger_t *messenger)
 Get the capacity of the incoming message queue of a messenger. More...
 
int pn_messenger_get (pn_messenger_t *messenger, pn_message_t *message)
 Get the next message from the head of a messenger's incoming queue. More...
 
pn_tracker_t pn_messenger_incoming_tracker (pn_messenger_t *messenger)
 Get a tracker for the message most recently retrieved by pn_messenger_get(). More...
 
pn_subscription_t * pn_messenger_incoming_subscription (pn_messenger_t *messenger)
 Get the subscription of the message most recently retrieved by pn_messenger_get(). More...
 
int pn_messenger_accept (pn_messenger_t *messenger, pn_tracker_t tracker, int flags)
 Signal successful processing of message(s). More...
 
int pn_messenger_reject (pn_messenger_t *messenger, pn_tracker_t tracker, int flags)
 Signal unsuccessful processing of message(s). More...
 
pn_link_t * pn_messenger_tracker_link (pn_messenger_t *messenger, pn_tracker_t tracker)
 Get link for the message referenced by the given tracker. More...
 
int pn_messenger_outgoing (pn_messenger_t *messenger)
 Get the number of messages in the outgoing message queue of a messenger. More...
 
int pn_messenger_incoming (pn_messenger_t *messenger)
 Get the number of messages in the incoming message queue of a messenger. More...
 
int pn_messenger_route (pn_messenger_t *messenger, const char *pattern, const char *address)
 Adds a routing rule to a Messenger's internal routing table. More...
 
int pn_messenger_rewrite (pn_messenger_t *messenger, const char *pattern, const char *address)
 Rewrite message addresses prior to transmission. More...
 
pn_selectable_t * pn_messenger_selectable (pn_messenger_t *messenger)
 Extract selectables from a passive messenger. More...
 
pn_timestamp_t pn_messenger_deadline (pn_messenger_t *messenger)
 Get the nearest deadline for selectables associated with a messenger. More...
 
int pn_messenger_set_flags (pn_messenger_t *messenger, const int flags)
 Sets control flags to enable additional function for the Messenger. More...
 
int pn_messenger_get_flags (pn_messenger_t *messenger)
 Gets the flags for a Messenger. More...
 
int pn_messenger_set_snd_settle_mode (pn_messenger_t *messenger, const pn_snd_settle_mode_t mode)
 Set the local sender settle mode for the underlying link. More...
 
int pn_messenger_set_rcv_settle_mode (pn_messenger_t *messenger, const pn_rcv_settle_mode_t mode)
 Set the local receiver settle mode for the underlying link. More...
 
void pn_messenger_set_tracer (pn_messenger_t *messenger, pn_tracer_t tracer)
 Set the tracer associated with a messenger. More...
 
pn_millis_t pn_messenger_get_remote_idle_timeout (pn_messenger_t *messenger, const char *address)
 Gets the remote idle timeout for the specified remote service address. More...
 
int pn_messenger_set_ssl_peer_authentication_mode (pn_messenger_t *messenger, const pn_ssl_verify_mode_t mode)
 Sets the SSL peer authentication mode required when a trust certificate is used. More...
 
+

Detailed Description

+

Deprecated - Use the Proactor API or Qpid Proton C++.

+
+
+ + + + http://git-wip-us.apache.org/repos/asf/qpid-site/blob/ba8436ae/content/releases/qpid-proton-0.24.0/proton/c/api/messenger_8h.js ---------------------------------------------------------------------- diff --git a/content/releases/qpid-proton-0.24.0/proton/c/api/messenger_8h.js b/content/releases/qpid-proton-0.24.0/proton/c/api/messenger_8h.js new file mode 100755 index 0000000..89f21fa --- /dev/null +++ b/content/releases/qpid-proton-0.24.0/proton/c/api/messenger_8h.js @@ -0,0 +1,81 @@ +var messenger_8h = +[ + [ "PN_CUMULATIVE", "group__messenger.html#ga6c2e8d006ec05b913fa1e6dc510d23b9", null ], + [ "PN_FLAGS_CHECK_ROUTES", "group__messenger.html#gad5ad0b67fef0e761dc0138b9621ffa14", null ], + [ "PN_FLAGS_ALLOW_INSECURE_MECHS", "group__messenger.html#ga118fb0c2384257dff5d72eea787e4a0c", null ], + [ "pn_messenger_t", "group__messenger.html#ga0d342bb795d48591ad6b3f867766b8b1", null ], + [ "pn_subscription_t", "group__messenger.html#gabd73703511b9dae193765e9e57864291", null ], + [ "pn_tracker_t", "group__messenger.html#gab1173cfe4bcaa0a530c8035dc75f42c7", null ], + [ "pn_status_t", "group__messenger.html#ga242e4ee54b9c0a416443c7da5f6e045b", [ + [ "PN_STATUS_UNKNOWN", "group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045ba0b46b1041679460baaba2ddcdb2173f2", null ], + [ "PN_STATUS_PENDING", "group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045ba4b0354a77173cd75c69159e15c23f611", null ], + [ "PN_STATUS_ACCEPTED", "group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045ba693fd9044a50a4f02e842d04a4bf1467", null ], + [ "PN_STATUS_REJECTED", "group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045baf109df703952744009b3547f3b8f32bf", null ], + [ "PN_STATUS_RELEASED", "group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045ba67079750477effb7935df83381c47852", null ], + [ "PN_STATUS_MODIFIED", "group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045ba77d94a6b6b745eef9307f144b57e81e8", null ], + [ "PN_STATUS_ABORTED", "group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045ba1239e8ada7eabe2aeab98f2c881cd2ee", null ], + [ "PN_STATUS_SETTLED", "group__messenger.html#gga242e4ee54b9c0a416443c7da5f6e045ba1181bc7f51502ae11ed240866cd64583", null ] + ] ], + [ "pn_messenger", "group__messenger.html#gabe045d16ca8eb1e3cc87387e2ae82433", null ], + [ "pn_messenger_name", "group__messenger.html#ga71197163a69770575df74e3cee617429", null ], + [ "pn_messenger_set_certificate", "group__messenger.html#gad61fff52c28501171ecbb0b21bbde954", null ], + [ "pn_messenger_get_certificate", "group__messenger.html#ga1d0c003a1fb5e20b894e2deb8b43118b", null ], + [ "pn_messenger_set_private_key", "group__messenger.html#ga05f059a2fe93e0acbcf76e494e6bf958", null ], + [ "pn_messenger_get_private_key", "group__messenger.html#gab692f989aed2aa83bd71b7fa7196aeb1", null ], + [ "pn_messenger_set_password", "group__messenger.html#ga6b04f7dea2ed8752b8672b4cfe0330f2", null ], + [ "pn_messenger_get_password", "group__messenger.html#ga3f02ad7340a59c5982e6223aaeea803a", null ], + [ "pn_messenger_set_trusted_certificates", "group__messenger.html#gad901e92e2bee6d5371dcd3b1c8fe2c3b", null ], + [ "pn_messenger_get_trusted_certificates", "group__messenger.html#ga955b218a8f58560e9e228ca14fba21f2", null ], + [ "pn_messenger_set_timeout", "group__messenger.html#ga04119bb2b16bb0f657f1dbcf73827d74", null ], + [ "pn_messenger_get_timeout", "group__messenger.html#ga083ba6296a1ae1dfe45c0fb82da823eb", null ], + [ "pn_messenger_is_blocking", "group__messenger.html#gaf572cbf224105d08898d2906336712f7", null ], + [ "pn_messenger_set_blocking", "group__messenger.html#gae9d7f1aec6e2cf3ef1ee326a4ae15981", null ], + [ "pn_messenger_is_passive", "group__messenger.html#ga63805c35f18ef041c69a14564dc1bce4", null ], + [ "pn_messenger_set_passive", "group__messenger.html#gac7df7c92396f10f105ec74d35310a7c0", null ], + [ "pn_messenger_free", "group__messenger.html#ga530295575eda95e3c19316d41bd1baa7", null ], + [ "pn_messenger_errno", "group__messenger.html#gacfd10311abca28521fe7aa9cabfff61c", null ], + [ "pn_messenger_error", "group__messenger.html#ga0301664be9c54b3a573578776ad2a5d2", null ], + [ "pn_messenger_get_outgoing_window", "group__messenger.html#gac191bdb410b7839d6306a0d8e5ac19e1", null ], + [ "pn_messenger_set_outgoing_window", "group__messenger.html#ga96487581bd8348f8bc9bacef25042cfc", null ], + [ "pn_messenger_get_incoming_window", "group__messenger.html#ga45d578f39673ad59ca65d2042054abee", null ], + [ "pn_messenger_set_incoming_window", "group__messenger.html#gadf8a9cf14bf8d519026ea8c4eeb275c3", null ], + [ "pn_messenger_start", "group__messenger.html#ga6fa594235e316cd2a04b44b283194a43", null ], + [ "pn_messenger_stop", "group__messenger.html#gad95ab6daf6b2a61b79d5128a7d1d9f5c", null ], + [ "pn_messenger_stopped", "group__messenger.html#gae2c4765839c8fd09c0e01d05a118b6d4", null ], + [ "pn_messenger_subscribe", "group__messenger.html#gac36589fe5dc0378cf62558e40060a26f", null ], + [ "pn_messenger_subscribe_ttl", "group__messenger.html#ga480a8623fab904690218c0c67493232f", null ], + [ "pn_messenger_get_link", "group__messenger.html#ga757aeef23d47ecc2a9a461b882686417", null ], + [ "pn_subscription_get_context", "group__messenger.html#ga8ad0f0db6d7cfe0e95d44d433843d787", null ], + [ "pn_subscription_set_context", "group__messenger.html#ga3a7f95a2a86f64babe692d21ffe9cd10", null ], + [ "pn_subscription_address", "group__messenger.html#ga8e87c040776f1941f21d2c15f24b835e", null ], + [ "pn_messenger_put", "group__messenger.html#gafede68af29484d50d531cc48ab0d3d4a", null ], + [ "pn_messenger_status", "group__messenger.html#gad398544ad1374f67c922115ae1cceacc", null ], + [ "pn_messenger_delivery", "group__messenger.html#ga65f22122f08bc93de2bfe155aa12d0b0", null ], + [ "pn_messenger_buffered", "group__messenger.html#ga15adeb707f15b86df1e5486c34a060e6", null ], + [ "pn_messenger_settle", "group__messenger.html#ga475ce593f6b0c6025516ae48360dee4d", null ], + [ "pn_messenger_outgoing_tracker", "group__messenger.html#ga0212b5cfe07a7f758ec472d67d0f56e1", null ], + [ "pn_messenger_work", "group__messenger.html#ga47d60cec6a55e0675b8f073067eff9c4", null ], + [ "pn_messenger_interrupt", "group__messenger.html#ga9da14c67acc17bc5fec6f34e2749534f", null ], + [ "pn_messenger_send", "group__messenger.html#gae31f9a99dcbedffe83588cf25b805325", null ], + [ "pn_messenger_recv", "group__messenger.html#ga16c945185e4eb5dcb9aac2be2fcab0d6", null ], + [ "pn_messenger_receiving", "group__messenger.html#gaf4e22c8cb1436891d42ca0a658fca9c5", null ], + [ "pn_messenger_get", "group__messenger.html#gaa6d85929e4b4b574690927ddde00c540", null ], + [ "pn_messenger_incoming_tracker", "group__messenger.html#gafe31e771826f8107d93fc276c9715aab", null ], + [ "pn_messenger_incoming_subscription", "group__messenger.html#gae351d031d2ef29bdb137a59d461c4253", null ], + [ "pn_messenger_accept", "group__messenger.html#ga11cd0d3423482e1ddda7a8b0cbb581c7", null ], + [ "pn_messenger_reject", "group__messenger.html#ga22d6de108fa967a43ab2473d6a915e9c", null ], + [ "pn_messenger_tracker_link", "group__messenger.html#gae4e5e89c6ea2a820a221af61cc741c7d", null ], + [ "pn_messenger_outgoing", "group__messenger.html#ga06c3a066422f8a966523b43a61f62eb9", null ], + [ "pn_messenger_incoming", "group__messenger.html#ga43cf91b5528c2729b3ff9ae1d2a7d257", null ], + [ "pn_messenger_route", "group__messenger.html#ga6c85a08d72ae73a18f9fb64ccf0c470e", null ], + [ "pn_messenger_rewrite", "group__messenger.html#gac7dc5d9b82f9e015fd2c7d9743099eff", null ], + [ "pn_messenger_selectable", "group__messenger.html#ga8521b0999200c076bf12568ac10fe925", null ], + [ "pn_messenger_deadline", "group__messenger.html#ga223e7c16f3e84f4e573864c3881b3b4b", null ], + [ "pn_messenger_set_flags", "group__messenger.html#gacf39b77df62750343e2f4e90dbcacc75", null ], + [ "pn_messenger_get_flags", "group__messenger.html#ga9f4e2fbfb7eb7bfd9acd7ad758d24085", null ], + [ "pn_messenger_set_snd_settle_mode", "group__messenger.html#ga7b0872d6712c53e307bf2babfd91bf6e", null ], + [ "pn_messenger_set_rcv_settle_mode", "group__messenger.html#gae9f2d3ab15602b27f1b87a4f6349a9f1", null ], + [ "pn_messenger_set_tracer", "group__messenger.html#ga6c2cfb88f59980bb13821a6f25cf30f6", null ], + [ "pn_messenger_get_remote_idle_timeout", "group__messenger.html#ga9be25d57cda5a6e1c5658b0f362c41c7", null ], + [ "pn_messenger_set_ssl_peer_authentication_mode", "group__messenger.html#ga59ebaf21eaafaa4b1c359e4284564ff6", 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