Zen

Source string Source string

79/10000 · 79
English Actions
created fiber object
rtype
userdata
**Example:**
The script below shows how to create a fiber using ``fiber.create``:
-- app.lua --
fiber = require('fiber')

function greet(name)
print('Hello, '..name)
end

greet_fiber = fiber.create(greet, 'John')
print('Fiber already started')
The following output should be displayed after :ref:`running <app_server-launching_app_binary>` ``app.lua``:
$ tarantool app.lua
Hello, John
Fiber already started
Create a fiber but do not start it. The created fiber starts after the fiber creator (that is, the job that is calling ``fiber.new()``) yields. The initial fiber state is ``ready``.
Note that :ref:`fiber.status() <fiber-status>` returns the ``suspended`` state for ``ready`` fibers because the ``ready`` state is not observable using the ``fiber`` module API.
You can join fibers created using ``fiber.new`` by calling the :ref:`fiber_object:join() <fiber_object-join>` function and get the result returned by the fiber's function. To join the fiber, you need to make it joinable using :ref:`fiber_object:set_joinable() <fiber_object-set_joinable>`.
The script below shows how to create a fiber using ``fiber.new``:
-- app.lua --
fiber = require('fiber')

function greet(name)
print('Hello, '..name)
end

greet_fiber = fiber.new(greet, 'John')
print('Fiber not started yet')
$ tarantool app.lua
Fiber not started yet
Hello, John
fiber object for the currently scheduled fiber.
tarantool> fiber.self()
---
- status: running
name: interactive
id: 101
...
numeric identifier of the fiber.
fiber object for the specified fiber.
tarantool> fiber.find(101)
---
- status: running
name: interactive
id: 101
...
Yield control to the scheduler and sleep for the specified number of seconds. Only the current fiber can be made to sleep.
number of seconds to sleep.
Exception
see the :ref:`Example of yield failure <fiber-fail>`.
The ``increment`` function below contains an infinite loop that adds 1 to the ``counter`` global variable. Then, the current fiber goes to sleep for ``period`` seconds. ``sleep`` causes an implicit :ref:`fiber.yield() <fiber-yield>`.
-- app.lua --
fiber = require('fiber')

counter = 0
function increment(period)
while true do
counter = counter + 1
fiber.sleep(period)
end
end

increment_fiber = fiber.create(increment, 2)
require('console').start()
After running the script above, print the information about the fiber: a fiber ID, its status, and the counter value.
tarantool> print('ID: ' .. increment_fiber:id() .. '\nStatus: ' .. increment_fiber:status() .. '\nCounter: ' .. counter)
ID: 104
Status: suspended
Counter: 8
---
...
Then, cancel the fiber and print the information about the fiber one more time. This time the fiber status is ``dead``.
tarantool> increment_fiber:cancel()
---
...

tarantool> print('ID: ' .. increment_fiber:id() .. '\nStatus: ' .. increment_fiber:status() .. '\nCounter: ' .. counter)
ID: 104
Status: dead
Counter: 12
---
...
Yield control to the scheduler. Equivalent to :ref:`fiber.sleep(0) <fiber-sleep>`.
In the example below, two fibers are associated with the same function. Each fiber yields control after printing a greeting.

Loading…

User avatar None

New source string

testing_project / Documentation: reference/reference_lua/fiber — English

tarantool> fiber.self()
---
- status: running
name: interactive
id: 101
...
a year ago
Browse all string changes

Things to check

Ellipsis

The string uses three dots (...) instead of an ellipsis character (…)

Reset

Glossary

English English
No related strings found in the glossary.

String information

Flags
read-only
String age
a year ago
Last updated
a year ago
Source string age
a year ago
Translation file
string 161