diff options
| author | Alan Antonuk <alan.antonuk@gmail.com> | 2016-08-20 10:32:22 -0700 |
|---|---|---|
| committer | Alan Antonuk <alan.antonuk@gmail.com> | 2016-08-20 10:41:42 -0700 |
| commit | 5560f30b771d85bac9f753eb12074c40c6de1e97 (patch) | |
| tree | b97f3294810a04feef04d7db31b4d4db8edb1e2f | |
| parent | 5dfe5d2f2680a4639090a9c239a2b0018d90c789 (diff) | |
| download | rabbitmq-c-sasl-docs.tar.gz | |
Docs: add AMQP_SASL_METHOD_EXTERNAL documentation.sasl-docs
Add docs to amqp_login* functions on how to correctly use
AMQP_SASL_METHOD_EXTERNAL to authenticate to the broker.
Fixes #349
| -rw-r--r-- | librabbitmq/amqp.h | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/librabbitmq/amqp.h b/librabbitmq/amqp.h index b4c7f9d..d58f9b4 100644 --- a/librabbitmq/amqp.h +++ b/librabbitmq/amqp.h @@ -1764,10 +1764,14 @@ AMQP_CALL amqp_get_rpc_reply(amqp_connection_state_t state); * v0.4.0 they are only serviced during amqp_basic_publish() and * amqp_simple_wait_frame()/amqp_simple_wait_frame_noblock() * \param [in] sasl_method the SASL method to authenticate with the broker. - * followed by the authentication information. - * For AMQP_SASL_METHOD_PLAIN, the AMQP_SASL_METHOD_PLAIN - * should be followed by two arguments in this order: - * const char* username, and const char* password. + * followed by the authentication information. The following SASL + * methods are implemented: + * - AMQP_SASL_METHOD_PLAIN, the AMQP_SASL_METHOD_PLAIN argument + * should be followed by two arguments in this order: + * const char* username, and const char* password. + * - AMQP_SASL_METHOD_EXTERNAL, the AMQP_SASL_METHOD_EXTERNAL + * argument should be followed one argument: + * const char* identity. * \return amqp_rpc_reply_t indicating success or failure. * - r.reply_type == AMQP_RESPONSE_NORMAL. Login completed successfully * - r.reply_type == AMQP_RESPONSE_LIBRARY_EXCEPTION. In most cases errors @@ -1824,10 +1828,14 @@ AMQP_CALL amqp_login(amqp_connection_state_t state, char const *vhost, * and amqp_simple_wait_frame()/amqp_simple_wait_frame_noblock() * \param [in] properties a table of properties to send the broker. * \param [in] sasl_method the SASL method to authenticate with the broker - * followed by the authentication information. - * For AMQP_SASL_METHOD_PLAN, the AMQP_SASL_METHOD_PLAIN parameter - * should be followed by two arguments in this order: - * const char* username, and const char* password. + * followed by the authentication information. The following SASL + * methods are implemented: + * - AMQP_SASL_METHOD_PLAIN, the AMQP_SASL_METHOD_PLAIN argument + * should be followed by two arguments in this order: + * const char* username, and const char* password. + * - AMQP_SASL_METHOD_EXTERNAL, the AMQP_SASL_METHOD_EXTERNAL + * argument should be followed one argument: + * const char* identity. * \return amqp_rpc_reply_t indicating success or failure. * - r.reply_type == AMQP_RESPONSE_NORMAL. Login completed successfully * - r.reply_type == AMQP_RESPONSE_LIBRARY_EXCEPTION. In most cases errors |