From 9cbd156b85b3dc247e4664a70a989d509d78a261 Mon Sep 17 00:00:00 2001 From: Gordon Sim Date: Fri, 20 Nov 2009 10:23:56 +0000 Subject: Improved formatting of address documentation. git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@882485 13f79535-47bb-0310-9956-ffa450edef68 --- cpp/include/qpid/messaging/Address.h | 82 +++++++++++++++++++++--------------- 1 file changed, 47 insertions(+), 35 deletions(-) (limited to 'cpp/include') diff --git a/cpp/include/qpid/messaging/Address.h b/cpp/include/qpid/messaging/Address.h index aa7d366088..538cb6507c 100644 --- a/cpp/include/qpid/messaging/Address.h +++ b/cpp/include/qpid/messaging/Address.h @@ -51,12 +51,10 @@ class AddressImpl; * All parts of an address can be specified in a string of the * following form: * - * 
- * 
 [ /  ] ; [ {  :  , ... } ]
- *
+ * <address> [ / <subject> ] ; [ { <key> : <value> , ... } ] * - * Here the
is a simple name for the addressed - * entity and
is a subject or subject pattern for + * Here the <address> is a simple name for the addressed + * entity and <subject> is a subject or subject pattern for * messages sent to or received from this address. The options are * specified as a series of key value pairs enclosed in curly brackets * (denoting a map). Values can be nested maps, or lists (which are @@ -64,67 +62,81 @@ class AddressImpl; * e.g. [a, b, c]). * * The currently supported options are as follows: + * + * * - * create - whether the address should be automatically created or - * not. Can be one of always, never, sender or receiver; the - * properties of the node to be created can be specified via the - * node-properties option. + * * - * assert - whether or not to assert any specified node-properties - * match the address. Can be one of always, never, sender or receiver. + * * - * delete - whether or not to delete the addressed nide when a sender - * or receiver is cancelled. Can be one of always, never, sender or - * receiver. + * * - * node-properties - a nested map of properties of the addressed + * + * + *
createIndicate whether the address should be + * automatically created or not. Can be one of always, + * never, sender or receiver. The properties of + * the node to be created can be specified via the node-properties + * option (see below).
assertIndicate whether or not to assert any specified + * node-properties match the address. Can be one of always, + * never, sender or receiver.
deleteIndicate whether or not to delete the addressed + * nide when a sender or receiver is cancelled. Can be one of always, + * never, sender or receiver.
node-propertiesA nested map of properties of the addressed * entity or 'node'. These can be used when automatically creating it, * or to assert certain properties. * * The valid node-properties are: + *
    + *
  • type - queue or topic
    • * - * type - queue or topic - * - * durable - true or false + *
  • durable - true or false
    • * - * x-properties - a nested map that can contain implementation or + *
  • x-properties - a nested map that can contain implementation or * protocol specifiec extedned properties. For the amqp 0-10 mapping, * the fields in queue- or exchange- declare can be specified in here; * anything that is not recognised as one of those will be passed - * through in the arguments field. + * through in the arguments field.,/li> + *
+ *
* * For receivers there are some further options of interest: * - * no-local - (only relevant for topics at present) specifies that the + * + * + * * - * browse - (only relevant for queues) specifies that the receiver - * does not wish to consume the messages, but merely browse them + * * - * durable - (only relevant for topics at present) specifies that a - * durable subscription is required + * * - * reliability - indicates the level of reliability that the receiver + * * - * filter - (only relevant for topics at present) allows bindings to + * * - * x-properties - allows protocol or implementation specific options + * + *
no-local(only relevant for topics at present) specifies that the * receiver does not want to receiver messages published to the topic - * that originate from a sender on the same connection + * that originate from a sender on the same connection
browse(only relevant for queues) specifies that the receiver + * does not wish to consume the messages, but merely browse them
durable(only relevant for topics at present) specifies that a + * durable subscription is required
reliabilityindicates the level of reliability that the receiver * expects. Can be one of unreliable, at-most-once, at-least-once or - * exactly-once (the latter is not yet correctly supported). + * exactly-once (the latter is not yet correctly supported).
filter(only relevant for topics at present) allows bindings to * be created for the queue that match the given criteris (or list of - * criteria). + * criteria).
x-propertiesallows protocol or implementation specific options * to be specified for a receiver; this is a nested map and currently * the implementation only recognises two specific nested properties * within it (all others are passed through in the arguments of the * message-subscribe command): * - * exclusive, which requests an exclusive subscription and - * is only relevant for queues + *
    + *
  • exclusive, which requests an exclusive subscription and + * is only relevant for queues
    • * - * x-queue-arguments, which ais only relevant for topics and + *
  • x-queue-arguments, which ais only relevant for topics and * allows arguments to the queue-declare for the subscription - * queue to be specified + * queue to be specified
    • + *
+ *
*/ class Address { -- cgit v1.2.1