This is an automated email from the ASF dual-hosted git repository. jpeach pushed a commit to branch master in repository https://git-dual.apache.org/repos/asf/trafficserver.git
commit 46242f4a1b59f22c4ea41c9cec464b0b26d0a7f4 Author: James Peach <[email protected]> AuthorDate: Sun May 1 14:09:23 2016 -0700 Update TSSslContext API reference. Apply more consistent formatting and language. Move TSSslServerContextCreate and TSSslServerContextDestroy into the same page. --- .../api/functions/TSSslContextDestroy.en.rst | 34 ---------------------- .../api/functions/TSSslContextFindBy.en.rst | 34 ++++++++++------------ .../api/functions/TSSslServerContextCreate.en.rst | 22 ++++++++++++-- 3 files changed, 35 insertions(+), 55 deletions(-) diff --git a/doc/developer-guide/api/functions/TSSslContextDestroy.en.rst b/doc/developer-guide/api/functions/TSSslContextDestroy.en.rst deleted file mode 100644 index 9d367b5..0000000 --- a/doc/developer-guide/api/functions/TSSslContextDestroy.en.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed - with this work for additional information regarding copyright - ownership. The ASF licenses this file to you under the Apache - License, Version 2.0 (the "License"); you may not use this file - except in compliance with the License. You may obtain a copy of - the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied. See the License for the specific language governing - permissions and limitations under the License. - -.. include:: ../../../common.defs - -.. default-domain:: c - -TSSslContextDestroy -********************** - -Synopsis -======== - -`#include <ts/ts.h>` - -.. function:: void TSSslContextDestroy(TSSslContext ctx) - -Description -=========== - -Destroy a SSL context. diff --git a/doc/developer-guide/api/functions/TSSslContextFindBy.en.rst b/doc/developer-guide/api/functions/TSSslContextFindBy.en.rst index 720db43..ffc1d27 100644 --- a/doc/developer-guide/api/functions/TSSslContextFindBy.en.rst +++ b/doc/developer-guide/api/functions/TSSslContextFindBy.en.rst @@ -21,38 +21,36 @@ TSSslContextFindByName ********************** +Traffic Server TLS server context lookup. + Synopsis ======== `#include <ts/ts.h>` .. function:: TSSslContext TSSslContextFindByName(const char * name) +.. function:: TSSslContext TSSslContextFindByAddr(const struct sockaddr * address) Description =========== -Look for a SSL context created from :file:`ssl_multicert.config`. Use the -server :arg:`name` to search. - -TSSslContextFindByAddr -********************** - -Synopsis -======== - -`#include <ts/ts.h>` +:func:`TSSslContextFindByName` searches for a SSL server context +created from :file:`ssl_multicert.config`, matching against the +server :arg:`name`. -.. function:: TSSslContext TSSslContextFindByAddr(struct sockaddr const*) - -Description -=========== - -Look for a SSL context created from :file:`ssl_multicert.config`. Use the -server address to search. +:func:`TSSslContextFindByAddr` searches for a SSL server context +created from :file:`ssl_multicert.config` matchin against the server +:arg:`address`. Type ==== .. type:: TSSslContext -Corresponds to the SSL_CTX * value in openssl. +The SSL context object. This is an opaque type that can be cast to +the underlying SSL library type (SSL_CTX * for the OpenSSL library). + +See also +======== + +:manpage:`TSAPI(3ts)` diff --git a/doc/developer-guide/api/functions/TSSslServerContextCreate.en.rst b/doc/developer-guide/api/functions/TSSslServerContextCreate.en.rst index 6da64f8..3019d28 100644 --- a/doc/developer-guide/api/functions/TSSslServerContextCreate.en.rst +++ b/doc/developer-guide/api/functions/TSSslServerContextCreate.en.rst @@ -19,7 +19,9 @@ .. default-domain:: c TSSslServerContextCreate -********************** +************************ + +Traffic Server TLS server context creation. Synopsis ======== @@ -27,15 +29,29 @@ Synopsis `#include <ts/ts.h>` .. function:: TSSslContext TSSslServerContextCreate(void) +.. function:: void TSSslContextDestroy(TSSslContext ctx) Description =========== -Create a new server SSL context. It also populates cypher suite settings from records.config. +:func:`TSSslServerContextCreate` creates a new TLS server context. +The context is configured using the TLS settings specified in +:file:`records.config`. :func:`TSSslServerContextCreate` returns +``NULL`` on failure. + +:func:`TSSslServerContextDestroy` destroys a TLS context created +by :func:`TSSslServerContextCreate`. If :arg:`ctx` is ``NULL``, no +operation is performed. Type ==== .. type:: TSSslContext -Corresponds to the SSL_CTX * value in openssl. +The SSL context object. This is an opaque type that can be cast to +the underlying SSL library type (SSL_CTX * for the OpenSSL library). + +See also +======== + +:manpage:`TSAPI(3ts)` -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
