1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Document IO::Timeout

Browse Source
This commit is contained in:
zverok 2023-02-15 22:16:43 +02:00 committed by Victor Shepelev
parent e1b447a323
commit 4f049e915d
Notes: git 2023-02-19 20:33:14 +00:00 
Merged: https://github.com/ruby/ruby/pull/7316
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
io.c
View File

@ -852,9 +852,12 @@ rb_io_timeout(VALUE self)
* timeout = duration -> duration
* timeout = nil -> nil
*
* Set the internal timeout to the specified duration or nil. The timeout
* \Set the internal timeout to the specified duration or nil. The timeout
* applies to all blocking operations where possible.
*
* When the operation performs longer than the timeout set, IO::TimeoutError
* is raised.
*
* This affects the following methods (but is not limited to): #gets, #puts,
* #read, #write, #wait_readable and #wait_writable. This also affects
* blocking socket operations like Socket#accept and Socket#connect.
@ -15316,6 +15319,7 @@ Init_IO(void)
rb_cIO = rb_define_class("IO", rb_cObject);
rb_include_module(rb_cIO, rb_mEnumerable);
/* Can be raised by IO operations when IO#timeout= is set. */
rb_eIOTimeoutError = rb_define_class_under(rb_cIO, "TimeoutError", rb_eIOError);
rb_define_const(rb_cIO, "READABLE", INT2NUM(RUBY_IO_READABLE));