aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssl/doc/src/ssl.xml
diff options
context:
space:
mode:
authorIngela Anderton Andin <[email protected]>2013-02-14 10:33:44 +0100
committerIngela Anderton Andin <[email protected]>2013-02-14 10:33:44 +0100
commit37213d9ca054bb9ab3389de959cda58abedf9b06 (patch)
tree027d7629669719cee9deb01eb0f258f298fc2ffe /lib/ssl/doc/src/ssl.xml
parentbbcf34d621d613046ea99eb5fafc01196c88e47f (diff)
parent56354fdbf817291bed0c18373c5ad8dfb639b7e6 (diff)
downloadotp-37213d9ca054bb9ab3389de959cda58abedf9b06.tar.gz
otp-37213d9ca054bb9ab3389de959cda58abedf9b06.tar.bz2
otp-37213d9ca054bb9ab3389de959cda58abedf9b06.zip
Merge branch 'ia/ssl/transport-cb-and-inet/OTP-10847'
* ia/ssl/transport-cb-and-inet/OTP-10847: ssl: Generalize cb_info option
Diffstat (limited to 'lib/ssl/doc/src/ssl.xml')
-rw-r--r--lib/ssl/doc/src/ssl.xml13
1 files changed, 8 insertions, 5 deletions
diff --git a/lib/ssl/doc/src/ssl.xml b/lib/ssl/doc/src/ssl.xml
index e45a4c774f..ab468c8d6b 100644
--- a/lib/ssl/doc/src/ssl.xml
+++ b/lib/ssl/doc/src/ssl.xml
@@ -4,7 +4,7 @@
<erlref>
<header>
<copyright>
- <year>1999</year><year>2012</year>
+ <year>1999</year><year>2013</year>
<holder>Ericsson AB. All Rights Reserved.</holder>
</copyright>
<legalnotice>
@@ -84,10 +84,13 @@
{client_preferred_next_protocols, binary(), client | server, list(binary())}
</c></p>
- <p><c>transportoption() = {CallbackModule, DataTag, ClosedTag}
- - defaults to {gen_tcp, tcp, tcp_closed}. Ssl may be
- run over any reliable transport protocol that has
- an equivalent API to gen_tcp's.</c></p>
+ <p><c>transportoption() = {cb_info, {CallbackModule::atom(), DataTag::atom(), ClosedTag::atom(), ErrTag:atom()}}
+ - defaults to {gen_tcp, tcp, tcp_closed, tcp_error}. Can be used to customize
+ the transport layer. The callback module must implement a reliable transport
+ protocol and behave as gen_tcp and in addition have functions corresponding to
+ inet:setopts/2, inet:getopts/2, inet:peername/1, inet:sockname/1 and inet:port/1.
+ The callback gen_tcp is treated specially and will call inet directly.
+ </c></p>
<p><c>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; CallbackModule =
atom()</c>