diff options
Diffstat (limited to 'cpp/docs/api')
| -rw-r--r-- | cpp/docs/api/developer.doxygen.in | 2 | ||||
| -rw-r--r-- | cpp/docs/api/doxygen_mainpage.h | 41 | ||||
| -rw-r--r-- | cpp/docs/api/footer.html | 2 | ||||
| -rw-r--r-- | cpp/docs/api/user.doxygen.in | 2 |
4 files changed, 43 insertions, 4 deletions
diff --git a/cpp/docs/api/developer.doxygen.in b/cpp/docs/api/developer.doxygen.in index fd3a9ac621..1e1fddab80 100644 --- a/cpp/docs/api/developer.doxygen.in +++ b/cpp/docs/api/developer.doxygen.in @@ -1029,7 +1029,7 @@ INCLUDE_FILE_PATTERNS = # 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= +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. diff --git a/cpp/docs/api/doxygen_mainpage.h b/cpp/docs/api/doxygen_mainpage.h index cb36d7edb0..9acae52da4 100644 --- a/cpp/docs/api/doxygen_mainpage.h +++ b/cpp/docs/api/doxygen_mainpage.h @@ -266,7 +266,46 @@ * else * session.rollback(); * </pre> - * + * + * <h3>Exceptions</h3> + * + * 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. + * * <h3>Logging</h3> * * The Qpidd broker and C++ clients can both use environment variables to diff --git a/cpp/docs/api/footer.html b/cpp/docs/api/footer.html index 883410ce25..5a31e81821 100644 --- a/cpp/docs/api/footer.html +++ b/cpp/docs/api/footer.html @@ -25,7 +25,7 @@ Qpid C++ API Reference</small></address> <address style="text-align: right;"> <small> -Generated on $datetime for $projectname by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> $doxygenversion</small> +Generated on $date for $projectname by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> $doxygenversion</small> </address> </body> </html> diff --git a/cpp/docs/api/user.doxygen.in b/cpp/docs/api/user.doxygen.in index 2728df47e4..ec0fd1361c 100644 --- a/cpp/docs/api/user.doxygen.in +++ b/cpp/docs/api/user.doxygen.in @@ -1021,7 +1021,7 @@ INCLUDE_FILE_PATTERNS = # 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= +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. |