Fiber::suspend
PHP function
Edit on GitHub ✎
(PHP 8 >= 8.1.0)
Suspends execution of the current fiber
Description
Fiber::suspend(mixed $value = null): mixed
Suspends execution of the current fiber. The value provided to this method will be returned from the call to Fiber::start, Fiber::resume, or Fiber::throw that switched execution into the current fiber.
When the fiber is resumed, this method returns the value provided to Fiber::resume. If the fiber is resumed using Fiber::throw, the exception given to that method will be thrown from the call to this method.
If this method is called from outside a fiber, a FiberError will be thrown.
Parameters
valueThe value to return from the call to
Fiber::start,Fiber::resume, orFiber::throwthat switched execution into the current fiber.
Return Values
The value provided to Fiber::resume.