Skip to content

Commit 61d4a3f

Browse files
committed
Update pages
1 parent d16113f commit 61d4a3f

File tree

8 files changed

+242
-193
lines changed

8 files changed

+242
-193
lines changed

doc/dev_guide/internals/iproto/format.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ Read the source code file `net_box.c <https://github.com/tarantool/tarantool/blo
6868
where the function ``decode_metadata_optional`` is an example of how Tarantool
6969
itself decodes extra items.
7070

71+
.. _box_protocol-body:
72+
7173
Body
7274
----
7375

doc/reference/reference_lua/box_iproto.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Submodule box.iproto
66
Since :doc:`2.11.0 </release/2.11.0>`.
77

88
The ``box.iproto`` submodule provides the ability to work with the network subsystem of Tarantool.
9-
The submodule is important for backward compatibility and enables to
9+
It enables to extend the :ref:`binary protocol <box_protocol>` functionality from the Lua libraries.
10+
With this submodule, you can:
1011

11-
* extend the :ref:`binary protocol <box_protocol>` functionality from the Lua libraries
1212
* parse the unknown IPROTO requests
1313
* send arbitrary IPROTO packets
1414
* override the behavior of the existing request types in binary protocol
@@ -35,13 +35,13 @@ For example:
3535

3636
.. code-block:: lua
3737
38-
box.iproto.key.SYNC = 1
38+
box.iproto.key.SYNC = 0x01
3939
-- ...
4040
box.iproto.type.SELECT = 1
4141
-- ...
42-
box.iproto.flag.COMMIT = 1
42+
box.iproto.flag.COMMIT = 0x01
4343
-- ...
44-
box.iproto.ballot_key.VCLOCK = 2
44+
box.iproto.ballot_key.VCLOCK = 0x02
4545
-- ...
4646
box.iproto.metadata_key.IS_NULLABLE = 3
4747
-- ...
@@ -57,7 +57,7 @@ The submodule exports:
5757

5858
* the current IPROTO protocol version (:ref:`box.iproto.protocol_version <reference_lua-box_iproto_version>`)
5959
* the set of IPROTO protocol features supported by the server (:ref:`box.iproto.protocol_features <reference_lua-box_iproto_protocol-features>`)
60-
* the IPROTO protocol features with the corresponding code (:ref:`box.iproto.feature <reference_lua-box_iproto_feature>`)
60+
* IPROTO protocol features with the corresponding code (:ref:`box.iproto.feature <reference_lua-box_iproto_feature>`)
6161

6262
.. _box_iproto-reference:
6363

doc/reference/reference_lua/box_iproto/ballot.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ box.iproto.ballot_key
77

88
.. data:: ballot_key
99

10-
The ``box.iproto.ballot_key`` namespace contains the keys from the :ref:`IPROTO_BALLOT <box_protocol-ballots>` requests.
11-
Learn more: :ref:`IPROTO_BALLOT keys <internals-iproto-keys-ballot>`.
10+
The ``box.iproto.ballot_key`` namespace contains the keys from the :ref:`IPROTO_BALLOT <box_protocol-ballots>` requests.
11+
Learn more: :ref:`IPROTO_BALLOT keys <internals-iproto-keys-ballot>`.
1212

1313
Available keys:
1414

@@ -55,3 +55,13 @@ box.iproto.ballot_key
5555
* - REGISTERED_REPLICA_UUIDS
5656
- :ref:`IPROTO_BALLOT_REGISTERED_REPLICA_UUIDS <internals-iproto-keys-ballot>`
5757
- 0x09
58+
59+
60+
**Example**
61+
62+
.. code-block:: lua
63+
64+
box.iproto.ballot_key.IS_RO_CFG = 0x01
65+
-- ...
66+
box.iproto.ballot_key.VCLOCK = 0x02
67+
-- ...

doc/reference/reference_lua/box_iproto/flag.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ box.iproto.flag
77

88
.. data:: flag
99

10-
The ``box.iproto.flag`` namespace contains the flags from the ``IPROTO_FLAGS`` key.
11-
Learn more: :ref:`IPROTO_FLAGS key <box_protocol-flags>`.
10+
The ``box.iproto.flag`` namespace contains the flags from the ``IPROTO_FLAGS`` key.
11+
Learn more: :ref:`IPROTO_FLAGS key <box_protocol-flags>`.
1212

1313
Available flags:
1414

@@ -31,3 +31,13 @@ box.iproto.flag
3131
* - WAIT_ACK
3232
- :ref:`IPROTO_FLAG_WAIT_ACK <internals-iproto-keys-flags>`
3333
- 0x03
34+
35+
36+
**Example**
37+
38+
.. code-block:: lua
39+
40+
box.iproto.flag.COMMIT = 0x01
41+
-- ...
42+
box.iproto.flag.WAIT_SYNC = 0x02
43+
-- ...

0 commit comments

Comments
 (0)