tarantool / tarantool/doc

Ability to set timeout for 'fiber:join' function was implemented

Open
#2,412 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

feature fiber reference
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

Product: Tarantool
Since: 2.8
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/fiber/#lua-function.fiber_object.join
SME: @ EvgenyMekhanik

Details

Implement ability to pass timeout to 'fiber:join' function.
If timeout expired, join fails with 'timed out' error.

Requested by @ EvgenyMekhanik in https://github.com/tarantool/tarantool/commit/9a1a9f09869d9dfcccb433954b4e75e3ca7d130d

Комментарий от EvgenyMekhanik:
«Timeout задаем в параметре функции f:join(0.1).
Параметр — число большее или равное 0.
Если таймаут истекает раньше, чем файбер завершится, то join завершится с ошибкой»

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the root document at the fiber_object.join reference, which is the target named in the issue. Update the join documentation to cover a numeric timeout parameter, including the non-negative constraint and the timed-out error behavior, then verify the resulting reference text is accurate.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.