From 1d6b8ba524ed9adf5603f0a2bf3e01160f342ffa Mon Sep 17 00:00:00 2001 From: take_cheeze Date: Mon, 21 Apr 2014 22:13:39 +0900 Subject: Add document to Fiber#transfer . --- mrbgems/mruby-fiber/src/fiber.c | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/mrbgems/mruby-fiber/src/fiber.c b/mrbgems/mruby-fiber/src/fiber.c index cf0661fae..2ad74019f 100644 --- a/mrbgems/mruby-fiber/src/fiber.c +++ b/mrbgems/mruby-fiber/src/fiber.c @@ -234,6 +234,18 @@ fiber_eq(mrb_state *mrb, mrb_value self) return mrb_bool_value(fiber_ptr(self) == fiber_ptr(other)); } +/* + * call-seq: + * fiber.transfer(args, ...) -> obj + * + * Transfers control to reciever fiber of the method call. + * Unlike resume the reciever wouldn't be pushed to call + * stack of fibers. Instead it will switch to the call stack of + * transferring fiber. + * When resuming a fiber that was transferred to another fiber it would + * cause double resume error. Though when the fiber is re-transferred + * and Fiber.yield is called, the fiber would be resumable. + */ static mrb_value fiber_transfer(mrb_state *mrb, mrb_value self) { -- cgit v1.2.3