diff --git a/doc/site/modules/core/fiber.markdown b/doc/site/modules/core/fiber.markdown index 904c9a6b..0a815deb 100644 --- a/doc/site/modules/core/fiber.markdown +++ b/doc/site/modules/core/fiber.markdown @@ -194,12 +194,71 @@ If the called fiber raises an error, it can no longer be used. ### **transfer**() -**TODO** +Pauses execution of the current running fiber, and transfers control to this fiber. + +[Read more][../../concurrency.html#transferring-control] about the difference +between `call` and `transfer`. Unlike `call`, `transfer` doesn't track the origin of the transfer. + +
+// keep hold of the fiber we start in
+var main = Fiber.current
+
+// create a new fiber, note it doesn't execute yet!
+var fiber = Fiber.new {
+ System.print("inside 'fiber'") //> #2: from #1
+ main.transfer() //> #3: go back to 'main'
+}
+
+fiber.transfer() //> #1: print "inside 'fiber'" via #2
+ //> this fiber is now paused by #1
+
+System.print("main") //> #4: prints "main", unpaused by #3
+
### **transfer**(value)
-**TODO**
+Pauses execution of the current running fiber, and transfers control to this fiber.
+
+Similar to `transfer`, but a value can be passed between the fibers.
+
+
+// keep hold of the fiber we start in
+var main = Fiber.current
+
+// create a new fiber, note it doesn't execute yet
+// also note that we're accepting a 'value' parameter
+var fiber = Fiber.new {|value|
+ System.print("in 'fiber' = %(value)") //> #2: in 'fiber' = 5
+ var result = main.transfer("hello?") //> #3: send to 'message'
+ System.print("end 'fiber' = %(result)") //> #6: end 'fiber' = 32
+}
+
+var message = fiber.transfer(5) //> #1: send to 'value'
+System.print("... %(message)") //> #4: ... hello?
+fiber.transfer(32) //> #5: send to 'result'
+
### **transferError**(error)
-**TODO**
+Transfer to this fiber, but set this fiber into an error state.
+The `fiber.error` value will be populated with the value in `error`.
+
+
+var A = Fiber.new {
+ System.print("transferred to A") //> #4
+ B.transferError("error!") //> #5
+}
+
+var B = Fiber.new {
+ System.print("started B") //> #2
+ A.transfer() //> #3
+ System.print("should not get here")
+}
+
+B.try() //> #1
+System.print(B.error) //> #6: prints "error!" from #5
+
+// B fiber can no longer be used
+
+B.call() //> #7: Cannot call an aborted fiber.
+
\ No newline at end of file