File tree 1 file changed +4
-1
lines changed
doc/reference/reference_lua
1 file changed +4
-1
lines changed Original file line number Diff line number Diff line change @@ -1320,7 +1320,7 @@ API reference
1320
1320
1321
1321
.. _fiber_object-join :
1322
1322
1323
- .. method :: join()
1323
+ .. method :: join([timeout] )
1324
1324
1325
1325
Join a fiber.
1326
1326
Joining a fiber enables you to get the result returned by the fiber's function.
@@ -1334,6 +1334,7 @@ API reference
1334
1334
:ref: `fiber.new() <fiber-new >` and is made joinable using
1335
1335
:ref: `fiber_object:set_joinable() <fiber_object-set_joinable >`.
1336
1336
1337
+ :param number timeout: maximum number of seconds to wait for the completion of the fiber. Default: infinity.
1337
1338
:return:
1338
1339
1339
1340
The ``join `` method returns two values:
@@ -1350,6 +1351,8 @@ API reference
1350
1351
1351
1352
:rtype: boolean + result type, or boolean + struct error
1352
1353
1354
+ Possible errors: the fiber is already joined by concurrent ``fiber:join() ``.
1355
+
1353
1356
**Example: **
1354
1357
1355
1358
The example below shows how to get the result returned by the fiber's function.
You can’t perform that action at this time.
0 commit comments