diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-11-05 17:21:34 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-11-05 18:09:35 -0800 |
| commit | 3cc0bb37e3543052f336abe1d3349ff095f72ae2 (patch) | |
| tree | 048163a5c66029c4837be4ac93a56f0790df8dc4 /docs/man/nng_http_server_get_tls.3http.adoc | |
| parent | 77984b14a65c0a7387c97f3d36f947dd17358744 (diff) | |
| download | nng-3cc0bb37e3543052f336abe1d3349ff095f72ae2.tar.gz nng-3cc0bb37e3543052f336abe1d3349ff095f72ae2.tar.bz2 nng-3cc0bb37e3543052f336abe1d3349ff095f72ae2.zip | |
fixes #456 TLS configuration object hold
fixes #776 Configuration of mbedTLS should warn about license
Diffstat (limited to 'docs/man/nng_http_server_get_tls.3http.adoc')
| -rw-r--r-- | docs/man/nng_http_server_get_tls.3http.adoc | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/docs/man/nng_http_server_get_tls.3http.adoc b/docs/man/nng_http_server_get_tls.3http.adoc index ec3953e8..e252f46c 100644 --- a/docs/man/nng_http_server_get_tls.3http.adoc +++ b/docs/man/nng_http_server_get_tls.3http.adoc @@ -28,8 +28,12 @@ int nng_http_server_get_tls(nng_http_server *s, nng_tls_config **cfgp); The `nng_http_server_get_tls()` obtains the TLS configuration of server _s_ and saves a pointer to it in the address referenced by _cfgp_. -The configuration will be `NULL` if the HTTP server instance is not enabled -to use HTTPS. +The object will be returned with an extra hold (see +`<<nng_tls_config_hold.3tls#,nng_tls_config_hold()>>`) +placed on it on behalf of the caller. +The caller should free this hold by calling +`<<nng_tls_config_free.3tls#,nng_tls_config_free()>>` with it is done +with the TLS configuration. == RETURN VALUES @@ -38,6 +42,7 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS [horizontal] +`NNG_EINVAL`:: TLS not configured on server. `NNG_ENOMEM`:: Insufficient free memory exists. `NNG_ENOTSUP`:: Either HTTP or TLS not supported. @@ -48,5 +53,7 @@ This function returns 0 on success, and non-zero otherwise. <<nng_http_server_set_tls.3http#,nng_http_server_set_tls(3http)>>, <<nng_http_server_start.3http#,nng_http_server_start(3http)>>, <<nng_tls_config_alloc.3tls#,nng_tls_config_alloc(3tls)>>, +<<nng_tls_config_free.3tls#,nng_tls_config_free(3tls)>>, +<<nng_tls_config_hold.3tls#,nng_tls_config_hold(3tls)>>, <<nng_strerror.3#,nng_strerror(3)>>, <<nng.7#,nng(7)>> |
