From 5bdeb55a0261e3324a6155e59843aadd55adea7c Mon Sep 17 00:00:00 2001
From: akr <akr@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>
Date: Sat, 21 Mar 2009 08:08:52 +0000
Subject: rdoc update.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@23030 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
---
 ext/openssl/ossl_ssl.c | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

(limited to 'ext')

diff --git a/ext/openssl/ossl_ssl.c b/ext/openssl/ossl_ssl.c
index 7575eca718..6a3e200ee7 100644
--- a/ext/openssl/ossl_ssl.c
+++ b/ext/openssl/ossl_ssl.c
@@ -1096,6 +1096,20 @@ ossl_ssl_connect(VALUE self)
 /*
  * call-seq:
  *    ssl.connect_nonblock => self
+ *
+ * initiate the TLS/SSL handshake as a client in non-blocking manner.
+ *
+ *   # emulates blocking connect
+ *   begin
+ *     ssl.connect_nonblock
+ *   rescue IO::WaitReadable
+ *     IO.select([s2])
+ *     retry
+ *   rescue IO::WaitWritable
+ *     IO.select(nil, [s2])
+ *     retry
+ *   end
+ *
  */
 static VALUE
 ossl_ssl_connect_nonblock(VALUE self)
@@ -1118,6 +1132,20 @@ ossl_ssl_accept(VALUE self)
 /*
  * call-seq:
  *    ssl.accept_nonblock => self
+ *
+ * initiate the TLS/SSL handshake as a server in non-blocking manner.
+ *
+ *   # emulates blocking accept
+ *   begin
+ *     ssl.accept_nonblock
+ *   rescue IO::WaitReadable
+ *     IO.select([s2])
+ *     retry
+ *   rescue IO::WaitWritable
+ *     IO.select(nil, [s2])
+ *     retry
+ *   end
+ *
  */
 static VALUE
 ossl_ssl_accept_nonblock(VALUE self)
-- 
cgit v1.2.3