tarantool / tarantool/doc

`interface` URI parameter support in `net.box.connect`

Open
#5,482 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Now a URI passed to the net.box.connect can contain the interface
param specifying the name of the interface to bind the connection to.
Example: net_box.connect({3301, params = {interface = 'lo'}}).
Requested by @mkostoevr in https://github.com/tarantool/tarantool/commit/5528ca25776b2477f7858af5970f2fc97aad681c.

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

Search the documentation for the net.box.connect entry point and its existing URI or params descriptions. Document that the interface parameter selects the local interface for the connection, including the example from the issue; done when the parameter and example are covered consistently.

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
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.