Struct tarantool_module::fiber::Fiber

pub struct Fiber<'a, T: 'a> { /* fields omitted */ }

Contains information about fiber

Implementations

impl<'a, T> Fiber<'a, T>

pub fn new<F>(name: &str, callback: &mut F) -> Self where
    F: FnMut(Box<T>) -> i32, 

Create a new fiber.

Takes a fiber from fiber cache, if it's not empty. Can fail only if there is not enough memory for the fiber structure or fiber stack.

The created fiber automatically returns itself to the fiber cache when its main function completes.

• name - string with fiber name
• callback - function for run inside fiber

See also: start

pub fn new_with_attr<F>(
    name: &str,
    fiber_attr: &FiberAttr,
    callback: &mut F
) -> Self where
    F: FnMut(Box<T>) -> i32, 

Create a new fiber with defined attributes.

Can fail only if there is not enough memory for the fiber structure or fiber stack.

The created fiber automatically returns itself to the fiber cache if has default stack size when its main function completes.

• name - string with fiber name
• fiber_attr - fiber attributes
• callback - function for run inside fiber

See also: start

pub fn start(&mut self, arg: T)

Start execution of created fiber.

• arg - argument to start the fiber with

See also: new

pub fn wakeup(&self)

Interrupt a synchronous wait of a fiber

pub fn join(&self) -> i32

Wait until the fiber is dead and then move its execution status to the caller. The fiber must not be detached (See also: set_joinable).

Returns fiber function ret code

pub fn set_joinable(&mut self, is_joinable: bool)

Set fiber to be joinable (false by default).

• is_joinable - status to set

pub fn cancel(&mut self)

Cancel the subject fiber. (set FIBER_IS_CANCELLED flag)

If target fiber's flag FIBER_IS_CANCELLABLE set, then it would be woken up (maybe prematurely). Then current fiber yields until the target fiber is dead (or is woken up by wakeup).