tarantool / tarantool/doc

feedback: Module socket | Tarantool

Open
#3,282 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Product: Tarantool
SME: @ locker

Details

<…>n read, or a delimiter
has been read, or a timeout has expired.
|Unlike socket_object:recv (which uses an internal read-ahead buffer),
socket_object:read depends on the socket’s buffer.|

https://www.tarantool.io/en/doc/latest/reference/reference_lua/socket/#lua-function.socket_object.read

As I see from the implementation, :recv() directly reads the socket, while :read() uses a read ahead buffer.

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

Start with the socket_object:read and socket_object:recv entries at the linked Tarantool documentation URL, then compare their buffering descriptions with the implementation referenced in the issue. Done means the documentation accurately explains the difference between direct reads and the read-ahead buffer.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.