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

Clarify rb_io_maybe_wait behaviour. (#9527)

Browse Source
This commit is contained in:
Samuel Williams 2024-10-04 18:40:38 +13:00 committed by GitHub
parent 939ec9f080
commit 96d69d2df2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
Notes: git 2024-10-04 05:40:56 +00:00 
Merged-By: ioquatix <samuel@codeotaku.com>
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
include/ruby/io.h
View File

@ -964,6 +964,9 @@ VALUE rb_io_wait(VALUE io, VALUE events, VALUE timeout);
* }
* ```
*
* On timeout, ::RUBY_Qfalse is returned. Unless you are specifically handling
* the timeouts, you should typically raise ::rb_eIOTimeoutError in this case.
*
* @param[in] error System errno.
* @param[in] io An IO object to wait.
* @param[in] events An integer set of interests.
@ -974,10 +977,6 @@ VALUE rb_io_wait(VALUE io, VALUE events, VALUE timeout);
* @retval RUBY_Qfalse Operation timed out.
* @retval Otherwise Actual events reached.
*
* @internal
*
* This function to return ::RUBY_Qfalse on timeout could be unintended. It
* seems timeout feature has some rough edge.
*/
VALUE rb_io_maybe_wait(int error, VALUE io, VALUE events, VALUE timeout);