Skip to content

[8pt] Mark all built-in modules with information about yielding #1448

Open
@rosik

Description

@rosik

Make fiber stuff well-described again

Product: Tarantool
Since:
Audience/target: Lua devs
Root document: https://www.tarantool.io/en/doc/latest/reference/reference_lua/fiber/
SME: @rosik
Peer reviewer: @ documentarian name

Details

Documentation about implicit cases is very poor. I believe it deserves another chapter in doc.

What information I'd like to see there:

  • List ALL functions that yield explicitly. And when do they. For example, channel:get() is tricky and yields only occasionally.
  • Mark ALL those functions within their sections - fio, netbox, http, socket, log (!), etc.
  • Every implicit yield may raise upon wakeup if the fiber was cancelled.
  • fiber.cancel doesn't yield, but still raises "fiber is cancelled" error.
  • Please mention requirements for triggers too.

Definition of done

Metadata

Metadata

Assignees

No one assigned

    Labels

    design[nature] Design issuemanual[location] Tarantool manual, no definite locationserver[area] Task relates to Tarantool's server (core) functionality

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions