Skip to content

Commit 6339db4

Browse files
committed
Document syswrite_nonblock opts and symbol return value
1 parent 2ccdfc6 commit 6339db4

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

ext/openssl/ossl_ssl.c

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2196,9 +2196,12 @@ ossl_ssl_write(VALUE self, VALUE str)
21962196
/*
21972197
* call-seq:
21982198
* ssl.syswrite_nonblock(string) => Integer
2199+
* ssl.syswrite_nonblock(string, opts) => Integer
21992200
*
22002201
* Writes _string_ to the SSL connection in a non-blocking manner. Raises an
2201-
* SSLError if writing would block.
2202+
* SSLError if writing would block. If "exception: false" is passed, this
2203+
* method returns a symbol of :wait_readable or :wait_writable, rather than
2204+
* raising an exception.
22022205
*/
22032206
static VALUE
22042207
ossl_ssl_write_nonblock(int argc, VALUE *argv, VALUE self)

0 commit comments

Comments
 (0)