Overview

Project website www.tarantool.io/en/doc/latest
Translation process
  • Translations can be made directly.
  • Translation suggestions can be made.
  • Any authenticated user can contribute.
  • The translation uses bilingual files.
Source code repository git@github.com:tarantool/doc.git
Repository branch test-weblate
Weblate repository http://weblate.tarantool.io/git/testing_project/documentation-referencereference_luabox_sessiontype/
File mask locale/*/LC_MESSAGES/reference/reference_lua/box_session/push.po
Translation file Not available
Last change None
Last author None

String statistics

Strings percent Hosted strings Words percent Hosted words Characters percent Hosted characters
Total 18 799 5,423
Translated 100% 18 100% 799 100% 5,423
Needs editing 0% 0 0% 0 0% 0
Read-only 100% 18 100% 799 100% 5,423
Failing checks 5% 1 44% 352 42% 2,300
Strings with suggestions 0% 0 0% 0 0% 0
Untranslated strings 0% 0 0% 0 0% 0
Last 12 months Previous

Activity in last 12 months

0 changes 0 changes 0 changes 0 changes 0 changes 0 changes 0 changes 0 changes 0 changes 0 changes 0 changes 0 changes 0 changes 0 changes 18 changes 0 changes 0 changes 0 changes 0 changes 0 changes 0 changes 0 changes 0 changes 0 changes
Apr May Jun Jul Aug Sep Oct Nov Dec Jan Feb Mar

Quick numbers

799
Hosted words
18
Hosted strings
100%
Translated
0
Contributors
and previous 30 days

Trends of last 30 days

—
Hosted words
+100%
—
Hosted strings
+100%
—
Translated
+100%
—
Contributors
—
User avatar None

New source string

testing_project / Documentation: reference/reference_lua/box_session/push — English

-- Make two shells. On Shell#1 set up a "server", and
-- in it have a function that includes box.session.push:
box.cfg{listen=3301}
box.schema.user.grant('guest','read,write,execute','universe')
x = 0
fiber = require('fiber')
function server_function() x=x+1; fiber.sleep(1); box.session.push(x); end

-- On Shell#2 connect to this server as a "client" that
-- can handle Lua (such as another Tarantool server operating
-- as a client), and initialize a table where we'll get messages:
net_box = require('net.box')
conn = net_box.connect(3301)
messages_from_server = {}

-- On Shell#2 remotely call the server function and receive
-- a SYNCHRONOUS out-of-band message:
conn:call('server_function', {},
{is_async = false,
on_push = table.insert,
on_push_ctx = messages_from_server})
messages_from_server
-- After a 1-second pause that is caused by the fiber.sleep()
-- request inside server_function, the result in the
-- messages_from_server table will be: 1. Like this:
-- tarantool> messages_from_server
-- ---
-- - - 1
-- ...
-- Good. That shows that box.session.push(x) worked,
-- because we know that x was 1.

-- On Shell#2 remotely call the same server function and
-- get an ASYNCHRONOUS out-of-band message. For this we cannot
-- use on_push and on_push_ctx options, but we can use pairs():
future = conn:call('server_function', {}, {is_async = true})
messages = {}
keys = {}
for i, message in future:pairs() do
table.insert(messages, message) table.insert(keys, i) end
messages
future:wait_result(1000)
for i, message in future:pairs() do
table.insert(messages, message) table.insert(keys, i) end
messages
-- There is no pause because conn:call does not wait for
-- server_function to finish. The first time that we go through
-- the pairs() loop, we see the messages table is empty. Like this:
-- tarantool> messages
-- ---
-- - - 2
-- - []
-- ...
-- That is okay because the server hasn't yet called
-- box.session.push(). The second time that we go through
-- the pairs() loop, we see the value of x at the time of
-- the second call to box.session.push(). Like this:
-- tarantool> messages
-- ---
-- - - 2
-- - &0 []
-- - 2
-- - *0
-- ...
-- Good. That shows that the message was asynchronous, and
-- that box.session.push() did its job.
a year ago
User avatar None

New source string

testing_project / Documentation: reference/reference_lua/box_session/push — English

**Example:**
a year ago
User avatar None

New source string

testing_project / Documentation: reference/reference_lua/box_session/push — English

Situation 2 complication: ``pairs()`` is subject to timeout. So there is an optional argument = timeout per iteration. If timeout occurs before there is a new message or a final response, there is an error return. To check for an error one can use the first loop parameter (if the loop starts with "for i, message in future:pairs()" then the first loop parameter is i). If it is ``box.NULL`` then the second parameter (in our example, "message") is the error object.
a year ago
User avatar None

New source string

testing_project / Documentation: reference/reference_lua/box_session/push — English

Situation 2: when the client calls asynchronously with the non-default ``{async=true}`` option. Here ``on_push`` and ``on_push_ctx`` are not allowed, but the messages can be seen by calling ``pairs()`` in a loop.
a year ago
User avatar None

New source string

testing_project / Documentation: reference/reference_lua/box_session/push — English

Situation 1: when the client calls synchronously with the default ``{async=false}`` option. There are two optional additional options: :samp:`on_push={function-name}`, and :samp:`on_push_ctx={function-argument}`. When the client receives an out-of-band message for the session, it invokes "function-name(function-argument)". For example, with options ``{on_push=table.insert, on_push_ctx=messages}``, the client will insert whatever it receives into a table named 'messages'.
a year ago
User avatar None

New source string

testing_project / Documentation: reference/reference_lua/box_session/push — English

The client's job is to check for such messages after it sends something to the server. The major client methods -- :ref:`conn:call <net_box-call>`, :ref:`conn:eval <net_box-eval>`, :ref:`conn:select <conn-select>`, :ref:`conn:insert <conn-insert>`, :ref:`conn:replace <conn-replace>`, :ref:`conn:update <conn-update>`, :ref:`conn:upsert <conn-upsert>`, :ref:`delete <conn-delete>` -- may cause the server to send a message.
a year ago
User avatar None

New source string

testing_project / Documentation: reference/reference_lua/box_session/push — English

The server's sole job is to call ``box.session.push()``, there is no automatic mechanism for showing that the message was received.
a year ago
User avatar None

New source string

testing_project / Documentation: reference/reference_lua/box_session/push — English

When the return is ``true``, the message has gone to the network buffer as a :ref:`packet <box_protocol-iproto_protocol>` with a different :ref:`header code <box_protocol-responses_out_of_band>` so the client can distinguish from an ordinary Okay response.
a year ago
User avatar None

New source string

testing_project / Documentation: reference/reference_lua/box_session/push — English

If the result is not an error, then the return is the boolean value ``true``.
a year ago
User avatar None

New source string

testing_project / Documentation: reference/reference_lua/box_session/push — English

If the result is an error, then the first part of the return is ``nil`` and the second part is the error object.
a year ago
Browse all translation changes