From f160cb6566c17945f7ebc4f3a752b2cc6a051685 Mon Sep 17 00:00:00 2001 From: Robert Gemmell Date: Tue, 5 Jul 2016 21:55:35 +0000 Subject: QPID-7207: remove cpp and python subdirs from svn trunk, they have migrated to their own git repositories git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1751566 13f79535-47bb-0310-9956-ffa450edef68 --- qpid/cpp/docs/amqp-1.0.txt | 393 -- qpid/cpp/docs/api/CMakeLists.txt | 45 - qpid/cpp/docs/api/developer.doxygen.in | 1261 ---- qpid/cpp/docs/api/doxygen.css | 494 -- qpid/cpp/docs/api/doxygen_developer_mainpage.h | 71 - qpid/cpp/docs/api/doxygen_mainpage.h | 338 - qpid/cpp/docs/api/footer.html | 31 - qpid/cpp/docs/api/header.html | 42 - qpid/cpp/docs/api/stylesheet.css | 494 -- qpid/cpp/docs/api/tabs.css | 123 - qpid/cpp/docs/api/user.doxygen.in | 1237 ---- qpid/cpp/docs/book/.gitignore | 21 - qpid/cpp/docs/book/Makefile | 38 - qpid/cpp/docs/book/src/Makefile.inc | 63 - qpid/cpp/docs/book/src/common/css/style.css | 279 - qpid/cpp/docs/book/src/cpp-broker/.gitignore | 20 - .../book/src/cpp-broker/AMQP-Compatibility.xml | 713 --- .../cpp-broker/AMQP-Messaging-Broker-CPP-Book.xml | 74 - .../book/src/cpp-broker/Active-Passive-Cluster.xml | 1229 ---- ...heat-Sheet-for-configuring-Exchange-Options.xml | 144 - .../Cheat-Sheet-for-configuring-Queue-Options.xml | 198 - .../book/src/cpp-broker/HA-Queue-Replication.xml | 126 - qpid/cpp/docs/book/src/cpp-broker/LVQ.xml | 181 - qpid/cpp/docs/book/src/cpp-broker/Makefile | 20 - .../book/src/cpp-broker/Managing-CPP-Broker.xml | 480 -- .../src/cpp-broker/QMF-Python-Console-Tutorial.xml | 894 --- .../Qpid-Interoperability-Documentation.xml | 377 -- .../src/cpp-broker/Qpid-Management-Framework.xml | 944 --- .../book/src/cpp-broker/Running-CPP-Broker.xml | 846 --- qpid/cpp/docs/book/src/cpp-broker/Security.xml | 2516 -------- .../src/cpp-broker/Using-Broker-Federation.xml | 715 --- .../book/src/cpp-broker/Using-message-groups.xml | 295 - .../book/src/cpp-broker/producer-flow-control.xml | 351 -- .../src/cpp-broker/queue-state-replication.xml | 333 - qpid/cpp/docs/book/src/images/qpid-logo.png | Bin 39056 -> 0 bytes qpid/cpp/docs/book/src/old/ACL.xml | 800 --- .../book/src/old/AMQP-.NET-Messaging-Client.xml | 108 - .../book/src/old/AMQP-C++-Messaging-Client.xml | 61 - .../src/old/AMQP-Java-JMS-Messaging-Client.xml | 94 - .../book/src/old/AMQP-Messaging-Broker-CPP.xml | 70 - .../book/src/old/AMQP-Python-Messaging-Client.xml | 62 - .../book/src/old/AMQP-Ruby-Messaging-Client.xml | 40 - qpid/cpp/docs/book/src/old/AMQP.xml | 98 - qpid/cpp/docs/book/src/old/Binding-URL-Format.xml | 174 - qpid/cpp/docs/book/src/old/Book-Info.xml | 68 - qpid/cpp/docs/book/src/old/Book.xml | 93 - qpid/cpp/docs/book/src/old/Broker-CPP.xml | 40 - qpid/cpp/docs/book/src/old/Broker-Java.xml | 45 - qpid/cpp/docs/book/src/old/Clients.xml | 25 - .../docs/book/src/old/Connection-URL-Format.xml | 387 -- qpid/cpp/docs/book/src/old/Download.xml | 174 - qpid/cpp/docs/book/src/old/Excel-AddIn.xml | 169 - qpid/cpp/docs/book/src/old/FAQ.xml | 524 -- qpid/cpp/docs/book/src/old/Getting-Started.xml | 90 - qpid/cpp/docs/book/src/old/How-to-Use-JNDI.xml | 175 - qpid/cpp/docs/book/src/old/InfoPlugin.xml | 261 - qpid/cpp/docs/book/src/old/Introduction.xml | 106 - .../book/src/old/Java-Broker-StatusLogMessages.xml | 294 - .../docs/book/src/old/Java-JMS-Selector-Syntax.xml | 96 - .../docs/book/src/old/Management-Design-notes.xml | 2136 ------- qpid/cpp/docs/book/src/old/NET-User-Guide.xml | 1383 ---- qpid/cpp/docs/book/src/old/PythonBrokerTest.xml | 98 - .../book/src/old/QMan-Qpid-Management-bridge.xml | 166 - qpid/cpp/docs/book/src/old/Qpid-ACLs.xml | 49 - qpid/cpp/docs/book/src/old/Qpid-Book.xml | 93 - ...pid-Compatibility-And-Interoperability-Book.xml | 36 - qpid/cpp/docs/book/src/old/SASL-Compatibility.xml | 70 - qpid/cpp/docs/book/src/old/SSL.xml | 180 - qpid/cpp/docs/book/src/old/Security-Plugins.xml | 611 -- qpid/cpp/docs/book/src/old/System-Properties.xml | 357 -- .../old/Using-Qpid-with-other-JNDI-Providers.xml | 215 - qpid/cpp/docs/book/src/old/WCF.xml | 137 - qpid/cpp/docs/book/src/old/schemas.xml | 102 - qpid/cpp/docs/book/src/programming/Makefile | 20 - .../book/src/programming/Message-Groups-Guide.xml | 163 - .../src/programming/Programming-In-Apache-Qpid.xml | 6594 -------------------- qpid/cpp/docs/book/src/qmf/QmfBook.xml | 101 - qpid/cpp/docs/book/src/qmf/QmfIntroduction.xml | 45 - qpid/cpp/docs/book/xsl/html-custom.xsl | 188 - qpid/cpp/docs/design/DispatchHandle.odg | Bin 12481 -> 0 bytes qpid/cpp/docs/design/broker-acl-work.txt | 156 - qpid/cpp/docs/design/ha-transactions.md | 197 - .../design/log-model-category-for-correlation.txt | 131 - qpid/cpp/docs/design/new-ha-design.txt | 304 - qpid/cpp/docs/design/old-cluster-issues.txt | 81 - qpid/cpp/docs/design/overview.txt | 97 - qpid/cpp/docs/design/windows_clfs_store_design.txt | 258 - qpid/cpp/docs/ha.txt | 157 - qpid/cpp/docs/man/CMakeLists.txt | 22 - qpid/cpp/docs/man/generate_manpage | 27 - qpid/cpp/docs/man/groffify_options.sed | 25 - qpid/cpp/docs/man/groffify_template.sed | 21 - qpid/cpp/docs/man/qpidd.1 | 400 -- qpid/cpp/docs/man/qpidd.x | 72 - qpid/cpp/docs/ssl.txt | 169 - 95 files changed, 34301 deletions(-) delete mode 100644 qpid/cpp/docs/amqp-1.0.txt delete mode 100644 qpid/cpp/docs/api/CMakeLists.txt delete mode 100644 qpid/cpp/docs/api/developer.doxygen.in delete mode 100644 qpid/cpp/docs/api/doxygen.css delete mode 100644 qpid/cpp/docs/api/doxygen_developer_mainpage.h delete mode 100644 qpid/cpp/docs/api/doxygen_mainpage.h delete mode 100644 qpid/cpp/docs/api/footer.html delete mode 100644 qpid/cpp/docs/api/header.html delete mode 100644 qpid/cpp/docs/api/stylesheet.css delete mode 100644 qpid/cpp/docs/api/tabs.css delete mode 100644 qpid/cpp/docs/api/user.doxygen.in delete mode 100644 qpid/cpp/docs/book/.gitignore delete mode 100644 qpid/cpp/docs/book/Makefile delete mode 100644 qpid/cpp/docs/book/src/Makefile.inc delete mode 100644 qpid/cpp/docs/book/src/common/css/style.css delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/.gitignore delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/AMQP-Compatibility.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/AMQP-Messaging-Broker-CPP-Book.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/Active-Passive-Cluster.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/Cheat-Sheet-for-configuring-Exchange-Options.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/Cheat-Sheet-for-configuring-Queue-Options.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/HA-Queue-Replication.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/LVQ.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/Makefile delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/Managing-CPP-Broker.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/QMF-Python-Console-Tutorial.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/Qpid-Interoperability-Documentation.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/Qpid-Management-Framework.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/Running-CPP-Broker.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/Security.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/Using-Broker-Federation.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/Using-message-groups.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/producer-flow-control.xml delete mode 100644 qpid/cpp/docs/book/src/cpp-broker/queue-state-replication.xml delete mode 100644 qpid/cpp/docs/book/src/images/qpid-logo.png delete mode 100644 qpid/cpp/docs/book/src/old/ACL.xml delete mode 100644 qpid/cpp/docs/book/src/old/AMQP-.NET-Messaging-Client.xml delete mode 100644 qpid/cpp/docs/book/src/old/AMQP-C++-Messaging-Client.xml delete mode 100644 qpid/cpp/docs/book/src/old/AMQP-Java-JMS-Messaging-Client.xml delete mode 100644 qpid/cpp/docs/book/src/old/AMQP-Messaging-Broker-CPP.xml delete mode 100644 qpid/cpp/docs/book/src/old/AMQP-Python-Messaging-Client.xml delete mode 100644 qpid/cpp/docs/book/src/old/AMQP-Ruby-Messaging-Client.xml delete mode 100644 qpid/cpp/docs/book/src/old/AMQP.xml delete mode 100644 qpid/cpp/docs/book/src/old/Binding-URL-Format.xml delete mode 100644 qpid/cpp/docs/book/src/old/Book-Info.xml delete mode 100644 qpid/cpp/docs/book/src/old/Book.xml delete mode 100644 qpid/cpp/docs/book/src/old/Broker-CPP.xml delete mode 100644 qpid/cpp/docs/book/src/old/Broker-Java.xml delete mode 100644 qpid/cpp/docs/book/src/old/Clients.xml delete mode 100644 qpid/cpp/docs/book/src/old/Connection-URL-Format.xml delete mode 100644 qpid/cpp/docs/book/src/old/Download.xml delete mode 100644 qpid/cpp/docs/book/src/old/Excel-AddIn.xml delete mode 100644 qpid/cpp/docs/book/src/old/FAQ.xml delete mode 100644 qpid/cpp/docs/book/src/old/Getting-Started.xml delete mode 100644 qpid/cpp/docs/book/src/old/How-to-Use-JNDI.xml delete mode 100644 qpid/cpp/docs/book/src/old/InfoPlugin.xml delete mode 100644 qpid/cpp/docs/book/src/old/Introduction.xml delete mode 100644 qpid/cpp/docs/book/src/old/Java-Broker-StatusLogMessages.xml delete mode 100644 qpid/cpp/docs/book/src/old/Java-JMS-Selector-Syntax.xml delete mode 100644 qpid/cpp/docs/book/src/old/Management-Design-notes.xml delete mode 100644 qpid/cpp/docs/book/src/old/NET-User-Guide.xml delete mode 100644 qpid/cpp/docs/book/src/old/PythonBrokerTest.xml delete mode 100644 qpid/cpp/docs/book/src/old/QMan-Qpid-Management-bridge.xml delete mode 100644 qpid/cpp/docs/book/src/old/Qpid-ACLs.xml delete mode 100644 qpid/cpp/docs/book/src/old/Qpid-Book.xml delete mode 100644 qpid/cpp/docs/book/src/old/Qpid-Compatibility-And-Interoperability-Book.xml delete mode 100644 qpid/cpp/docs/book/src/old/SASL-Compatibility.xml delete mode 100644 qpid/cpp/docs/book/src/old/SSL.xml delete mode 100644 qpid/cpp/docs/book/src/old/Security-Plugins.xml delete mode 100644 qpid/cpp/docs/book/src/old/System-Properties.xml delete mode 100644 qpid/cpp/docs/book/src/old/Using-Qpid-with-other-JNDI-Providers.xml delete mode 100644 qpid/cpp/docs/book/src/old/WCF.xml delete mode 100644 qpid/cpp/docs/book/src/old/schemas.xml delete mode 100644 qpid/cpp/docs/book/src/programming/Makefile delete mode 100644 qpid/cpp/docs/book/src/programming/Message-Groups-Guide.xml delete mode 100644 qpid/cpp/docs/book/src/programming/Programming-In-Apache-Qpid.xml delete mode 100644 qpid/cpp/docs/book/src/qmf/QmfBook.xml delete mode 100644 qpid/cpp/docs/book/src/qmf/QmfIntroduction.xml delete mode 100644 qpid/cpp/docs/book/xsl/html-custom.xsl delete mode 100644 qpid/cpp/docs/design/DispatchHandle.odg delete mode 100644 qpid/cpp/docs/design/broker-acl-work.txt delete mode 100644 qpid/cpp/docs/design/ha-transactions.md delete mode 100644 qpid/cpp/docs/design/log-model-category-for-correlation.txt delete mode 100644 qpid/cpp/docs/design/new-ha-design.txt delete mode 100644 qpid/cpp/docs/design/old-cluster-issues.txt delete mode 100644 qpid/cpp/docs/design/overview.txt delete mode 100644 qpid/cpp/docs/design/windows_clfs_store_design.txt delete mode 100644 qpid/cpp/docs/ha.txt delete mode 100644 qpid/cpp/docs/man/CMakeLists.txt delete mode 100755 qpid/cpp/docs/man/generate_manpage delete mode 100644 qpid/cpp/docs/man/groffify_options.sed delete mode 100644 qpid/cpp/docs/man/groffify_template.sed delete mode 100644 qpid/cpp/docs/man/qpidd.1 delete mode 100644 qpid/cpp/docs/man/qpidd.x delete mode 100644 qpid/cpp/docs/ssl.txt (limited to 'qpid/cpp/docs') diff --git a/qpid/cpp/docs/amqp-1.0.txt b/qpid/cpp/docs/amqp-1.0.txt deleted file mode 100644 index 0e811a68f5..0000000000 --- a/qpid/cpp/docs/amqp-1.0.txt +++ /dev/null @@ -1,393 +0,0 @@ -# -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# - -AMQP 1.0 support for the qpid::messaging API --------------------------------------------- - -* Connections, Session and Links - -The protocol used is selected at runtime via the 'protocol' connection -property. The recognised values are 'amqp1.0' and 'amqp0-10'. AMQP -0-10 is still the default so in order to use AMQP 1.0 you must -explicitly specify this option. - -The SASL negotiation is optional in AMQP 1.0. If no SASL layer is -desired, the sasl_mechanisms connection option can be set to NONE. - -AMQP 1.0 can be used over SSL, however the messaging client does not -at this stage use an AMQP negotiated security layer for that -prupose. Peers must expect SSL on the port being used (either -exclusively or by being able to detect an SSL header). - -The container id that the client advertises when establishing the -connection can be set through the container_id property on the -connection. If not set a UUID will be used. - -Transactional sessions are not yet supported[1]. - -The creation of senders or receivers results in the attaching of a -link to the peer. The details of the attach, in particular the source -and/or target, are controlled through the address string. - -* Addresses - -The name specified in the address supplied when creating a sender or -receiver is used to set the 'address' field of the target or source -respectively. - -The special address name '' can be used to indicate that the -address hould be left null. - -If the subject is specified for a sender it is used the default -subject for messages sent without an explicit subject set. - -If the subject is specified for a receiver it is interpreted as a -filter on the set of messages of interest. If it includes a wildcard -(i.e. a '*' or a '#') it is sent as a legacy-amqp-topic-binding, if -not it is sent as a legacy-amqp-direct-binding. - -An address of '#' indicates that the sender or receiver being created -should be to or from a dynamically created node. I.e. the dynamic flag -will be set on the source or target in the attach to request that the -broker create a node and return the name of it. The getAddress() -method on Sender and Receiver can then be used to set the reply-to on -any message (or to establish other links to or from that node). - -For dynamically created nodes, the dynamic-node-properties can be -specified as a nested 'properties' map within the node -options. Additionally the durable and type properties in the node map -itself are sent if specified. - -For receivers, where the node is an exchange, the binding can be -controlled through the filters for the link. These can be specified -through the filter property in the link properties specified in the -address. The value of this should be a list of maps, with each map -specifying a filter through key-value pairs for name, descriptor (can -be specified as numeric or symbolic) and a value. - -The subject in the address and the selector property within the link -properties of the address provide shorter ways of specifying the most -common use cases. - -The source/target capabilities sent by the client can be controlled -through a nested list within the node options. Note that capabilities -are simply strings (symbols in 1.0 to be precise), not name value -pairs. - -E.g. topic subscriptions can be shared between receivers by requesting -the 'shared' capability and ensuring the receivers all specify the -same link name. - -If durable is set in the node properties, then a capability of -'durable' will be requested, meaning the node will not lose messages -if its volatile memory is lost. - -If the type is set, then that will also be passed as a requested -capability e.g. 'queue' meaning the node supports queue-like -characteristics (stores messages until consumers claim them and -allocates messages between competing consumers), 'topic' meaning the -node supports classic pub-sub characteristics. - -* Messages - -The message-id, correlation-id, user-id, subject, reply-to and -content-type fields in the properties section of a 1.0 message can all -be set or retreived via accessors of the same name on the Message -instance. Likewise for the durable, priority and ttl fields in the -header section. - -An AMQP 1.0 message has a delivery-count field (within the header -section) for which there is no direct accessor yet on the Message -class. However if the value is greater than 0, then the -Message::getRedelivered() method will return true. If -Message::setRedelivered() is called with a value of true, then the -delivery count will be set to 1, else it will be set to 0. The -delivery count can also be retrieved or set through the -'x-amqp-delivery-count' pseudo-property. - -The application-properties section of a 1.0 message is made available -via the properties map of the Message class. Likewise on sending a -message the properties map is used to poplulate the -application-properties section. - -There are other fields defined in the AMQP 1.0 message format that as -yet do not have direct accessors on the Message class. These are made -available on received messages via special keys into the properties -map, and can be controlled for outgoing messages by setting the -properties with the same keys. - -The format for the keys in general is x-amqp-. The keys -currently in use are: x-amqp-first-acquirer and x-amqp-delivery-count -for the header section, and x-amqp-to, x-amqp-absolute-expiry-time, -x-amqp-creation-time, x-amqp-group-id, x-amqp-qroup-sequence and -x-amqp-reply-to-group-id for the properties section. - -The delivery- and message- annotations sections can be made available -via nested maps with key x-amqp-delivery-annotations and -x-amqp-message-annotations respectively by specifying the -'nest_annotations' connection option. Otherwise they will simply be -included in the properties. - -AMQP 1.0 support in qpidd -------------------------- - -To enable 1.0 support in qpidd, the amqp module must be loaded. This -allows the broker to recognise the 1.0 protocol header alongside the -0-10 one. If installed, the module directory should be configured such -that this happens automatically. If not, use the --load-module option -and point to the amqp.so module. - -The broker can accept connections with or without and underlying SASL -security layer as defined by the 1.0 specification. However if -authentication is turned on -- i.e. auth=yes -- then a SASL security -layer MUST be used. - -The broker allows links in both directions to be attached to queues or -exchanges. The address in the source or target is resolved by checking -whether it matches the name of a queue or an exchange. If there exists -a queue and an exchange of the same name, the queue is used but a -warning is logged. - -The incoming and outgoing links attached to the broker can be viewed -via the qpid management framework (aka QMF), e.g. with the qpid-config -tool: - - qpid-config list incoming - -or - - qpid-config list outgoing - -If the node is an exchange, then an outgoing link (i.e. messages to -travel out from broker) will cause a temporary, link-scoped queue to -be created on the broker and bound to the exchange. [See section on -'Topics' below]. The name of the queue will be of the form -_. - -If the target address of an attaching sender link is null, and the -dynamic flag is not set, then the broker will route all messages -received over this sender link using the 'to' field from the -properties. If that matches the name of a queue, the message will be -enqueued to that queue. If it doesn't match a queue but matches an -exchange the message will be routed through that exchange. If it -doesn't match either a queue or an exchange then it will be -dropped. This behaviour is known as 'ANONYMOUS-RELAY', a capability -which the broker advertises in the open frames it sends over every -connection. To use it the sending process needs to have permission to -access the ANONYMOUS-RELAY 'pseudo-exchange' (note: there isn't -actually an exchange of that name, but this is how the capability is -represented in the ACL permissions model). - -Outgoing links may have a filter set on their source. The filters -currently supported by the broker are 'legacy-amqp-direct-binding', -'legacy-amqp-topic-binding', 'legacy-amqp-headers-binding', -'selector-filter' and 'xquery-filter' as defined in the registered -extensions. - -The 'selector-filter' is supported for all nodes. - -The 'legacy-amqp-direct-binding' and 'legacy-amqp-topic-binding' -filters are supported when the node is a topic, direct or xml exchange -- where it is used as the binding key when binding the subscription -queue to the exchange - and when the node is a queue, where the -subscription will then skip over messages that do not match that -subject. In the case where 'legacy-amqp-topic-binding' was requested -for a direct- or xml- exchange it will be interpreted as a direct -binding (and this will be indicated via the filters set on the attach -sent by the broker). - -The 'legacy-amqp-headers-binding' is supported where the node is a -headers exchange and implemented as a binding to the exchange. - -The 'xquery-filter' is supported where the node is an xml exchange and -provides the xquery to use in the binding. This can be used in -conjunction with a 'legacy-amqp-direct-binding' in order to control -the binding ley used for the binding. - -If the dynamic flag is set on the source or target, then the -dynamic-node-properties are inspected to determine the characteristics -of the node to be created. The properties that are recognised are the -same as accepted via the create qmf method; the 0-10 defined options -durable, auto-delete, alternate-exchange, exchange-type and then any -qpidd specific options (e.g. qpid.max-count). The broker supports all -standard values for the standard lifetime-policy property also. - -The supported-dist-modes property as defined by the 1.0 specification -is used to determine whether a queue or exchange is desired (where the -create method uses the 'type' property). If 'move' is specified a -queue will be created, if 'copy' is specified an exchange will be -created. If this property is not set, then a queue is assumed. - -Messages sent over AMQP 0-10 will be converted by the broker for -sending over AMQP 1.0 and vice versa. - -The message-id, correlation-id, userid, content-type and -content-encoding all map fairly simply in both directions between the -properties section in 1.0 and the message-properties in an 0-10 -header. Note however that in 0-10 a message-id must be a UUID, and in -translating to 0-10 from 1.0 this field will be skipped unless it is a -valid UUID. - -Likewise the priority directly between the field in the header section -of a 1.0 message and the corresponding field in the -delivery-properties of an 0-10 message. The durable header in a 1.0 -message is equivalent to the delivery-mode in the delivery-properties -of an 0-10 message, with a value of true in the former being -equivalent to a value of 2 in the latter and a value of false in the -former equivalent to 1 in the latter. - -When converting from 0-10 to 1.0, the reply-to will be simply the -routing-key if the exchange is not set, or if it is the reply-to -address for 1.0 will be composed of the exchange and if specified the -routing key (separated by a forward slash). - -When converting from 1.0 to 0-10, if the address contains a forward -slash it is assumed to be of the form exchange/routing key. If not it -is assumed to be a simple node name. If that name matches an existing -queue, then the resulting 0-10 reply to will have the exchange empty -and the routing key populated with the queue name. If not, but the -name matches and exchange, then the reply to will have the exchange -populated with the node name and the routing key left empty. If the -node refers to neither a known queue nor exchange then the resulting -reply to will be empty. - -When converting from 0-10 to 1.0, if the 0-10 message has a non-empty -destination, then the subject field in the properties of the 1.0 -message is set to the value of the routing-key from the -message-properties of the 0-10 message. In the reverse direction, the -subject field of the properties section of the 1.0 message is used to -populate the routing-key in the message-properties of the 0-10 -message. - -The destination of a 0-10 message is used to populate the 'to' field -of the properties section when converting to 1.0, but the reverse -translation is not done (as the destination for messages sent out by -the broker is controlled by the subscription in 0-10). - -The application-properties section of a 1.0 message is converted to -the application-headers field in the message-properties of an 0-10 -message and vice versa. - -Map and list content is converted between 1.0 and 0-10 -formats. Specifically, a 1.0 message with a list- or map- typed -AmqpValue section will be converetd into an 0-10 message with the -content=type set to amqp/list or amqp/map respectively and the content -encoded in the 0-10 typesystem. Likewise an 0-10 message with -content-type set to amqp/list or amqp/map will be converted into a 1.0 -message with an AmqpValue section containing a list or map -respectively, encoded in the 1.0 typesystem. - -The broker recognises particular capabilities for source and -targets. It will only include a given capability in the attach it -sends if that has been 'requested' in the attach sent by the peer to -trigger the establishment of the link. This gives the peer some means -of ensuring their expectations will be met. - -The 'shared' capability allows subscriptions from an exchange to be -shared by multiple receivers. Where this is specified the subscription -queue created takes the name of the link (and does not include the -container id). - -The 'durable' capability will be added if the queue or exchange -refered to by the source or target is durable. The 'queue' capability -will be added if the source or target references a queue. The 'topic' -capability will be added if the source or target references an -exchange. If the source or target references a queue or a direct -exchange the 'legacy-amqp-direct-binding' will be added. If it -references a queue or a topic exchange, 'legacy-amqp-topic-binding' -will be added. - -* Topics: a mechanism for controlling subscription queues - -As there is no standard or obvious mechanism through which to -configure subscription queues in AMQP 1.0, a new broker entity of type -'topic' has been added. - -A topic references an existing exchange and additionally specifies the -queue options to use when creating the subscription queue for any -receiver link attached to that topic. There can be topics with -different names all referencing the same exchange where different -policies should be applied to queues. - -Topics can be created and deleted using the qpid-config tool, e.g. - - qpid-config add topic my-topic --argument exchange=amq.topic\ - --argument qpid.max_count=500 --argument qpid.policy_type=self-destruct - -If a receiver is established for address 'my-topic/my-key' over 1.0 -now, it will result in a subscription queue being created with a limit -of 500 messages, that deletes itself (thus ending the subscription) if -that limit is exceeded and is bound to 'amq.topic' with the key -'my-key'. - -* 'Policies': a mechanism for broker configured, on-demand creation of - nodes - -As the core AMQP 1.0 protocol deliberately doesn't cover the creation -of nodes, a new mechanism has been added that allows nodes to be -created on-demand requiring only broker configuration. A client can -establish a link to or from a node, and if the desired target/source -matches a preconfigured policy, then the node will be created on -demand in accprdance with that policy. - -There are currently two types of policy: QueuePolicy and -TopicPolicy. These allow for the on-demand creation of queues or -'topics' (in the JMS sense of the word), which are currently backed by -pre-1.0 AMQP style exchanges. - -Policies of either type can be created using the qpid-config tool, -e.g. - - qpid-config add QueuePolicy queue_ --argument qpid.max_count=500 - -will create a policy such that any attempt to establish a link to or -from a node that begins with queue_ will result on a queue with the -required name being created if it doesn't exist. In this example the -queue would have a max depth of 500 messages. - -* Broker Initiated Links - -The existing 'federation' mechanism is quite tightly bound to the AMQP -0-10 implementation at present. The AMQP 1.0 support includes a -slightly different mechanism that offers the ability to establish -links to and from nodes in remote containers, and thus setup the -automatic transfer of messages. - -To begin with, a 'domain' entity must be created describing how to -connect to the given external process (i.e. the remote -container). This can again be done with qpid-config, e.g. - - qpid-config add domain another-broker --argument url=host.acme.com - -Incoming or outgoing links can then be established, e.g. - - qpid-config add incoming link_a --argument domain=another-broker \ - --argument src=some_remote_queue --argument dest=my_local_queue - -will cause messages on a node named 'some_remote_queue' on the process -reachable through the default AMQP port on host.acme.com, to be -transferred to a queue, on the qpidd instance these command were -issued to, named my_local_queue. - -Note that at present there is no automatic re-establishment of these -broker initiated AMQP 1.0 based links, nor is there any loop -prevention mechanism for messages transmitted over them in the event -that the links form circular paths. - -[1] https://issues.apache.org/jira/browse/QPID-4710 diff --git a/qpid/cpp/docs/api/CMakeLists.txt b/qpid/cpp/docs/api/CMakeLists.txt deleted file mode 100644 index e48f4fd63d..0000000000 --- a/qpid/cpp/docs/api/CMakeLists.txt +++ /dev/null @@ -1,45 +0,0 @@ -# -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# - -if (BUILD_DOCS) - # The user.doxygen.in file was originally written for a - # configure-generated situation so makes use of configure names that - # need to be set from the CMake equivalents. - set (top_builddir ${CMAKE_BINARY_DIR}) - set (top_srcdir ${CMAKE_SOURCE_DIR}) - set (srcdir ${CMAKE_CURRENT_SOURCE_DIR}) - configure_file (${CMAKE_CURRENT_SOURCE_DIR}/user.doxygen.in - ${CMAKE_CURRENT_BINARY_DIR}/user.doxygen) - configure_file (${CMAKE_CURRENT_SOURCE_DIR}/developer.doxygen.in - ${CMAKE_CURRENT_BINARY_DIR}/developer.doxygen) - add_custom_target (docs-user-api COMMAND ${DOXYGEN_EXECUTABLE} user.doxygen) - add_custom_target (docs-developer COMMAND ${DOXYGEN_EXECUTABLE} developer.doxygen) - add_dependencies (docs docs-developer docs-user-api) - - # HTML files are generated to ./html - put those in the install. - install (DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/html/ - DESTINATION ${QPID_INSTALL_DOCDIR}/api/html - COMPONENT ${QPID_COMPONENT_CLIENT_INCLUDE} - OPTIONAL) - if (CPACK_GENERATOR STREQUAL "NSIS") - set (CPACK_NSIS_MENU_LINKS - "${QPID_INSTALL_HTMLDIR}/index.html" "Qpid C++ API Documentation" - "https://issues.apache.org/jira/browse/QPID" "Report Qpid Problem") - endif (CPACK_GENERATOR STREQUAL "NSIS") -endif (BUILD_DOCS) diff --git a/qpid/cpp/docs/api/developer.doxygen.in b/qpid/cpp/docs/api/developer.doxygen.in deleted file mode 100644 index 1e1fddab80..0000000000 --- a/qpid/cpp/docs/api/developer.doxygen.in +++ /dev/null @@ -1,1261 +0,0 @@ -# -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# - -# ---------------------------------------------------------------- -# Doxygen settings for Qpid developer documentation. -# -# ---------------------------------------------------------------- - -# Doxyfile 1.4.6 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project -# -# All text after a hash (#) is considered a comment and will be ignored -# The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" ") - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# by quotes) that should identify the project. - -PROJECT_NAME = Qpid - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. - -PROJECT_NUMBER = 0 - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. - -OUTPUT_DIRECTORY = . - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. - -CREATE_SUBDIRS = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, -# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, -# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, -# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, -# Swedish, and Ukrainian. - -OUTPUT_LANGUAGE = English - -# This tag can be used to specify the encoding used in the generated output. -# The encoding is not always determined by the language that is chosen, -# but also whether or not the output is meant for Windows or non-Windows users. -# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES -# forces the Windows encoding (this is the default for the Windows binary), -# whereas setting the tag to NO uses a Unix-style encoding (the default for -# all platforms other than Windows). - -USE_WINDOWS_ENCODING = NO - -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief -# description. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. - -INLINE_INHERITED_MEMB = YES # was NO - jwr - -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. - -FULL_PATH_NAMES = YES - -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. - -STRIP_FROM_PATH = ../../src ../../ - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful is your file systems -# doesn't support long names like on DOS, Mac, or CD-ROM. - -SHORT_NAMES = YES - -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like the Qt-style comments (thus requiring an -# explicit @brief command for a brief description. - -JAVADOC_AUTOBRIEF = YES - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. - -MULTILINE_CPP_IS_BRIEF = YES # was NO - -# If the DETAILS_AT_TOP tag is set to YES then Doxygen -# will output the detailed description near the top, like JavaDoc. -# If set to NO, the detailed description appears after the member -# documentation. - -DETAILS_AT_TOP = YES # was NO - -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. - -TAB_SIZE = 8 - -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for Java. -# For instance, namespaces will be presented as packages, qualified scopes -# will look different, etc. - -OPTIMIZE_OUTPUT_JAVA = NO - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to -# include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. - -BUILTIN_STL_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. - -DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. - -SUBGROUPING = YES - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. - -EXTRACT_PRIVATE = NO # was YES - -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. - -EXTRACT_STATIC = YES - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. - -EXTRACT_LOCAL_CLASSES = NO # was YES - -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. - -EXTRACT_LOCAL_METHODS = NO # was YES - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. - -INTERNAL_DOCS = YES - -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. - -HIDE_SCOPE_NAMES = NO - -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. - -SHOW_INCLUDE_FILES = YES - -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. - -SORT_BRIEF_DOCS = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. - -SORT_BY_SCOPE_NAME = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and defines in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the -# list will mention the files that were used to generate the documentation. - -SHOW_USED_FILES = YES - -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = NO - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from the -# version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. - -FILE_VERSION_FILTER = - -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. - -WARNINGS = YES - -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. - -WARN_IF_UNDOCUMENTED = YES - -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be abled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. - -WARN_NO_PARAMDOC = YES - -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. - -WARN_LOGFILE = doxygen.log - -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. - -INPUT = @top_srcdir@/docs/api/doxygen_developer_mainpage.h @top_srcdir@/include @top_srcdir@/src @top_builddir@/include @top_builddir@/src - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: - - -FILE_PATTERNS = *.h *.cpp - -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. - -EXCLUDE = test - -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix filesystem feature) are excluded -# from the input. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be -# ignored. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER -# is applied to all files. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). - -FILTER_SOURCE_FILES = NO - -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. - -SOURCE_BROWSER = YES - -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES (the default) -# then for each documented function all documented -# functions referencing it will be listed. - -REFERENCED_BY_RELATION = YES - -# If the REFERENCES_RELATION tag is set to YES (the default) -# then for each documented function all documented entities -# called/used by that function will be listed. - -REFERENCES_RELATION = YES - -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. - -ALPHABETICAL_INDEX = NO - -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. - -HTML_OUTPUT = html-dev - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# stylesheet in the HTML output directory as well, or it will be erased! - -HTML_STYLESHEET = - -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = YES - -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) -# of the generated HTML documentation. - -GENERATE_HTMLHELP = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be -# written to the html output directory. - -CHM_FILE = - -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. - -HHC_LOCATION = - -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). - -GENERATE_CHI = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. - -TOC_EXPAND = NO - -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. - -DISABLE_INDEX = NO - -# This tag can be used to set the number of enum values (range [1..20]) -# that doxygen will group on one line in the generated HTML documentation. - -ENUM_VALUES_PER_LINE = 4 - -# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be -# generated containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are -# probably better off using the HTML help feature. - -GENERATE_TREEVIEW = NO - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. - -TREEVIEW_WIDTH = 250 - -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- - -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will -# generate Latex output. - -GENERATE_LATEX = NO - -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `latex' will be used as the default path. - -LATEX_OUTPUT = latex - -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. If left blank `latex' will be used as the default command name. - -LATEX_CMD_NAME = latex - -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the -# default command name. - -MAKEINDEX_CMD_NAME = makeindex - -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_LATEX = NO - -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, a4wide, letter, legal and -# executive. If left blank a4wide will be used. - -PAPER_TYPE = a4wide - -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX -# packages that should be included in the LaTeX output. - -EXTRA_PACKAGES = - -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a -# standard header. Notice: only use this tag if you know what you are doing! - -LATEX_HEADER = - -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references -# This makes the output suitable for online browsing using a pdf viewer. - -PDF_HYPERLINKS = NO - -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a -# higher quality PDF documentation. - -USE_PDFLATEX = NO - -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. -# This option is also used when generating formulas in HTML. - -LATEX_BATCHMODE = NO - -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) -# in the output. - -LATEX_HIDE_INDICES = NO - -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- - -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with -# other RTF readers or editors. - -GENERATE_RTF = NO - -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `rtf' will be used as the default path. - -RTF_OUTPUT = rtf - -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_RTF = NO - -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. -# Note: wordpad (write) and others do not support links. - -RTF_HYPERLINKS = NO - -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide -# replacements, missing definitions are set to their default value. - -RTF_STYLESHEET_FILE = - -# Set optional variables used in the generation of an rtf document. -# Syntax is similar to doxygen's config file. - -RTF_EXTENSIONS_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- - -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will -# generate man pages - -GENERATE_MAN = NO - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `man' will be used as the default path. - -MAN_OUTPUT = man - -# The MAN_EXTENSION tag determines the extension that is added to -# the generated man pages (default is the subroutine's section .3) - -MAN_EXTENSION = .3 - -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command -# would be unable to find the correct page. The default is NO. - -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of -# the code including all documentation. - -GENERATE_XML = NO - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `xml' will be used as the default path. - -XML_OUTPUT = xml - -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_DTD = - -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that -# enabling this will significantly increase the size of the XML output. - -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental -# and incomplete at the moment. - -GENERATE_AUTOGEN_DEF = NO - -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- - -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the -# moment. - -GENERATE_PERLMOD = NO - -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able -# to generate PDF and DVI output from the Perl module output. - -PERLMOD_LATEX = NO - -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller -# and Perl will parse it just the same. - -PERLMOD_PRETTY = YES - -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same -# Makefile don't overwrite each other's variables. - -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include -# files. - -ENABLE_PREPROCESSING = YES - -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled -# way by setting EXPAND_ONLY_PREDEF to YES. - -MACRO_EXPANSION = YES - -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the -# PREDEFINED and EXPAND_AS_DEFINED tags. - -EXPAND_ONLY_PREDEF = YES - -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files -# in the INCLUDE_PATH (see below) will be search if a #include is found. - -SEARCH_INCLUDES = YES - -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by -# the preprocessor. - -INCLUDE_PATH = - - -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will -# be used. - -INCLUDE_FILE_PATTERNS = - -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator -# instead of the = operator. - -PREDEFINED = QPID_CLIENT_EXTERN= QPID_COMMON_EXTERN= QPID_CONSOLE_EXTERN= QPID_BROKER_EXTERN= QPID_MESSAGING_EXTERN= QMF_EXTERN= QMFE_EXTERN= - -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. -# Use the PREDEFINED tag if you want to use a different macro definition. - -EXPAND_AS_DEFINED = - -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all function-like macros that are alone -# on a line, have an all uppercase name, and do not end with a semicolon. Such -# function macros are typically used for boiler-plate code, and will confuse -# the parser if not removed. - -SKIP_FUNCTION_MACROS = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- - -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen -# is run, you must also specify the path to the tagfile here. - -TAGFILES = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create -# a tag file that is based on the input files it reads. - -GENERATE_TAGFILE = - -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes -# will be listed. - -ALLEXTERNALS = NO - -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will -# be listed. - -EXTERNAL_GROUPS = YES - -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of `which perl'). - -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- - -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option is superseded by the HAVE_DOT option below. This is only a -# fallback. It is recommended to install and use dot, since it yields more -# powerful graphs. - -CLASS_DIAGRAMS = YES - -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented -# or is not a class. - -HIDE_UNDOC_RELATIONS = NO - -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section -# have no effect if this option is set to NO (the default) - -HAVE_DOT = NO - -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the -# the CLASS_DIAGRAMS tag to NO. - -CLASS_GRAPH = YES - -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and -# class references variables) of the class with other documented classes. - -COLLABORATION_GRAPH = YES - -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for groups, showing the direct groups dependencies - -GROUP_GRAPHS = YES - -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling -# Language. - -UML_LOOK = YES - -# If set to YES, the inheritance and collaboration graphs will show the -# relations between templates and their instances. - -TEMPLATE_RELATIONS = YES - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with -# other documented files. - -INCLUDE_GRAPH = YES - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or -# indirectly include this file. - -INCLUDED_BY_GRAPH = YES - -# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will -# generate a call dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. - -CALL_GRAPH = NO - -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen -# will graphical hierarchy of all classes instead of a textual one. - -GRAPHICAL_HIERARCHY = YES - -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories -# in a graphical way. The dependency relations are determined by the #include -# relations between the files in the directories. - -DIRECTORY_GRAPH = YES - -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. Possible values are png, jpg, or gif -# If left blank png will be used. - -DOT_IMAGE_FORMAT = png - -# The tag DOT_PATH can be used to specify the path where the dot tool can be -# found. If left blank, it is assumed the dot tool can be found in the path. - -DOT_PATH = - -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the -# \dotfile command). - -DOTFILE_DIRS = - -# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width -# (in pixels) of the graphs generated by dot. If a graph becomes larger than -# this value, doxygen will try to truncate the graph, so that it fits within -# the specified constraint. Beware that most browsers cannot cope with very -# large images. - -MAX_DOT_GRAPH_WIDTH = 1024 - -# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height -# (in pixels) of the graphs generated by dot. If a graph becomes larger than -# this value, doxygen will try to truncate the graph, so that it fits within -# the specified constraint. Beware that most browsers cannot cope with very -# large images. - -MAX_DOT_GRAPH_HEIGHT = 1024 - -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that a graph may be further truncated if the graph's -# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH -# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), -# the graph is not depth-constrained. - -MAX_DOT_GRAPH_DEPTH = 0 - -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, which results in a white background. -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). - -DOT_TRANSPARENT = NO - -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) -# support this, this feature is disabled by default. - -DOT_MULTI_TARGETS = NO - -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and -# arrows in the dot generated graphs. - -GENERATE_LEGEND = YES - -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate -# the various graphs. - -DOT_CLEANUP = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to the search engine -#--------------------------------------------------------------------------- - -# The SEARCHENGINE tag specifies whether or not a search engine should be -# used. If set to NO the values of all tags below this one will be ignored. - -SEARCHENGINE = YES diff --git a/qpid/cpp/docs/api/doxygen.css b/qpid/cpp/docs/api/doxygen.css deleted file mode 100644 index 3292768f0c..0000000000 --- a/qpid/cpp/docs/api/doxygen.css +++ /dev/null @@ -1,494 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { - font-family: Geneva, Arial, Helvetica, sans-serif; -} -BODY,TD { - font-size: 90%; -} -H1 { - text-align: center; - font-size: 160%; -} -H2 { - font-size: 120%; -} -H3 { - font-size: 100%; -} -CAPTION { - font-weight: bold -} -DIV.qindex { - width: 100%; - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - padding: 2px; - line-height: 140%; -} -DIV.navpath { - width: 100%; - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - padding: 2px; - line-height: 140%; -} -DIV.navtab { - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; -} -TD.navtab { - font-size: 70%; -} -A.qindex { - text-decoration: none; - font-weight: bold; - color: #1A419D; -} -A.qindex:visited { - text-decoration: none; - font-weight: bold; - color: #1A419D -} -A.qindex:hover { - text-decoration: none; - background-color: #ddddff; -} -A.qindexHL { - text-decoration: none; - font-weight: bold; - background-color: #6666cc; - color: #ffffff; - border: 1px double #9295C2; -} -A.qindexHL:hover { - text-decoration: none; - background-color: #6666cc; - color: #ffffff; -} -A.qindexHL:visited { - text-decoration: none; - background-color: #6666cc; - color: #ffffff -} -A.el { - text-decoration: none; - font-weight: bold -} -A.elRef { - font-weight: bold -} -A.code:link { - text-decoration: none; - font-weight: normal; - color: #0000FF -} -A.code:visited { - text-decoration: none; - font-weight: normal; - color: #0000FF -} -A.codeRef:link { - font-weight: normal; - color: #0000FF -} -A.codeRef:visited { - font-weight: normal; - color: #0000FF -} -A:hover { - text-decoration: none; - background-color: #f2f2ff -} -DL.el { - margin-left: -1cm -} -.fragment { - font-family: monospace, fixed; - font-size: 95%; -} -PRE.fragment { - border: 1px solid #CCCCCC; - background-color: #f5f5f5; - margin-top: 4px; - margin-bottom: 4px; - margin-left: 2px; - margin-right: 8px; - padding-left: 6px; - padding-right: 6px; - padding-top: 4px; - padding-bottom: 4px; -} -DIV.ah { - background-color: black; - font-weight: bold; - color: #ffffff; - margin-bottom: 3px; - margin-top: 3px -} - -DIV.groupHeader { - margin-left: 16px; - margin-top: 12px; - margin-bottom: 6px; - font-weight: bold; -} -DIV.groupText { - margin-left: 16px; - font-style: italic; - font-size: 90% -} -BODY { - background: white; - color: black; - margin-right: 20px; - margin-left: 20px; -} -TD.indexkey { - background-color: #e8eef2; - font-weight: bold; - padding-right : 10px; - padding-top : 2px; - padding-left : 10px; - padding-bottom : 2px; - margin-left : 0px; - margin-right : 0px; - margin-top : 2px; - margin-bottom : 2px; - border: 1px solid #CCCCCC; -} -TD.indexvalue { - background-color: #e8eef2; - font-style: italic; - padding-right : 10px; - padding-top : 2px; - padding-left : 10px; - padding-bottom : 2px; - margin-left : 0px; - margin-right : 0px; - margin-top : 2px; - margin-bottom : 2px; - border: 1px solid #CCCCCC; -} -TR.memlist { - background-color: #f0f0f0; -} -P.formulaDsp { - text-align: center; -} -IMG.formulaDsp { -} -IMG.formulaInl { - vertical-align: middle; -} -SPAN.keyword { color: #008000 } -SPAN.keywordtype { color: #604020 } -SPAN.keywordflow { color: #e08000 } -SPAN.comment { color: #800000 } -SPAN.preprocessor { color: #806020 } -SPAN.stringliteral { color: #002080 } -SPAN.charliteral { color: #008080 } -SPAN.vhdldigit { color: #ff00ff } -SPAN.vhdlchar { color: #000000 } -SPAN.vhdlkeyword { color: #700070 } -SPAN.vhdllogic { color: #ff0000 } - -.mdescLeft { - padding: 0px 8px 4px 8px; - font-size: 80%; - font-style: italic; - background-color: #FAFAFA; - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; -} -.mdescRight { - padding: 0px 8px 4px 8px; - font-size: 80%; - font-style: italic; - background-color: #FAFAFA; - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; -} -.memItemLeft { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; -} -.memItemRight { - padding: 1px 8px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; -} -.memTemplItemLeft { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: none; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; -} -.memTemplItemRight { - padding: 1px 8px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: none; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; -} -.memTemplParams { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - color: #606060; - background-color: #FAFAFA; - font-size: 80%; -} -.search { - color: #003399; - font-weight: bold; -} -FORM.search { - margin-bottom: 0px; - margin-top: 0px; -} -INPUT.search { - font-size: 75%; - color: #000080; - font-weight: normal; - background-color: #e8eef2; -} -TD.tiny { - font-size: 75%; -} -a { - color: #1A41A8; -} -a:visited { - color: #2A3798; -} -.dirtab { - padding: 4px; - border-collapse: collapse; - border: 1px solid #84b0c7; -} -TH.dirtab { - background: #e8eef2; - font-weight: bold; -} -HR { - height: 1px; - border: none; - border-top: 1px solid black; -} - -/* Style for detailed member documentation */ -.memtemplate { - font-size: 80%; - color: #606060; - font-weight: normal; - margin-left: 3px; -} -.memnav { - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; -} -.memitem { - padding: 4px; - background-color: #eef3f5; - border-width: 1px; - border-style: solid; - border-color: #dedeee; - -moz-border-radius: 8px 8px 8px 8px; -} -.memname { - white-space: nowrap; - font-weight: bold; -} -.memdoc{ - padding-left: 10px; -} -.memproto { - background-color: #d5e1e8; - width: 100%; - border-width: 1px; - border-style: solid; - border-color: #84b0c7; - font-weight: bold; - -moz-border-radius: 8px 8px 8px 8px; -} -.paramkey { - text-align: right; -} -.paramtype { - white-space: nowrap; -} -.paramname { - color: #602020; - font-style: italic; - white-space: nowrap; -} -/* End Styling for detailed member documentation */ - -/* for the tree view */ -.ftvtree { - font-family: sans-serif; - margin:0.5em; -} -/* these are for tree view when used as main index */ -.directory { - font-size: 9pt; - font-weight: bold; -} -.directory h3 { - margin: 0px; - margin-top: 1em; - font-size: 11pt; -} - -/* The following two styles can be used to replace the root node title */ -/* with an image of your choice. Simply uncomment the next two styles, */ -/* specify the name of your image and be sure to set 'height' to the */ -/* proper pixel height of your image. */ - -/* .directory h3.swap { */ -/* height: 61px; */ -/* background-repeat: no-repeat; */ -/* background-image: url("yourimage.gif"); */ -/* } */ -/* .directory h3.swap span { */ -/* display: none; */ -/* } */ - -.directory > h3 { - margin-top: 0; -} -.directory p { - margin: 0px; - white-space: nowrap; -} -.directory div { - display: none; - margin: 0px; -} -.directory img { - vertical-align: -30%; -} -/* these are for tree view when not used as main index */ -.directory-alt { - font-size: 100%; - font-weight: bold; -} -.directory-alt h3 { - margin: 0px; - margin-top: 1em; - font-size: 11pt; -} -.directory-alt > h3 { - margin-top: 0; -} -.directory-alt p { - margin: 0px; - white-space: nowrap; -} -.directory-alt div { - display: none; - margin: 0px; -} -.directory-alt img { - vertical-align: -30%; -} - diff --git a/qpid/cpp/docs/api/doxygen_developer_mainpage.h b/qpid/cpp/docs/api/doxygen_developer_mainpage.h deleted file mode 100644 index 81b61ec728..0000000000 --- a/qpid/cpp/docs/api/doxygen_developer_mainpage.h +++ /dev/null @@ -1,71 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -// This header file is just for doxygen documentation purposes. - -/** \mainpage Qpid Developer Documentation - * - *

Starting Points: Broker

- * - * - *

Message flow generally starts from the following methods:

- * - *
    - *

  • qpid::broker::Connection::received() - handles incoming decoded frames from the IO layer

    • - *

  • qpid::broker::Connection::doOutput() - sends messages to eligible consumers

    • - *
- * - *

The following classes are useful starting points for - * understanding the structure of the broker:

- * - *

IO:

- *

  • qpid::sys::Poller

- * - *

Broker - per Client

- *
    - *

  • qpid::broker::Connection

    • - *

  • qpid::broker::SemanticState

    • - *

  • qpid::broker::SemanticState::ConsumerImpl

    • - *
- * - *

Broker - shared among all clients

- * - *
    - *

  • qpid::broker::Queue

    • - *

  • qpid::broker::Exchange

    • - *

  • Subclasses of Queue and Exchange

    • - *
- * - * Add-on modules to the broker: - * - * - \ref ha-module "High Availability" - * - * - * - *

Starting Points: Client

- * - *

TBD

- * - *

Starting Points: Management

- * - *

TBD

- * - */ diff --git a/qpid/cpp/docs/api/doxygen_mainpage.h b/qpid/cpp/docs/api/doxygen_mainpage.h deleted file mode 100644 index 9acae52da4..0000000000 --- a/qpid/cpp/docs/api/doxygen_mainpage.h +++ /dev/null @@ -1,338 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -// This header file is just for doxygen documentation purposes. - -/** \mainpage Qpid C++ API Reference - * - *

Messaging Client API classes

- *
    - *

  • \ref messaging

    • - *

  • \ref qmfapi

    • - *
- * - *

Code for common tasks

- * - * - *

Includes and Namespaces

- * - * 
- * #include 
- * #include 
- * #include 
- * #include 
- * #include 
- * 
- * #include 
- * 
- * using namespace qpid::messaging;
- *
- * - *

Opening Sessions and Connections

- * - * 
- * int main(int argc, char** argv) {
- *     std::string broker = argc > 1 ? argv[1] : "localhost:5672";
- *     std::string address = argc > 2 ? argv[2] : "amq.topic";
- *     Connection connection(broker);
- *     try {
- *         connection.open();
- *         Session session = connection.createSession();
- * 
- * 	// ### Your Code Here ###
- *         
- *         connection.close();
- *         return 0;
- *     } catch(const std::exception& error) {
- *         std::cerr << error.what() << std::endl;
- *         connection.close();
- *         return 1;   
- *     }
- * }
- *
- * - *

Creating and Sending a Message

- * - * 
- * Sender sender = session.createSender(address);
- * sender.send(Message("Hello world!"));
- *
- * - *

Setting Message Content

- * - * 
- * Message message;
- * message.setContent("Hello world!");
- * 
- * // In some applications, you should also set the content type,
- * // which is a MIME type
- * message.setContentType("text/plain");
- *
- * - *

Receiving a Message

- * - * 
- * Receiver receiver = session.createReceiver(address);
- * Message message = receiver.fetch(Duration::SECOND * 1); // timeout is optional
- * session.acknowledge(); // acknowledge message receipt
- * std::cout << message.getContent() << std::endl;
- *
- * - *

Receiving Messages from Multiple Sources

- * - * To receive messages from multiple sources, create a receiver for each - * source, and use session.nextReceiver().fetch() to fetch messages. - * session.nextReceiver() is guaranteed to return the receiver - * responsible for the first available message on the session. - * - * 
- * Receiver receiver1 = session.createReceiver(address1);
- * Receiver receiver2 = session.createReceiver(address2);
- * 
- * Message message =  session.nextReceiver().fetch();
- * session.acknowledge(); // acknowledge message receipt
- * std::cout << message.getContent() << std::endl;
- *
- * - *

Replying to a message:

- * - * 
- * // Server creates a service queue and waits for messages
- * // If it gets a request, it sends a response to the reply to address
- *
- * Receiver receiver = session.createReceiver("service_queue; {create: always}");
- * Message request = receiver.fetch();
- * const Address& address = request.getReplyTo(); // Get "reply-to" from request ...
- * if (address) {
- *   Sender sender = session.createSender(address); // ... send response to "reply-to"
- *   Message response("pong!");
- *   sender.send(response);
- *   session.acknowledge();
- * }
- *
- *
- * // Client creates a private response queue - the # gets converted
- * // to a unique string for the response queue name. Client uses the
- * // name of this queue as its reply-to.
- *
- * Sender sender = session.createSender("service_queue");
- * Address responseQueue("#response-queue; {create:always, delete:always}");
- * Receiver receiver = session.createReceiver(responseQueue);
- *
- * Message request;
- * request.setReplyTo(responseQueue);
- * request.setContent("ping");
- * sender.send(request);
- * Message response = receiver.fetch();
- * std::cout << request.getContent() << " -> " << response.getContent() << std::endl;
- *
- * - * - *

Getting and Setting Standard Message Properties

- * - * This shows some of the most commonly used message properties, it is - * not complete. - * - * 
- * Message message("Hello world!");
- * message.setContentType("text/plain");
- * message.setSubject("greeting");
- * message.setReplyTo("response-queue");
- * message.setTtl(100); // milliseconds
- * message.setDurable(1);
- * 
- * std::cout << "Content: " << message.getContent() << std::endl
- *           << "Content Type: " << message.getContentType()
- *           << "Subject: " << message.getSubject()
- * 	  << "ReplyTo: " << message.getReplyTo()
- * 	  << "Time To Live (in milliseconds) " << message.getTtl()
- * 	  << "Durability: " << message.getDurable();
- *
- * - *

Getting and Setting Application-Defined Message Properties

- * - * 
- * std::string name = "weekday";
- * std::string value = "Thursday";
- * message.getProperties()[name] = value;
- * 
- * std:string s = message.getProperties()["weekday"];
- *
- * - *

Transparent Failover

- * - * If a connection opened using the reconnect option, it will - * transparently reconnect if the connection is lost. - * - * 
- * Connection connection(broker);
- * connection.setOption("reconnect", true);
- * try {
- *     connection.open();
- *     ....
- *
- * - * - *

Maps

- * - * Maps provide a simple way to exchange binary data portably, across - * languages and platforms. Maps can contain simple types, lists, or - * maps. - * - * - * 
- * // Sender
- * 
- * Variant::Map content;
- * content["id"] = 987654321;
- * content["name"] = "Widget";
- * content["probability"] = 0.43;
- * Variant::List colours;
- * colours.push_back(Variant("red"));
- * colours.push_back(Variant("green"));
- * colours.push_back(Variant("white"));
- * content["colours"] = colours;
- * content["uuid"] = Uuid(true);
- * 
- * Message message;
- * encode(content, message);
- * 	
- * sender.send(message);
- *
- * - * 
- * // Receiver
- * 
- * Variant::Map content;
- * decode(receiver.fetch(), content);
- *
- * - *

Guaranteed Delivery

- * - * If a queue is durable, the queue survives a messaging broker crash, as - * well as any durable messages that have been placed on the queue. These - * messages will be delivered when the messaging broker is - * restarted. Delivery is not guaranteed unless both the message and the - * queue are durable. - * - * 
- * Sender sender = session.createSender("durable-queue");
- * 
- * Message message("Hello world!");
- * message.setDurable(1);
- * 
- * sender.send(Message("Hello world!"));
- *
- * - * - *

Transactions

- * - * Transactions cover enqueues and dequeues. - * - * When sending messages, a transaction tracks enqueues without actually - * delivering the messages, a commit places messages on their queues, and - * a rollback discards the enqueues. - * - * When receiving messages, a transaction tracks dequeues without - * actually removing acknowledged messages, a commit removes all - * acknowledged messages, and a rollback discards acknowledgements. A - * rollback does not release the message, it must be explicitly released - * to return it to the queue. - * - * 
- * Connection connection(broker);
- * Session session =  connection.createTransactionalSession();
- * ...
- * if (looksOk)
- *    session.commit();
- * else 
- *    session.rollback();
- *
- * - *

Exceptions

- * - * All exceptions for the messaging API have MessagingException as - * their base class. - - * A common class of exception are those related to processing - * addresses used to create senders and/or receivers. These all have - * AddressError as their base class. - * - * Where there is a syntax error in the address itself, a - * MalformedAddress will be thrown. Where the address is valid, but - * there is an error in interpreting (i.e. resolving) it, a - * ResolutionError - or a sub-class of it - will be thrown. If the - * address has assertions enabled for a given context and the asserted - * node properties are not in fact correct then AssertionFailed will - * be thrown. If the node is not found, NotFound will be thrown. - * - * The loss of the underlying connection (e.g. the TCP connection) - * results in TransportFailure being thrown. If automatic reconnect is - * enabled, this will be caught be the library which will then try to - * reconnect. If reconnection - as configured by the connection - * options - fails, then TransportFailure will be thrown. This can - * occur on any call to the messaging API. - * - * Sending a message may also result in an exception - * (e.g. TargetCapacityExceeded if a queue to which the message is - * delivered cannot enqueue it due to lack of capacity). For - * asynchronous send the exception may not be thrown on the send - * invocation that actually triggers it, but on a subsequent method - * call on the API. - * - * Certain exceptions may render the session invalid; once these - * occur, subsequent calls on the session will throw the same class of - * exception. This is not an intrinsic property of the class of - * exception, but is a result of the current mapping of the API to the - * underlying AMQP 0-10 protocol. You can test whether the session is - * valid at any time using the hasError() and/or checkError() methods - * on Session. - * - *

Logging

- * - * The Qpidd broker and C++ clients can both use environment variables to - * enable logging. Use QPID_LOG_ENABLE to set the level of logging you - * are interested in (trace, debug, info, notice, warning, error, or - * critical): - * - * 
- * export QPID_LOG_ENABLE="warning+"
- *
- * - * Use QPID_LOG_OUTPUT to determine where logging output should be - * sent. This is either a file name or the special values stderr, stdout, - * or syslog: - * - * 
- * export QPID_LOG_TO_FILE="/tmp/myclient.out"
- *
- * - * - */ - -/** - * \defgroup messaging Qpid C++ Client API - * \defgroup qmfapi Qpid Management Framework C++ API - * - */ - - - diff --git a/qpid/cpp/docs/api/footer.html b/qpid/cpp/docs/api/footer.html deleted file mode 100644 index 5a31e81821..0000000000 --- a/qpid/cpp/docs/api/footer.html +++ /dev/null @@ -1,31 +0,0 @@ - - -
-
-Qpid C++ API Reference
- -
- -Generated on $date for $projectname by doxygen $doxygenversion -
- - diff --git a/qpid/cpp/docs/api/header.html b/qpid/cpp/docs/api/header.html deleted file mode 100644 index d2faa02984..0000000000 --- a/qpid/cpp/docs/api/header.html +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - $title - - - - - - - - - - -
- Apache Qpid - AMQP Messaging for Java JMS, C++, Python, Ruby, and .NET - - Apache Qpid Documentation -
- diff --git a/qpid/cpp/docs/api/stylesheet.css b/qpid/cpp/docs/api/stylesheet.css deleted file mode 100644 index 3292768f0c..0000000000 --- a/qpid/cpp/docs/api/stylesheet.css +++ /dev/null @@ -1,494 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -BODY,H1,H2,H3,H4,H5,H6,P,CENTER,TD,TH,UL,DL,DIV { - font-family: Geneva, Arial, Helvetica, sans-serif; -} -BODY,TD { - font-size: 90%; -} -H1 { - text-align: center; - font-size: 160%; -} -H2 { - font-size: 120%; -} -H3 { - font-size: 100%; -} -CAPTION { - font-weight: bold -} -DIV.qindex { - width: 100%; - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - padding: 2px; - line-height: 140%; -} -DIV.navpath { - width: 100%; - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - padding: 2px; - line-height: 140%; -} -DIV.navtab { - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; -} -TD.navtab { - font-size: 70%; -} -A.qindex { - text-decoration: none; - font-weight: bold; - color: #1A419D; -} -A.qindex:visited { - text-decoration: none; - font-weight: bold; - color: #1A419D -} -A.qindex:hover { - text-decoration: none; - background-color: #ddddff; -} -A.qindexHL { - text-decoration: none; - font-weight: bold; - background-color: #6666cc; - color: #ffffff; - border: 1px double #9295C2; -} -A.qindexHL:hover { - text-decoration: none; - background-color: #6666cc; - color: #ffffff; -} -A.qindexHL:visited { - text-decoration: none; - background-color: #6666cc; - color: #ffffff -} -A.el { - text-decoration: none; - font-weight: bold -} -A.elRef { - font-weight: bold -} -A.code:link { - text-decoration: none; - font-weight: normal; - color: #0000FF -} -A.code:visited { - text-decoration: none; - font-weight: normal; - color: #0000FF -} -A.codeRef:link { - font-weight: normal; - color: #0000FF -} -A.codeRef:visited { - font-weight: normal; - color: #0000FF -} -A:hover { - text-decoration: none; - background-color: #f2f2ff -} -DL.el { - margin-left: -1cm -} -.fragment { - font-family: monospace, fixed; - font-size: 95%; -} -PRE.fragment { - border: 1px solid #CCCCCC; - background-color: #f5f5f5; - margin-top: 4px; - margin-bottom: 4px; - margin-left: 2px; - margin-right: 8px; - padding-left: 6px; - padding-right: 6px; - padding-top: 4px; - padding-bottom: 4px; -} -DIV.ah { - background-color: black; - font-weight: bold; - color: #ffffff; - margin-bottom: 3px; - margin-top: 3px -} - -DIV.groupHeader { - margin-left: 16px; - margin-top: 12px; - margin-bottom: 6px; - font-weight: bold; -} -DIV.groupText { - margin-left: 16px; - font-style: italic; - font-size: 90% -} -BODY { - background: white; - color: black; - margin-right: 20px; - margin-left: 20px; -} -TD.indexkey { - background-color: #e8eef2; - font-weight: bold; - padding-right : 10px; - padding-top : 2px; - padding-left : 10px; - padding-bottom : 2px; - margin-left : 0px; - margin-right : 0px; - margin-top : 2px; - margin-bottom : 2px; - border: 1px solid #CCCCCC; -} -TD.indexvalue { - background-color: #e8eef2; - font-style: italic; - padding-right : 10px; - padding-top : 2px; - padding-left : 10px; - padding-bottom : 2px; - margin-left : 0px; - margin-right : 0px; - margin-top : 2px; - margin-bottom : 2px; - border: 1px solid #CCCCCC; -} -TR.memlist { - background-color: #f0f0f0; -} -P.formulaDsp { - text-align: center; -} -IMG.formulaDsp { -} -IMG.formulaInl { - vertical-align: middle; -} -SPAN.keyword { color: #008000 } -SPAN.keywordtype { color: #604020 } -SPAN.keywordflow { color: #e08000 } -SPAN.comment { color: #800000 } -SPAN.preprocessor { color: #806020 } -SPAN.stringliteral { color: #002080 } -SPAN.charliteral { color: #008080 } -SPAN.vhdldigit { color: #ff00ff } -SPAN.vhdlchar { color: #000000 } -SPAN.vhdlkeyword { color: #700070 } -SPAN.vhdllogic { color: #ff0000 } - -.mdescLeft { - padding: 0px 8px 4px 8px; - font-size: 80%; - font-style: italic; - background-color: #FAFAFA; - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; -} -.mdescRight { - padding: 0px 8px 4px 8px; - font-size: 80%; - font-style: italic; - background-color: #FAFAFA; - border-top: 1px none #E0E0E0; - border-right: 1px none #E0E0E0; - border-bottom: 1px none #E0E0E0; - border-left: 1px none #E0E0E0; - margin: 0px; -} -.memItemLeft { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; -} -.memItemRight { - padding: 1px 8px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; -} -.memTemplItemLeft { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: none; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; -} -.memTemplItemRight { - padding: 1px 8px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: none; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - background-color: #FAFAFA; - font-size: 80%; -} -.memTemplParams { - padding: 1px 0px 0px 8px; - margin: 4px; - border-top-width: 1px; - border-right-width: 1px; - border-bottom-width: 1px; - border-left-width: 1px; - border-top-color: #E0E0E0; - border-right-color: #E0E0E0; - border-bottom-color: #E0E0E0; - border-left-color: #E0E0E0; - border-top-style: solid; - border-right-style: none; - border-bottom-style: none; - border-left-style: none; - color: #606060; - background-color: #FAFAFA; - font-size: 80%; -} -.search { - color: #003399; - font-weight: bold; -} -FORM.search { - margin-bottom: 0px; - margin-top: 0px; -} -INPUT.search { - font-size: 75%; - color: #000080; - font-weight: normal; - background-color: #e8eef2; -} -TD.tiny { - font-size: 75%; -} -a { - color: #1A41A8; -} -a:visited { - color: #2A3798; -} -.dirtab { - padding: 4px; - border-collapse: collapse; - border: 1px solid #84b0c7; -} -TH.dirtab { - background: #e8eef2; - font-weight: bold; -} -HR { - height: 1px; - border: none; - border-top: 1px solid black; -} - -/* Style for detailed member documentation */ -.memtemplate { - font-size: 80%; - color: #606060; - font-weight: normal; - margin-left: 3px; -} -.memnav { - background-color: #e8eef2; - border: 1px solid #84b0c7; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; -} -.memitem { - padding: 4px; - background-color: #eef3f5; - border-width: 1px; - border-style: solid; - border-color: #dedeee; - -moz-border-radius: 8px 8px 8px 8px; -} -.memname { - white-space: nowrap; - font-weight: bold; -} -.memdoc{ - padding-left: 10px; -} -.memproto { - background-color: #d5e1e8; - width: 100%; - border-width: 1px; - border-style: solid; - border-color: #84b0c7; - font-weight: bold; - -moz-border-radius: 8px 8px 8px 8px; -} -.paramkey { - text-align: right; -} -.paramtype { - white-space: nowrap; -} -.paramname { - color: #602020; - font-style: italic; - white-space: nowrap; -} -/* End Styling for detailed member documentation */ - -/* for the tree view */ -.ftvtree { - font-family: sans-serif; - margin:0.5em; -} -/* these are for tree view when used as main index */ -.directory { - font-size: 9pt; - font-weight: bold; -} -.directory h3 { - margin: 0px; - margin-top: 1em; - font-size: 11pt; -} - -/* The following two styles can be used to replace the root node title */ -/* with an image of your choice. Simply uncomment the next two styles, */ -/* specify the name of your image and be sure to set 'height' to the */ -/* proper pixel height of your image. */ - -/* .directory h3.swap { */ -/* height: 61px; */ -/* background-repeat: no-repeat; */ -/* background-image: url("yourimage.gif"); */ -/* } */ -/* .directory h3.swap span { */ -/* display: none; */ -/* } */ - -.directory > h3 { - margin-top: 0; -} -.directory p { - margin: 0px; - white-space: nowrap; -} -.directory div { - display: none; - margin: 0px; -} -.directory img { - vertical-align: -30%; -} -/* these are for tree view when not used as main index */ -.directory-alt { - font-size: 100%; - font-weight: bold; -} -.directory-alt h3 { - margin: 0px; - margin-top: 1em; - font-size: 11pt; -} -.directory-alt > h3 { - margin-top: 0; -} -.directory-alt p { - margin: 0px; - white-space: nowrap; -} -.directory-alt div { - display: none; - margin: 0px; -} -.directory-alt img { - vertical-align: -30%; -} - diff --git a/qpid/cpp/docs/api/tabs.css b/qpid/cpp/docs/api/tabs.css deleted file mode 100644 index 56f0e04564..0000000000 --- a/qpid/cpp/docs/api/tabs.css +++ /dev/null @@ -1,123 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ - -/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */ - -DIV.tabs -{ - float : left; - width : 100%; - background : url("tab_b.gif") repeat-x bottom; - margin-bottom : 4px; -} - -DIV.tabs UL -{ - margin : 0px; - padding-left : 10px; - list-style : none; -} - -DIV.tabs LI, DIV.tabs FORM -{ - display : inline; - margin : 0px; - padding : 0px; -} - -DIV.tabs FORM -{ - float : right; -} - -DIV.tabs A -{ - float : left; - background : url("tab_r.gif") no-repeat right top; - border-bottom : 1px solid #84B0C7; - font-size : x-small; - font-weight : bold; - text-decoration : none; -} - -DIV.tabs A:hover -{ - background-position: 100% -150px; -} - -DIV.tabs A:link, DIV.tabs A:visited, -DIV.tabs A:active, DIV.tabs A:hover -{ - color: #1A419D; -} - -DIV.tabs SPAN -{ - float : left; - display : block; - background : url("tab_l.gif") no-repeat left top; - padding : 5px 9px; - white-space : nowrap; -} - -DIV.tabs INPUT -{ - float : right; - display : inline; - font-size : 1em; -} - -DIV.tabs TD -{ - font-size : x-small; - font-weight : bold; - text-decoration : none; -} - - - -/* Commented Backslash Hack hides rule from IE5-Mac \*/ -DIV.tabs SPAN {float : none;} -/* End IE5-Mac hack */ - -DIV.tabs A:hover SPAN -{ - background-position: 0% -150px; -} - -DIV.tabs LI.current A -{ - background-position: 100% -150px; - border-width : 0px; -} - -DIV.tabs LI.current SPAN -{ - background-position: 0% -150px; - padding-bottom : 6px; -} - -DIV.navpath -{ - background : none; - border : none; - border-bottom : 1px solid #84B0C7; -} diff --git a/qpid/cpp/docs/api/user.doxygen.in b/qpid/cpp/docs/api/user.doxygen.in deleted file mode 100644 index ec0fd1361c..0000000000 --- a/qpid/cpp/docs/api/user.doxygen.in +++ /dev/null @@ -1,1237 +0,0 @@ -# -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# - -# ---------------------------------------------------------------- -# Doxygen settings for Qpid user documentation. -# -# Note: Only public members of classes that are part of the public API -# should be documented here. For complete developer documentation use -# the developer.doxygen configuration. -# ---------------------------------------------------------------- - -# Doxyfile 1.4.6 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project -# -# All text after a hash (#) is considered a comment and will be ignored -# The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" ") - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# by quotes) that should identify the project. - -PROJECT_NAME = "Qpid C++ Client API" - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. - -# PROJECT_NUMBER = 0 - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. - -OUTPUT_DIRECTORY = . - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. - -CREATE_SUBDIRS = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, -# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, -# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, -# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, -# Swedish, and Ukrainian. - -OUTPUT_LANGUAGE = English - -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief -# description. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. - -INLINE_INHERITED_MEMB = YES - -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. - -FULL_PATH_NAMES = YES - -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. - -STRIP_FROM_PATH = @top_srcdir@/include @top_builddir@/include @top_builddir@/src/gen - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. - -STRIP_FROM_INC_PATH = @top_srcdir@/include @top_builddir@/include - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful is your file systems -# doesn't support long names like on DOS, Mac, or CD-ROM. - -SHORT_NAMES = YES - -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like the Qt-style comments (thus requiring an -# explicit @brief command for a brief description. - -JAVADOC_AUTOBRIEF = YES - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the DETAILS_AT_TOP tag is set to YES then Doxygen -# will output the detailed description near the top, like JavaDoc. -# If set to NO, the detailed description appears after the member -# documentation. - -DETAILS_AT_TOP = NO - -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. - -TAB_SIZE = 8 - -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for Java. -# For instance, namespaces will be presented as packages, qualified scopes -# will look different, etc. - -OPTIMIZE_OUTPUT_JAVA = NO - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to -# include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. - -BUILTIN_STL_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. - -DISTRIBUTE_GROUP_DOC = NO - -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. - -SUBGROUPING = YES - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. - -EXTRACT_STATIC = YES - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. - -EXTRACT_LOCAL_CLASSES = NO - -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. - -EXTRACT_LOCAL_METHODS = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_CLASSES = NO # jwr 2008-11-25 - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. - -HIDE_FRIEND_COMPOUNDS = YES - -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. - -HIDE_IN_BODY_DOCS = YES - -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. - -CASE_SENSE_NAMES = YES - -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. - -HIDE_SCOPE_NAMES = NO - -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. - -SHOW_INCLUDE_FILES = YES - -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. - -SORT_BRIEF_DOCS = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. - -SORT_BY_SCOPE_NAME = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and defines in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the -# list will mention the files that were used to generate the documentation. - -SHOW_USED_FILES = YES - -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = NO - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from the -# version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. - -FILE_VERSION_FILTER = - -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. - -QUIET = NO -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. - -WARNINGS = YES - -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. - -WARN_IF_UNDOCUMENTED = YES - -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be abled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. - -WARN_NO_PARAMDOC = NO - -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. - -WARN_LOGFILE = doxygen.log - -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. - -INPUT = @top_srcdir@/docs/api/doxygen_mainpage.h @top_srcdir@/include @top_builddir@/include - - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: - - -FILE_PATTERNS = *.h - -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. - -EXCLUDE = test tests broker amqp_0_10 log sys cluster management - -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix filesystem feature) are excluded -# from the input. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be -# ignored. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER -# is applied to all files. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). - -FILTER_SOURCE_FILES = NO - -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. - -SOURCE_BROWSER = YES - -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES (the default) -# then for each documented function all documented -# functions referencing it will be listed. - -REFERENCED_BY_RELATION = YES - -# If the REFERENCES_RELATION tag is set to YES (the default) -# then for each documented function all documented entities -# called/used by that function will be listed. - -REFERENCES_RELATION = YES - -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. - -VERBATIM_HEADERS = NO - -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. - -ALPHABETICAL_INDEX = YES - -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. - -HTML_HEADER = @srcdir@/header.html - -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. - -HTML_FOOTER = @srcdir@/footer.html - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# stylesheet in the HTML output directory as well, or it will be erased! - -HTML_STYLESHEET = - -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = YES - -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) -# of the generated HTML documentation. - -GENERATE_HTMLHELP = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be -# written to the html output directory. - -CHM_FILE = - -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. - -HHC_LOCATION = - -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). - -GENERATE_CHI = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. - -TOC_EXPAND = NO - -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. - -DISABLE_INDEX = NO - -# This tag can be used to set the number of enum values (range [1..20]) -# that doxygen will group on one line in the generated HTML documentation. - -ENUM_VALUES_PER_LINE = 4 - -# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be -# generated containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are -# probably better off using the HTML help feature. - -GENERATE_TREEVIEW = NO - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. - -TREEVIEW_WIDTH = 250 - -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- - -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will -# generate Latex output. - -GENERATE_LATEX = NO - -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `latex' will be used as the default path. - -LATEX_OUTPUT = latex - -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. If left blank `latex' will be used as the default command name. - -LATEX_CMD_NAME = latex - -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the -# default command name. - -MAKEINDEX_CMD_NAME = makeindex - -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_LATEX = NO - -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, a4wide, letter, legal and -# executive. If left blank a4wide will be used. - -PAPER_TYPE = a4wide - -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX -# packages that should be included in the LaTeX output. - -EXTRA_PACKAGES = - -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a -# standard header. Notice: only use this tag if you know what you are doing! - -LATEX_HEADER = - -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references -# This makes the output suitable for online browsing using a pdf viewer. - -PDF_HYPERLINKS = NO - -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a -# higher quality PDF documentation. - -USE_PDFLATEX = NO - -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. -# This option is also used when generating formulas in HTML. - -LATEX_BATCHMODE = NO - -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) -# in the output. - -LATEX_HIDE_INDICES = NO - -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- - -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with -# other RTF readers or editors. - -GENERATE_RTF = NO - -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `rtf' will be used as the default path. - -RTF_OUTPUT = rtf - -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_RTF = NO - -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. -# Note: wordpad (write) and others do not support links. - -RTF_HYPERLINKS = NO - -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide -# replacements, missing definitions are set to their default value. - -RTF_STYLESHEET_FILE = - -# Set optional variables used in the generation of an rtf document. -# Syntax is similar to doxygen's config file. - -RTF_EXTENSIONS_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- - -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will -# generate man pages - -GENERATE_MAN = NO - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `man' will be used as the default path. - -MAN_OUTPUT = man - -# The MAN_EXTENSION tag determines the extension that is added to -# the generated man pages (default is the subroutine's section .3) - -MAN_EXTENSION = .3 - -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command -# would be unable to find the correct page. The default is NO. - -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of -# the code including all documentation. - -GENERATE_XML = NO - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `xml' will be used as the default path. - -XML_OUTPUT = xml - -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_DTD = - -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that -# enabling this will significantly increase the size of the XML output. - -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental -# and incomplete at the moment. - -GENERATE_AUTOGEN_DEF = NO - -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- - -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the -# moment. - -GENERATE_PERLMOD = NO - -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able -# to generate PDF and DVI output from the Perl module output. - -PERLMOD_LATEX = NO - -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller -# and Perl will parse it just the same. - -PERLMOD_PRETTY = YES - -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same -# Makefile don't overwrite each other's variables. - -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include -# files. - -ENABLE_PREPROCESSING = YES - -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled -# way by setting EXPAND_ONLY_PREDEF to YES. - -MACRO_EXPANSION = YES - -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the -# PREDEFINED and EXPAND_AS_DEFINED tags. - -EXPAND_ONLY_PREDEF = NO - -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files -# in the INCLUDE_PATH (see below) will be search if a #include is found. - -SEARCH_INCLUDES = YES - -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by -# the preprocessor. - -INCLUDE_PATH = - -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will -# be used. - -INCLUDE_FILE_PATTERNS = - -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator -# instead of the = operator. - -PREDEFINED = QPID_CLIENT_EXTERN= QPID_COMMON_EXTERN= QPID_CONSOLE_EXTERN= QPID_BROKER_EXTERN= QPID_MESSAGING_EXTERN= QMF_EXTERN= QMFE_EXTERN= - -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. -# Use the PREDEFINED tag if you want to use a different macro definition. - -EXPAND_AS_DEFINED = BOOST_PARAMETER_MEMFUN - -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all function-like macros that are alone -# on a line, have an all uppercase name, and do not end with a semicolon. Such -# function macros are typically used for boiler-plate code, and will confuse -# the parser if not removed. - -SKIP_FUNCTION_MACROS = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- - -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen -# is run, you must also specify the path to the tagfile here. - -TAGFILES = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create -# a tag file that is based on the input files it reads. - -GENERATE_TAGFILE = - -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes -# will be listed. - -ALLEXTERNALS = NO - -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will -# be listed. - -EXTERNAL_GROUPS = YES - -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of `which perl'). - -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- - -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option is superseded by the HAVE_DOT option below. This is only a -# fallback. It is recommended to install and use dot, since it yields more -# powerful graphs. - -CLASS_DIAGRAMS = NO - -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented -# or is not a class. - -HIDE_UNDOC_RELATIONS = YES - -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section -# have no effect if this option is set to NO (the default) - -HAVE_DOT = NO - -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the -# the CLASS_DIAGRAMS tag to NO. - -CLASS_GRAPH = NO - -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and -# class references variables) of the class with other documented classes. - -COLLABORATION_GRAPH = NO - -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for groups, showing the direct groups dependencies - -GROUP_GRAPHS = NO - -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling -# Language. - -UML_LOOK = NO - -# If set to YES, the inheritance and collaboration graphs will show the -# relations between templates and their instances. - -TEMPLATE_RELATIONS = NO - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with -# other documented files. - -INCLUDE_GRAPH = NO - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or -# indirectly include this file. - -INCLUDED_BY_GRAPH = NO - -# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will -# generate a call dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. - -CALL_GRAPH = NO - -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen -# will graphical hierarchy of all classes instead of a textual one. - -GRAPHICAL_HIERARCHY = NO - -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories -# in a graphical way. The dependency relations are determined by the #include -# relations between the files in the directories. - -DIRECTORY_GRAPH = NO - -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. Possible values are png, jpg, or gif -# If left blank png will be used. - -DOT_IMAGE_FORMAT = PNG - -# The tag DOT_PATH can be used to specify the path where the dot tool can be -# found. If left blank, it is assumed the dot tool can be found in the path. - -DOT_PATH = - -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the -# \dotfile command). - -DOTFILE_DIRS = - -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that a graph may be further truncated if the graph's -# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH -# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), -# the graph is not depth-constrained. - -MAX_DOT_GRAPH_DEPTH = 0 - -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, which results in a white background. -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). - -DOT_TRANSPARENT = NO - -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) -# support this, this feature is disabled by default. - -DOT_MULTI_TARGETS = NO - -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and -# arrows in the dot generated graphs. - -GENERATE_LEGEND = YES - -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate -# the various graphs. - -DOT_CLEANUP = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to the search engine -#--------------------------------------------------------------------------- - -# The SEARCHENGINE tag specifies whether or not a search engine should be -# used. If set to NO the values of all tags below this one will be ignored. - -SEARCHENGINE = NO diff --git a/qpid/cpp/docs/book/.gitignore b/qpid/cpp/docs/book/.gitignore deleted file mode 100644 index 21f1f20096..0000000000 --- a/qpid/cpp/docs/book/.gitignore +++ /dev/null @@ -1,21 +0,0 @@ -# -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# - -/build -/out diff --git a/qpid/cpp/docs/book/Makefile b/qpid/cpp/docs/book/Makefile deleted file mode 100644 index 6e97a0c5cc..0000000000 --- a/qpid/cpp/docs/book/Makefile +++ /dev/null @@ -1,38 +0,0 @@ -# -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# - -DIRS = src/cpp-broker src/programming - - -.PHONY: all $(DIRS) - -all: $(DIRS) - -clean: - rm -rf build - -html: TARGET = html -html: all - -pdf: TARGET = pdf -pdf: all - -$(DIRS): - $(MAKE) -C $@ $(TARGET) OUTPUTDIR=../../build/ - diff --git a/qpid/cpp/docs/book/src/Makefile.inc b/qpid/cpp/docs/book/src/Makefile.inc deleted file mode 100644 index 4de5733740..0000000000 --- a/qpid/cpp/docs/book/src/Makefile.inc +++ /dev/null @@ -1,63 +0,0 @@ -# -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# - -BOOK=$(wildcard *Book.xml Programming-In-Apache-Qpid.xml ) -XML=$(wildcard *.xml) $(wildcard ../common/*.xml) -IMAGES=$(wildcard images/*.png) -CSS=$(wilcard ../common/css/*.css) - -OUTPUTDIR=output -OUTPUT= $(BOOK:%.xml=$(OUTPUTDIR)/%/) - -all: html pdf - -pdf: $(OUTPUT)/pdf $(BOOK:%.xml=$(OUTPUT)/pdf/%.pdf) - -html: $(OUTPUT)/html $(BOOK:%.xml=$(OUTPUT)/html/index.html) - -$(OUTPUT)/html/images: $(IMAGES) - -mkdir -p $(OUTPUT)/html/images - -cp images/*.png $(OUTPUT)/html/images/ - -$(OUTPUT)/html/css: $(CSS) - -mkdir -p $(OUTPUT)/html/css - -cp ../common/css/*.css $(OUTPUT)/html/css - -$(OUTPUT)/html: - -mkdir -p $(OUTPUT)/html - -$(OUTPUT)/pdf: - -mkdir -p $(OUTPUT)/pdf - -$(OUTPUT)/html/index.html: $(BOOK) $(OUTPUT)/html/css $(OUTPUT)/html/images $(XML) - xsltproc -o $(OUTPUT)/html/ --xinclude --stringparam chunk.section.depth 1 --stringparam section.autolabel 1 --stringparam callout.graphics 0 --stringparam callout.unicode 0 --stringparam section.label.includes.component.label 1 --stringparam use.id.as.filename 1 --stringparam html.stylesheet css/style.css --stringparam section.autolabel.max.depth 3 --stringparam toc.section.depth 2 --stringparam chunker.output.encoding UTF-8 --stringparam css.decoration 0 ../../xsl/html-custom.xsl $< - -%.fo: %.xml - xsltproc --xinclude --stringparam section.autolabel 1 --stringparam callout.graphics 0 --stringparam callout.unicode 0 --stringparam section.label.includes.component.label 1 http://docbook.sourceforge.net/release/xsl/current/fo/docbook.xsl $< > $@ - - -%.pdf: %.fo - fop $< $@ - -$(OUTPUT)/pdf/%.pdf: %.pdf - @mv $< $@ - -clean: - -rm -rf $(OUTPUT) *.fo - diff --git a/qpid/cpp/docs/book/src/common/css/style.css b/qpid/cpp/docs/book/src/common/css/style.css deleted file mode 100644 index c681596592..0000000000 --- a/qpid/cpp/docs/book/src/common/css/style.css +++ /dev/null @@ -1,279 +0,0 @@ -/* - * - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, - * software distributed under the License is distributed on an - * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - * KIND, either express or implied. See the License for the - * specific language governing permissions and limitations - * under the License. - * - */ -ul { - list-style-type:square; -} - -th { - font-weight: bold; -} - -.navfooter td { - font-size:10pt; -} - -.navheader td { - font-size:10pt; -} - -body { - margin:0; - background:#FFFFFF; - font-family:"Verdana", sans-serif; - font-size:10pt; -} - -.container { - width:950px; - margin:0 auto; -} - -body a { - color:#000000; -} - - -div.book { - margin-left:10pt; - margin-right:10pt; -} - -div.preface { - margin-left:10pt; - margin-right:10pt; -} - -div.chapter { - margin-left:10pt; - margin-right:10pt; -} - -div.section { - margin-left:10pt; - margin-right:10pt; -} - -div.titlepage { - margin-left:-10pt; - margin-right:-10pt; -} - -.calloutlist td { - font-size:10pt; -} - -.table-contents table { - border-spacing: 0px; -} - -.table-contents td { - font-size:10pt; - padding-left:6px; - padding-right:6px; -} - -div.breadcrumbs { - font-size:9pt; - margin-right:10pt; - padding-bottom:16px; -} - -.chapter h2.title { - font-size:20pt; - color:#0c3b82; -} - -.chapter .section h2.title { - font-size:18pt; - color:#0c3b82; -} - -.section h2.title { - font-size:16pt; - color:#0c3b82; -} - -.section h3.title { - font-size:14pt; - color:#0c3b82; -} - -.section h4.title { - font-size:12pt; - color:#0c3b82; -} - -.section h5.title { - font-size:12pt; - color:#0c3b82; -} - -.section h6.title { - font-size:12pt; - color:#0c3b82; -} - -.toc a { - font-size:9pt; -} - -.header { - height:100px; - width:950px; - background:url(http://qpid.apache.org/images/header.png) -} - -.logo { - text-align:center; - font-weight:600; - padding:0 0 0 0; - font-size:14px; - font-family:"Verdana", cursive; -} - -.logo a { - color:#000000; - text-decoration:none; -} - -.main_text_area { - margin-left:200px; -} - -.main_text_area_top { - height:14px; - font-size:1px; -} - -.main_text_area_bottom { - display:none; -/* height:14px; - margin-bottom:4px;*/ -} - -.main_text_area_body { - padding:5px 24px; -} - -.main_text_area_body p { - text-align:justify; -} - -.main_text_area br { - line-height:10px; -} - -.main_text_area h1 { - font-size:28px; - font-weight:600; - margin:0 0 24px 0; - color:#0c3b82; - font-family:"Verdana", Times, serif; -} - -.main_text_area h2 { - font-size:24px; - font-weight:600; - margin:24px 0 8px 0; - color:#0c3b82; - font-family:"Verdana",Times, serif; -} - -.main_text_area ol, .main_text_area ul { - padding:0; - margin:10px 0; - margin-left:20px; -} - -.main_text_area li { -/* margin-left:40px; */ -} - -.main_text_area, .menu_box { - font-size:13px; - line-height:17px; - color:#000000; -} - -.main_text_area { - font-size:14px; -} - -.main_text_area a { - color:#000000; -} - -.main_text_area a:hover { - color:#000000; -} - -.menu_box { - width:196px; - float:left; - margin-left:4px; -} - -.menu_box_top { - background:url(http://qpid.apache.org/images/menu_top.png) no-repeat; - height:14px; - font-size:1px; -} - -.menu_box_body { - background:url(http://qpid.apache.org/images/menu_body.png) repeat-y; - padding:5px 24px 5px 24px; -} - -.menu_box_bottom { - background:url(http://qpid.apache.org/images/menu_bottom.png) no-repeat; - height:14px; - font-size:1px; - margin-bottom:1px; -} - -.menu_box h3 { - font-size:20px; - font-weight:500; - margin:0 0 8px 0; - color:#0c3b82; - font-family:"Verdana",Times, serif; -} - -.menu_box ul { - margin:12px; - padding:0px; -} - -.menu_box li { - list-style:square; -} - -.menu_box a { - color:#000000; - text-decoration:none; -} - -.menu_box a:hover { - color:#000000; - text-decoration:underline; -} - - diff --git a/qpid/cpp/docs/book/src/cpp-broker/.gitignore b/qpid/cpp/docs/book/src/cpp-broker/.gitignore deleted file mode 100644 index 6d31bdba7f..0000000000 --- a/qpid/cpp/docs/book/src/cpp-broker/.gitignore +++ /dev/null @@ -1,20 +0,0 @@ -# -# Licensed to the Apache Software Foundation (ASF) under one -# or more contributor license agreements. See the NOTICE file -# distributed with this work for additional information -# regarding copyright ownership. The ASF licenses this file -# to you under the Apache License, Version 2.0 (the -# "License"); you may not use this file except in compliance -# with the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# - -/output diff --git a/qpid/cpp/docs/book/src/cpp-broker/AMQP-Compatibility.xml b/qpid/cpp/docs/book/src/cpp-broker/AMQP-Compatibility.xml deleted file mode 100644 index e5aa98cf96..0000000000 --- a/qpid/cpp/docs/book/src/cpp-broker/AMQP-Compatibility.xml +++ /dev/null @@ -1,713 +0,0 @@ - - - -
- - AMQP compatibility - - - Qpid provides the most complete and compatible implementation - of AMQP. And is the most aggressive in implementing the latest - version of the specification. - - - There are two brokers: - - - - C++ with support for AMQP 0-10 - Java with support for AMQP 0-8 and 0-9 (0-10 planned) - - - There are client libraries for C++, Java (JMS), .Net (written in - C#), python and ruby. - - - All clients support 0-10 and interoperate with the C++ - broker. - - - - The JMS client supports 0-8, 0-9 and 0-10 and interoperates - with both brokers. - - - - The python and ruby clients will also support all versions, - but the API is dynamically driven by the specification used and - so differs between versions. To work with the Java broker you - must use 0-8 or 0-9, to work with the C++ broker you must use - 0-10. - - - - There are two separate C# clients, one for 0-8 that - interoperates with the Java broker, one for 0-10 that - inteoperates with the C++ broker. - - - - QMF Management is supported in Ruby, Python, C++, and via QMan - for Java JMX & WS-DM. - -
- - AMQP - Compatibility of Qpid releases: - - - Qpid implements the AMQP Specification, and as the specification - has progressed Qpid is keeping up with the updates. This means - that different Qpid versions support different versions of AMQP. - Here is a simple guide on what use. - - - Here is a matrix that describes the different versions supported - by each release. The status symbols are interpreted as follows: - - - - - Y - supported - - - N - unsupported - - - IP - in progress - - - P - planned - - - - - AMQP Version Support by Qpid Release - - - - - Component - - - Spec - - -   - - -   - - -   - - -   - - - - -   - - -   - - - M2.1 - - - M3 - - - M4 - - - 0.5 - - - - - java client - - - 0-10 - - -   - - - Y - - - Y - - - Y - - - - -   - - - 0-9 - - - Y - - - Y - - - Y - - - Y - - - - -   - - - 0-8 - - - Y - - - Y - - - Y - - - Y - - - - - java broker - - - 0-10 - - -   - - -   - - -   - - - P - - - - -   - - - 0-9 - - - Y - - - Y - - - Y - - - Y - - - - -   - - - 0-8 - - - Y - - - Y - - - Y - - - Y - - - - - c++ client/broker - - - 0-10 - - -   - - - Y - - - Y - - - Y - - - - -   - - - 0-9 - - - Y - - -   - - -   - - -   - - - - - python client - - - 0-10 - - -   - - - Y - - - Y - - - Y - - - - -   - - - 0-9 - - - Y - - - Y - - - Y - - - Y - - - - -   - - - 0-8 - - - Y - - - Y - - - Y - - - Y - - - - - ruby client - - - 0-10 - - -   - - -   - - - Y - - - Y - - - - -   - - - 0-8 - - - Y - - - Y - - - Y - - - Y - - - - - C# client - - - 0-10 - - -   - - -   - - - Y - - - Y - - - - -   - - - 0-8 - - - Y - - - Y - - - Y - - - Y - - - - -
- -
- -
- - Interop - table by AMQP specification version - - - Above table represented in another format. - - - AMQP Version Support - alternate format - - - - -   - - - release - - - 0-8 - - - 0-9 - - - 0-10 - - - - - java client - - - M3 M4 0.5 - - - Y - - - Y - - - Y - - - - - java client - - - M2.1 - - - Y - - - Y - - - N - - - - - java broker - - - M3 M4 0.5 - - - Y - - - Y - - - N - - - - - java broker - - - trunk - - - Y - - - Y - - - P - - - - - java broker - - - M2.1 - - - Y - - - Y - - - N - - - - - c++ client/broker - - - M3 M4 0.5 - - - N - - - N - - - Y - - - - - c++ client/broker - - - M2.1 - - - N - - - Y - - - N - - - - - python client - - - M3 M4 0.5 - - - Y - - - Y - - - Y - - - - - python client - - - M2.1 - - - Y - - - Y - - - N - - - - - ruby client - - - M3 M4 0.5 - - - Y - - - Y - - - N - - - - - ruby client - - - trunk - - - Y - - - Y - - - P - - - - - C# client - - - M3 M4 0.5 - - - Y - - - N - - - N - - - - - C# client - - - trunk - - - Y - - - N - - - Y - - - - -
- -
- -
diff --git a/qpid/cpp/docs/book/src/cpp-broker/AMQP-Messaging-Broker-CPP-Book.xml b/qpid/cpp/docs/book/src/cpp-broker/AMQP-Messaging-Broker-CPP-Book.xml deleted file mode 100644 index 6122b12e18..0000000000 --- a/qpid/cpp/docs/book/src/cpp-broker/AMQP-Messaging-Broker-CPP-Book.xml +++ /dev/null @@ -1,74 +0,0 @@ - - - - - AMQP Messaging Broker (Implemented in C++) - - Introduction - - Qpid provides two AMQP messaging brokers: - - - Implemented in C++ - high performance, low latency, and RDMA support. - Implemented in Java - Fully JMS compliant, runs on any Java platform. - - - Both AMQP messaging brokers support clients in multiple - languages, as long as the messaging client and the messaging - broker use the same version of AMQP. See AMQP Compatibility to see - which messaging clients work with each broker. - - This manual contains information specific to the broker that is implemented in C++. - - - - - Running the AMQP Messaging Broker - - - - - - - - - - - - - - - - - - - - - Managing the AMQP Messaging Broker - - - - - - - diff --git a/qpid/cpp/docs/book/src/cpp-broker/Active-Passive-Cluster.xml b/qpid/cpp/docs/book/src/cpp-broker/Active-Passive-Cluster.xml deleted file mode 100644 index 461b75d320..0000000000 --- a/qpid/cpp/docs/book/src/cpp-broker/Active-Passive-Cluster.xml +++ /dev/null @@ -1,1229 +0,0 @@ - - - -
- Active-Passive Messaging Clusters - -
- Overview - - - The High Availability (HA) module provides - active-passive, hot-standby - messaging clusters to provide fault tolerant message delivery. - - - In an active-passive cluster only one broker, known as the - primary, is active and serving clients at a time. The other - brokers are standing by as backups. Changes on the primary - are replicated to all the backups so they are always up-to-date or "hot". Backup - brokers reject client connection attempts, to enforce the requirement that clients - only connect to the primary. - - - If the primary fails, one of the backups is promoted to take over as the new - primary. Clients fail-over to the new primary automatically. If there are multiple - backups, the other backups also fail-over to become backups of the new primary. - - - This approach relies on an external cluster resource manager - to detect failures, choose the new primary and handle network partitions. rgmanager is supported - initially, but others may be supported in the future. - -
- Avoiding message loss - - In order to avoid message loss, the primary broker delays - acknowledgement of messages received from clients until the - message has been replicated and acknowledged by all of the back-up - brokers, or has been consumed from the primary queue. - - - This ensures that all acknowledged messages are safe: they have either - been consumed or backed up to all backup brokers. Messages that are - consumed before they are replicated do not need to - be replicated. This reduces the work load when replicating a queue with - active consumers. - - - Clients keep unacknowledged messages in a buffer - - - You can control the maximum number of messages in the buffer by setting the - client's capacity. For details of how to set the capacity - in client code see "Using the Qpid Messaging API" in - Programming in Apache Qpid. - - - until they are acknowledged by the primary. If the primary fails, clients will - fail-over to the new primary and re-send all their - unacknowledged messages. - - - Clients must use "at-least-once" reliability to enable re-send of unacknowledged - messages. This is the default behaviour, no options need be set to enable it. For - details of client addressing options see "Using the Qpid Messaging API" - in Programming in Apache Qpid. - - - - - If the primary crashes, all the acknowledged - messages will be available on the backup that takes over as the new - primary. The unacknowledged messages will be - re-sent by the clients. Thus no messages are lost. - - - Note that this means it is possible for messages to be - duplicated. In the event of a failure it is possible for a - message to received by the backup that becomes the new primary - and re-sent by the client. The application must take steps - to identify and eliminate duplicates. - - - When a new primary is promoted after a fail-over it is initially in - "recovering" mode. In this mode, it delays acknowledgement of messages - on behalf of all the backups that were connected to the previous - primary. This protects those messages against a failure of the new - primary until the backups have a chance to connect and catch up. - - - Not all messages need to be replicated to the back-up brokers. If a - message is consumed and acknowledged by a regular client before it has - been replicated to a backup, then it doesn't need to be replicated. - - - HA Broker States - - Stand-alone - - - Broker is not part of a HA cluster. - - - - - Joining - - - Newly started broker, not yet connected to any existing primary. - - - - - Catch-up - - - A backup broker that is connected to the primary and downloading - existing state (queues, messages etc.) - - - - - Ready - - - A backup broker that is fully caught-up and ready to take over as - primary. - - - - - Recovering - - - Newly-promoted primary, waiting for backups to connect and catch up. - Clients can connect but they are stalled until the primary is active. - - - - - Active - - - The active primary broker with all backups connected and caught-up. - - - - -
-
- Limitations - - There are a some known limitations in the current implementation. These - will be fixed in future versions. - - - - - Transactional changes to queue state are not replicated atomically. If - the primary crashes during a transaction, it is possible that the - backup could contain only part of the changes introduced by a - transaction. - - - - - Configuration changes (creating or deleting queues, exchanges and - bindings) are replicated asynchronously. Management tools used to - make changes will consider the change complete when it is complete - on the primary, it may not yet be replicated to all the backups. - - - - - Federation links to the primary will fail over - correctly. Federated links from the primary - will be lost in fail over, they will not be re-connected to the new - primary. It is possible to work around this by replacing the - qpidd-primary start up script with a script that - re-creates federation links when the primary is promoted. - - - -
-
- -
- Virtual IP Addresses - - Some resource managers (including rgmanager) support - virtual IP addresses. A virtual IP address is an IP - address that can be relocated to any of the nodes in a cluster. The - resource manager associates this address with the primary node in the - cluster, and relocates it to the new primary when there is a failure. This - simplifies configuration as you can publish a single IP address rather - than a list. - - - A virtual IP address can be used by clients to connect to the primary. The - following sections will explain how to configure virtual IP addresses for - clients or brokers. - -
- -
- Configuring the Brokers - - The broker must load the ha module, it is loaded by - default. The following broker options are available for the HA module. - - - - Broker management is required for HA to operate, it is enabled by - default. The option mgmt-enable must not be set to - "no" - - - - - Incorrect security settings are a common cause of problems when - getting started, see . - - - - Broker Options for High Availability Messaging Cluster - - - - - - - Options for High Availability Messaging Cluster - - - - - - - ha-cluster yes|no - - - Set to "yes" to have the broker join a cluster. - - - - - ha-queue-replication yes|no - - - Enable replication of specific queues without joining a cluster, see . - - - - - ha-brokers-url URL - - - - The URL - - - The full format of the URL is given by this grammar: - -url = ["amqp:"][ user ["/" password] "@" ] addr ("," addr)* -addr = tcp_addr / rmda_addr / ssl_addr / ... -tcp_addr = ["tcp:"] host [":" port] -rdma_addr = "rdma:" host [":" port] -ssl_addr = "ssl:" host [":" port]' - - - - used by cluster brokers to connect to each other. The URL should - contain a comma separated list of the broker addresses, rather than a - virtual IP address. - - - - - ha-public-url URL - - - This option is only needed for backwards compatibility if you - have been using the amq.failover exchange. - This exchange is now obsolete, it is recommended to use a - virtual IP address instead. - - - If set, this URL is advertised by the - amq.failover exchange and overrides the - broker option known-hosts-url - - - - - ha-replicate VALUE - - - Specifies whether queues and exchanges are replicated by default. - VALUE is one of: none, - configuration, all. - For details see . - - - - - - ha-username USER - ha-password PASS - ha-mechanism MECHANISM - - - Authentication settings used by HA brokers to connect to each other, - see - - - - ha-backup-timeoutSECONDS - - - Values specified as SECONDS can be a - fraction of a second, e.g. "0.1" for a tenth of a second. - They can also have an explicit unit, - e.g. 10s (seconds), 10ms (milliseconds), 10us (microseconds), 10ns (nanoseconds) - - - - - - Maximum time that a recovering primary will wait for an expected - backup to connect and become ready. - - - - - - link-maintenance-interval SECONDS - - - - - HA uses federation links to connect from backup to primary. - Backup brokers check the link to the primary on this interval - and re-connect if need be. Default 2 seconds. Set lower for - faster failover, e.g. 0.1 seconds. Setting too low will result - in excessive link-checking on the backups. - - - - - - link-heartbeat-interval SECONDS - - - - - HA uses federation links to connect from backup to primary. - If no heart-beat is received for twice this interval the primary will consider that - backup dead (e.g. if backup is hung or partitioned.) - This interval is also used to time-out for broker status checks, - it may take up to this interval for rgmanager to detect a hung or partitioned broker. - Clients sending messages may be held up during this time. - Default 120 seconds: you will probably want to set this to a lower value e.g. 10. - If set too low rgmanager may consider a slow broker to have failed and kill it. - - - - - -
- - To configure a HA cluster you must set at least ha-cluster and - ha-brokers-url. - -
- -
- The Cluster Resource Manager - - Broker fail-over is managed by a cluster resource - manager. An integration with rgmanager is - provided, but it is possible to integrate with other resource managers. - - - The resource manager is responsible for starting the qpidd broker - on each node in the cluster. The resource manager then promotes - one of the brokers to be the primary. The other brokers connect to the primary as - backups, using the URL provided in the ha-brokers-url configuration - option. - - - Once connected, the backup brokers synchronize their state with the - primary. When a backup is synchronized, or "hot", it is ready to take - over if the primary fails. Backup brokers continually receive updates - from the primary in order to stay synchronized. - - - If the primary fails, backup brokers go into fail-over mode. The resource - manager must detect the failure and promote one of the backups to be the - new primary. The other backups connect to the new primary and synchronize - their state with it. - - - The resource manager is also responsible for protecting the cluster from - split-brain conditions resulting from a network partition. A - network partition divide a cluster into two sub-groups which cannot see each other. - Usually a quorum voting algorithm is used that disables nodes - in the inquorate sub-group. - -
- -
- Configuring with <command>rgmanager</command> as resource manager - - This section assumes that you are already familiar with setting up and configuring - clustered services using cman and - rgmanager. It will show you how to configure an active-passive, - hot-standby qpidd HA cluster with rgmanager. - - - - Once all components are installed it is important to take the following step: - -chkconfig rgmanager on -chkconfig cman on -chkconfig qpidd off - - - - The qpidd service must be off in - chkconfig because rgmanager will - start and stop qpidd. If the normal system init - process also attempts to start and stop qpidd it can cause rgmanager to - lose track of qpidd processes. The symptom when this happens is that - clustat shows a qpidd service to - be stopped when in fact there is a qpidd process - running. The qpidd log will show errors like this: - -critical Unexpected error: Daemon startup failed: Cannot lock /var/lib/qpidd/lock: Resource temporarily unavailable - - - - - You must provide a cluster.conf file to configure - cman and rgmanager. Here is - an example cluster.conf file for a cluster of 3 nodes named - node1, node2 and node3. We will go through the configuration step-by-step. - - - - - - - - - - - - - - - - status_poll_interval is the interval in seconds that the resource manager checks the status - of managed services. This affects how quickly the manager will detect failed services. - --> - - - - - - - - - - - - - - - - -