Skip to content

Bump fiber scheduler version and add missing documentation. #13424

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ioquatix merged 1 commit into from
May 23, 2025
Merged

Bump fiber scheduler version and add missing documentation. #13424

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion include/ruby/fiber/scheduler.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@

RBIMPL_SYMBOL_EXPORT_BEGIN()

#define RUBY_FIBER_SCHEDULER_VERSION 2
// Version 3: Adds support for `fiber_interrupt`.
#define RUBY_FIBER_SCHEDULER_VERSION 3

struct timeval;

Expand Down Expand Up @@ -418,12 +419,21 @@ VALUE rb_fiber_scheduler_blocking_operation_wait(VALUE scheduler, void* (*functi
*
* This hook may be invoked by a different thread.
*
* @param[in] scheduler Target scheduler.
* @param[in] fiber The fiber to interrupt.
* @param[in] exception The exception to raise in the fiber.
* @return What `scheduler.fiber_interrupt` returns.
*/
VALUE rb_fiber_scheduler_fiber_interrupt(VALUE scheduler, VALUE fiber, VALUE exception);

/**
* Create and schedule a non-blocking fiber.
*
* @param[in] scheduler Target scheduler.
* @param[in] argc Number of arguments in argv.
* @param[in] argv Array of arguments to pass to the fiber.
* @param[in] kw_splat Whether to expand last argument as keywords.
* @return The created and scheduled fiber.
*/
VALUE rb_fiber_scheduler_fiber(VALUE scheduler, int argc, VALUE *argv, int kw_splat);

Expand Down