AuroraMiddleware/asio
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix errors in SSL documentation.

Browse Source
This commit is contained in:
Christopher Kohlhoff 2011-03-22 00:24:59 +11:00
parent 0681386ee1
commit 2092949062
3 changed files with 30 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
asio/src/doc/overview/ssl.qbk
View File

@ -16,8 +16,8 @@ context object. This object is used to set SSL options such as verification
mode, certificate files, and so on. As an illustration, client-side
initialisation may look something like:
ssl::context ctx(my_io_service, ssl::context::sslv23);
ctx.set_verify_mode(ssl::context::verify_peer);
ssl::context ctx(ssl::context::sslv23);
ctx.set_verify_mode(ssl::verify_peer);
ctx.load_verify_file("ca.pem");
To use SSL with a TCP socket, one may write:
@ -53,13 +53,9 @@ asio.reference.async_read_until async_read_until()] free functions.
[heading See Also]
[link asio.reference.ssl__basic_context ssl::basic_context],
[link asio.reference.ssl__context ssl::context],
[link asio.reference.ssl__context_base ssl::context_base],
[link asio.reference.ssl__context_service ssl::context_service],
[link asio.reference.ssl__rfc2818_verification ssl::rfc2818_verification],
[link asio.reference.ssl__stream ssl::stream],
[link asio.reference.ssl__stream_base ssl::stream_base],
[link asio.reference.ssl__stream_service ssl::stream_service],
[link asio.examples.ssl SSL example].
[heading Notes]
@ -67,7 +63,7 @@ asio.reference.async_read_until async_read_until()] free functions.
[@http://www.openssl.org OpenSSL] is required to make use of Asio's SSL
support. When an application needs to use OpenSSL functionality that is not
wrapped by Asio, the underlying OpenSSL types may be obtained by calling [link
asio.reference.ssl__basic_context.impl `ssl::context::impl()`] or [link
asio.reference.ssl__stream.impl `ssl::stream::impl()`].
asio.reference.ssl__context.native_handle `ssl::context::native_handle()`] or
[link asio.reference.ssl__stream.native_handle `ssl::stream::native_handle()`].
[endsect]

20
asio/src/doc/reference.qbk
View File

@ -82117,13 +82117,13 @@ Set the callback used to verify peer certificates.
template<
typename ``[link asio.reference.VerifyCallback VerifyCallback]``>
typename VerifyCallback>
void ``[link asio.reference.ssl__context.set_verify_callback.overload1 set_verify_callback]``(
VerifyCallback callback);
`` [''''&raquo;''' [link asio.reference.ssl__context.set_verify_callback.overload1 more...]]``
template<
typename ``[link asio.reference.VerifyCallback VerifyCallback]``>
typename VerifyCallback>
asio::error_code ``[link asio.reference.ssl__context.set_verify_callback.overload2 set_verify_callback]``(
VerifyCallback callback,
asio::error_code & ec);
@ -82137,7 +82137,7 @@ Set the callback used to verify peer certificates.
template<
typename ``[link asio.reference.VerifyCallback VerifyCallback]``>
typename VerifyCallback>
void set_verify_callback(
VerifyCallback callback);
@ -82190,7 +82190,7 @@ Set the callback used to verify peer certificates.
template<
typename ``[link asio.reference.VerifyCallback VerifyCallback]``>
typename VerifyCallback>
asio::error_code set_verify_callback(
VerifyCallback callback,
asio::error_code & ec);
@ -83255,7 +83255,7 @@ Verifies a certificate against a hostname according to the rules described in RF
[[Name][Description]]
[
[[link asio.reference.ssl__rfc2818_verification.operator() [*operator()]]]
[[link asio.reference.ssl__rfc2818_verification.operator_lp__rp_ [*operator()]]]
[Perform certificate verification. ]
]
@ -83305,7 +83305,7 @@ The following example shows how to synchronously open a secure connection to a g
[*Convenience header: ][^asio/ssl.hpp]
[section:operator() ssl::rfc2818_verification::operator()]
[section:operator_lp__rp_ ssl::rfc2818_verification::operator()]
[indexterm2 operator()..ssl::rfc2818_verification]
Perform certificate verification.
@ -84236,13 +84236,13 @@ Set the callback used to verify peer certificates.
template<
typename ``[link asio.reference.VerifyCallback VerifyCallback]``>
typename VerifyCallback>
void ``[link asio.reference.ssl__stream.set_verify_callback.overload1 set_verify_callback]``(
VerifyCallback callback);
`` [''''&raquo;''' [link asio.reference.ssl__stream.set_verify_callback.overload1 more...]]``
template<
typename ``[link asio.reference.VerifyCallback VerifyCallback]``>
typename VerifyCallback>
asio::error_code ``[link asio.reference.ssl__stream.set_verify_callback.overload2 set_verify_callback]``(
VerifyCallback callback,
asio::error_code & ec);
@ -84256,7 +84256,7 @@ Set the callback used to verify peer certificates.
template<
typename ``[link asio.reference.VerifyCallback VerifyCallback]``>
typename VerifyCallback>
void set_verify_callback(
VerifyCallback callback);
@ -84309,7 +84309,7 @@ Set the callback used to verify peer certificates.
template<
typename ``[link asio.reference.VerifyCallback VerifyCallback]``>
typename VerifyCallback>
asio::error_code set_verify_callback(
VerifyCallback callback,
asio::error_code & ec);

15
asio/src/doc/reference.xsl
View File

@ -251,6 +251,18 @@
select="concat(substring-before($name, ']'), '_rb_', substring-after($name, ']'))"/>
</xsl:call-template>
</xsl:when>
<xsl:when test="contains($name, '(')">
<xsl:call-template name="make-id">
<xsl:with-param name="name"
select="concat(substring-before($name, '('), '_lp_', substring-after($name, '('))"/>
</xsl:call-template>
</xsl:when>
<xsl:when test="contains($name, ')')">
<xsl:call-template name="make-id">
<xsl:with-param name="name"
select="concat(substring-before($name, ')'), '_rp_', substring-after($name, ')'))"/>
</xsl:call-template>
</xsl:when>
<xsl:when test="contains($name, '+')">
<xsl:call-template name="make-id">
<xsl:with-param name="name"
@ -1394,6 +1406,9 @@
<xsl:when test="declname = 'Traits'">
<xsl:value-of select="declname"/>
</xsl:when>
<xsl:when test="declname = 'VerifyCallback'">
<xsl:value-of select="declname"/>
</xsl:when>
<xsl:when test="count(declname) = 0">
</xsl:when>
<xsl:otherwise>