diff options
| author | Michael Steinert <mike.steinert@gmail.com> | 2012-12-07 10:01:29 -0700 |
|---|---|---|
| committer | Alan Antonuk <alan.antonuk@gmail.com> | 2013-04-17 09:56:29 -0700 |
| commit | c8b8b11696cd35aee5f05764403c8f8d094dfb03 (patch) | |
| tree | 474bca8775c2a1f1e19ed78d0894a003c074781b /librabbitmq/amqp_ssl_socket.h | |
| parent | 1f3b13b6de00852fe2010864b000e59d5b62f07f (diff) | |
| download | rabbitmq-c-github-ask-c8b8b11696cd35aee5f05764403c8f8d094dfb03.tar.gz | |
Complete public socket API documentation
Signed-off-by: Michael Steinert <mike.steinert@gmail.com>
Diffstat (limited to 'librabbitmq/amqp_ssl_socket.h')
| -rw-r--r-- | librabbitmq/amqp_ssl_socket.h | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/librabbitmq/amqp_ssl_socket.h b/librabbitmq/amqp_ssl_socket.h index 706d537..693ea96 100644 --- a/librabbitmq/amqp_ssl_socket.h +++ b/librabbitmq/amqp_ssl_socket.h @@ -21,8 +21,7 @@ */ /** - * \file - * Open an SSL/TLS connection + * An SSL socket connection. */ #ifndef AMQP_SSL_H @@ -35,6 +34,8 @@ AMQP_BEGIN_DECLS /** * Create a new SSL/TLS socket object. * + * Call amqp_socket_close() to release socket resources. + * * \return A new socket object or NULL if an error occurred. */ AMQP_PUBLIC_FUNCTION @@ -94,7 +95,8 @@ amqp_ssl_socket_set_key_buffer(amqp_socket_t *self, * Enable or disable peer verification. * * If peer verification is enabled then the common name in the server - * certificate must match the server name. + * certificate must match the server name. Peer verification is disabled by + * default. * * \param [in,out] self An SSL/TLS socket object. * \param [in] verify Enable or disable peer verification. |