Skip to content

Commit a6a88b5

Browse files
committed
Update after review
1 parent 15e808c commit a6a88b5

File tree

4 files changed

+13
-7
lines changed

4 files changed

+13
-7
lines changed

doc/dev_guide/reference_capi/box.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -378,9 +378,11 @@
378378
379379
The handler returns a status code. Possible statuses:
380380
381-
* ``IPROTO_REQUEST_HANDLER_OK`` -- success
382-
* ``IPROTO_REQUEST_HANDLER_ERROR`` -- error, diagnostic must be set by handler
383-
* ``IPROTO_REQUEST_HANDLER_FALLBACK`` -- fallback to the system handler
381+
* ``IPROTO_REQUEST_HANDLER_OK`` -- success
382+
* ``IPROTO_REQUEST_HANDLER_ERROR`` -- error, diagnostic must be set by handler
383+
(see :ref:`box_error_set() <c_api-error-box_error_set>` and :ref:`box_error_raise() <c_api-error-box_error_raise>`)
384+
385+
* ``IPROTO_REQUEST_HANDLER_FALLBACK`` -- fallback to the default system handler
384386
385387
.. _box_box_iproto_override-destroy:
386388

doc/dev_guide/reference_capi/error.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@
6464
6565
Clear the last error.
6666
67+
.. _c_api-error-box_error_set:
68+
6769
.. c:function:: int box_error_set(const char *file, unsigned line, uint32_t code, const char *format, ...)
6870
6971
Set the last error.
@@ -76,6 +78,8 @@
7678
7779
See also: IPROTO :ref:`error code<capi-box_error_code>`
7880
81+
.. _c_api-error-box_error_raise:
82+
7983
.. c:macro:: box_error_raise(code, format, ...)
8084
8185
A backward-compatible API define.

doc/reference/reference_lua/box_iproto.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ 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-
It enables to extend :ref:`IPROTO <box_protocol>` functionality from the Lua libraries.
9+
It enables to extend the :ref:`IPROTO <box_protocol>` functionality from Lua.
1010
With this submodule, you can:
1111

1212
* :ref:`parse the unknown IPROTO requests types <reference_lua-box_iproto_override>`

doc/reference/reference_lua/box_iproto/override.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ box.iproto.override()
1313
:param number request_type: a request type code. Possible values:
1414

1515
* a type code from :ref:`box.iproto.type <reference_lua-box_iproto_type>` (except
16-
``box.iproto.type.UNKNOWN``) -- override the existing request type.
16+
``box.iproto.type.UNKNOWN``) -- override the existing request type handler.
1717

18-
* ``box.iproto.type.UNKNOWN`` -- override an unknown request type.
18+
* ``box.iproto.type.UNKNOWN`` -- override the handler of unknown request types.
1919

2020
:param function handler: IPROTO request handler.
2121
The signature of a handler function: ``function(sid, header, body)``, where
@@ -25,7 +25,7 @@ box.iproto.override()
2525
* ``body`` (userdata): a request body encoded as :ref:`msgpack_object <msgpack-object-methods>`
2626

2727
Returns ``true`` on success, otherwise ``false``. In case of failure, there is a fallback
28-
to the system handler.
28+
to the default system handler.
2929

3030
To reset the request handler, set the ``handler`` parameter to ``nil``.
3131

0 commit comments

Comments
 (0)