Zen

Source string Source string

106/10000 · 106
English Actions
``heartbeat_rate`` (double) -- rate of sending round messages, in seconds. Setting ``heartbeat_rate`` to X does not mean that every member will be checked every X seconds, instead X is the protocol speed. Protocol period depends on member count and heartbeat_rate. Default = 1.
``ack_timeout`` (double) -- time in seconds after which a ping is considered to be unacknowledged. Default = 30.
``gc_mode`` (enum) -- dead member collection mode.
If ``gc_mode == 'off'`` then SWIM never removes dead members from the member table (though users may remove them with :ref:`swim_object:remove_member() <swim-remove_member>`), and SWIM will continue to ping them as if they were alive.
If ``gc_mode == 'on'`` then SWIM removes dead members from the member table after one round.
Default = ``'on'``.
``uri`` (string or number) -- either an ``'ip:port'`` address, or just a port number (if ip is omitted then 127.0.0.1 is assumed). If ``port == 0``, then the kernel will select any free port for the IP address.
``uuid`` (string or cdata struct tt_uuid) -- a value which should be unique among SWIM instances. Users may choose any value but the recommendation is: use :ref:`box.cfg.instance_uuid <cfg_replication-instance_uuid>`, the Tarantool instance's UUID.
All the ``cfg`` components are dynamic -- ``swim_object:cfg()`` may be called more than once. If it is not being called for the first time and a component is not specified, then the component retains its previous value. If it is being called for the first time then uri and uuid are mandatory, since a SWIM instance cannot operate without URI and UUID.
``swim_object:cfg()`` is atomic -- if there is an error, then nothing changes.
true if configuration succeeds
nil, ``err`` if an error occurred. ``err`` is an error object
swim_object:cfg({heartbeat_rate = 0.5})
After ``swim_object:cfg()``, all other ``swim_object`` methods are callable.
Expose all non-nil components of the read-only table which was set up or changed by :ref:`swim_object:cfg() <swim-object_cfg>`.
tarantool> swim_object.cfg
---
- gc_mode: off
uri: 3333
uuid: 00000000-0000-1000-8000-000000000001
...
Delete a SWIM instance immediately. Its memory is freed, its member table entry is deleted, and it can no longer be used. Other members will treat this member as 'dead'.
After ``swim_object:delete()`` any attempt to use the deleted instance will cause an exception to be thrown.
none, this method does not fail
Example: ``swim_object:delete()``
Return false if a SWIM instance was created via :ref:`swim.new() <swim-new>` without an optional ``cfg`` argument, and was not configured with :ref:`swim_object:cfg() <swim-object_cfg>`. Otherwise return true.
boolean result, true if configured, otherwise false
Example: ``swim_object:is_configured()``
Return the size of the member table. It will be at least 1 because the "self" member is included.
integer size
Example: ``swim_object:size()``
Leave the cluster.
This is a graceful equivalent of :ref:`swim_object:delete() <swim-delete>` -- the instance is deleted, but before deletion it sends to each member in its member table a message, that this instance has left the cluster, and should not be considered dead.
Other instances will mark such a member in their tables as 'left', and drop it after one round of dissemination.
Consequences to the caller are the same as after ``swim_object:delete()`` -- the instance is no longer usable, and an error will be thrown if there is an attempt to use it.
none, the method does not fail

Loading…

User avatar None

New source string

testing_project / Documentation: reference/reference_lua/swim — English

tarantool> swim_object.cfg
---
- gc_mode: off
uri: 3333
uuid: 00000000-0000-1000-8000-000000000001
...
a year ago
Browse all string changes

Things to check

Ellipsis

The string uses three dots (...) instead of an ellipsis character (…)

Reset

Glossary

English English
No related strings found in the glossary.

String information

Flags
read-only
String age
a year ago
Last updated
a year ago
Source string age
a year ago
Translation file
string 51