diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-02-15 20:49:28 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-02-15 20:49:28 -0800 |
| commit | a245b3add629d081015b0f7223e978f000949aa8 (patch) | |
| tree | b4fa22e07448049f1f2836ce61d30ade9d0f1c11 /docs/nng_tls_config_alloc.adoc | |
| parent | e7f2bd6e34fa2af9f55f200cda4bb6ceecb2ee89 (diff) | |
| download | nng-a245b3add629d081015b0f7223e978f000949aa8.tar.gz nng-a245b3add629d081015b0f7223e978f000949aa8.tar.bz2 nng-a245b3add629d081015b0f7223e978f000949aa8.zip | |
Minor markup fixes for TLS pages.
Diffstat (limited to 'docs/nng_tls_config_alloc.adoc')
| -rw-r--r-- | docs/nng_tls_config_alloc.adoc | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/nng_tls_config_alloc.adoc b/docs/nng_tls_config_alloc.adoc index 98884f70..8e414fcc 100644 --- a/docs/nng_tls_config_alloc.adoc +++ b/docs/nng_tls_config_alloc.adoc @@ -32,11 +32,11 @@ int nng_tls_config_alloc(nni_tls_config **cfgp, nng_tls_mode mode); The `nng_tls_config_alloc()` function creates a newly initialized https://tools.ietf.org/html/rfc5246[Transport Layer Security]) configuration object, and stores a pointer to it in the value pointed -to by 'cfgp'. +to by _cfgp_. This object is initialized for use when acting as either a client (`NNG_TLS_MODE_CLIENT`) or as a server (`NNG_TLS_MODE_SERVER`), -depending on the value of 'mode'. +depending on the value of _mode_. A TLS object can be further modified by functions that set the security keys used, peeer certificates, protocol policies, and so forth. @@ -56,8 +56,8 @@ This function returns 0 on success, and non-zero otherwise. == ERRORS -`NNG_ENOMEM`:: Insufficient memory is available to allocate the object. -`NNG_EINVAL`:: An invalid 'mode' was specified. +`NNG_ENOMEM`:: Insufficient memory is available. +`NNG_EINVAL`:: An invalid _mode_ was specified. == SEE ALSO |