aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ssl/doc
diff options
context:
space:
mode:
authorIngela Anderton Andin <[email protected]>2010-04-09 14:23:23 +0000
committerErlang/OTP <[email protected]>2010-04-09 14:23:23 +0000
commit0e40e0e7599cf4da9e473604415600da8f2746d4 (patch)
treee9e85956efde7623d6a82089f1f32ae2a4ab5a31 /lib/ssl/doc
parentcca3b3445bbaa8de42d228b64fc8f6a899fb4dfe (diff)
downloadotp-0e40e0e7599cf4da9e473604415600da8f2746d4.tar.gz
otp-0e40e0e7599cf4da9e473604415600da8f2746d4.tar.bz2
otp-0e40e0e7599cf4da9e473604415600da8f2746d4.zip
Fix renegotiate doc
Diffstat (limited to 'lib/ssl/doc')
-rw-r--r--lib/ssl/doc/src/new_ssl.xml7
1 files changed, 5 insertions, 2 deletions
diff --git a/lib/ssl/doc/src/new_ssl.xml b/lib/ssl/doc/src/new_ssl.xml
index a83c2d1383..08868a1b3c 100644
--- a/lib/ssl/doc/src/new_ssl.xml
+++ b/lib/ssl/doc/src/new_ssl.xml
@@ -495,12 +495,15 @@ end
</func>
<func>
- <name>renegotiate(Socket) -> ok</name>
+ <name>renegotiate(Socket) -> ok | {error, Reason}</name>
<fsummary> Initiates a new handshake.</fsummary>
<type>
<v>Socket = sslsocket()</v>
</type>
- <desc><p>Initiates a new handshake.</p>
+ <desc><p>Initiates a new handshake. A notable return value is
+ <c>{error, renegotiation_rejected}</c> indicating that the peer
+ refused to go through with the renegotiation but the connection
+ is still active using the previously negotiated session.</p>
</desc>
</func>