Constants for the networking mode. Each setting represents the method of finding other hosts and whether they communicate over unicast, multicast, or a combination of both after establishing a cluster.

See also:

set_mode(), get_mode()

The different states for the networking connection.

See also:

get_status()

Adds a host to the list of hosts to connect to. This is used in the unicast network modes to specify the hosts to connect to. Note that discovery mode will be disabled if the host list is populated.

See also:

remove_configured_host(), get_number_of_configured_hosts(), get_configured_host()

Parameters

address

The address of the host.

Returns

0, in case of success, -1 in case of failure.

Returns the chosen cluster interface address.

See also:

set_cluster_interface()

Returns

A numerical representation of the cluster interface address and port.

Returns the compression level for network traffic.

See also:

set_compression_level()

Returns the address of a host from the list of configured hosts.

See also:

add_configured_host(), remove_configured_host(), get_number_of_configured_hosts()

Parameters

index

The index of the host to be returned.

Returns

The address of the host, or NULL in case of invalid indices.

Returns the discovery address.

See also:

set_discovery_address()

Returns

A numerical representation of the discovery address and port.

Returns the discovery identifier.

See also:

set_discovery_identifier()

Returns

The discovery identifier.

Returns the configured networking mode. Note that networking might not be used even though it was configured, e.g., due to license restrictions. Make sure to check whether get_status() returns CONNECTION_STANDALONE or CONNECTION_ESTABLISHED after has been started.

See also:

set_mode()

Returns

The configured networking mode.

Returns the base multicast address.

See also:

set_multicast_address()

Returns

A numerical representation of the base multicast address and port.

Returns the set multicast TTL/hop value.

See also:

set_multicast_ttl()

Returns

The current TTL/hop value.

Returns an interface to inquire network statistics.

Returns

The network statistics object.

Returns the current number of configured hosts.

See also:

add_configured_host(), remove_configured_host(), get_configured_host()

Returns RDMA InfiniBand interface to be used.

See also:

get_rdma_interface()

Returns

The RDMA interface to be used, or NULL if none is found.

Returns the redundancy level.

See also:

set_redundancy_level()

Returns

The configured redundancy level.

Returns the status of the networking connection.

Indicates whether RDMA InfiniBand is enabled.

See also:

set_use_rdma()

Registers a callback for cluster changes. For example, this callback can be used to get notifications whenever a host joins or leaves the cluster, or when its properties change.

See also:

unregister_host_callback()

Parameters

callback

The callback to be registered.

Returns

• 0: Success.
• -1: Invalid parameters (NULL pointer).

Removes a host from the list of hosts to connect to. This is used in the unicast network modes to specify the hosts to connect to.

See also:

add_configured_host(), get_number_of_configured_hosts(), get_configured_host()

Parameters

address

The address of the host.

Returns

0, in case of success, -1 in case of failure.

Sets the interface to be used for outgoing packets. If not set, it will be the "any" address. The string may end with : and a port number to select which port to listen to for UDP and TCP unicast. If no port is set and unicast only mode is set, port 10000 will be used.

The IP address of the interface can also be specified as a sub net using the CIDR notation a.b.c.d/xx. If there is an interface on the host with an address inside this range the first match will be used. This is useful for example when configuring several hosts. This means that on a host which has the address 192.168.1.1, specifying the address as 192.168.0.0/16:10000 would make the host bind to the 192.168.1.1 address on port 10000.

IPv6 addresses need to be surrounded by brackets but can otherwise be used just like their IPv4 counterparts mentioned above. The address [::] means the "any IPv6 interface" address.

It is also possible to specify an interface name instead of an address. The name must be prefixed by the string "if://". will then take the address from the interface. A single "*" wildcard may be used at the end of the requested name, in which case the first matching interface will be selected.

This can only be configured before has been started.

See also:

get_cluster_interface()

Parameters

address

The interface address and port.

Returns

0, in case of success, -1 in case of failure.

Sets the compression level for network traffic. This can only be configured before has been started.

See also:

get_compression_level()

Parameters

level

The desired compression level. Valid values are 0 to 9. The value 0 disables compression. The higher the value, the higher the efforts to compress network traffic and the smaller the amount of data transferred across the network.

Returns

0, in case of success, -1 in case of failure.

Sets the discovery address to be used for automatic host discovery. If it is a multicast address multicast will be used to find the other hosts. If it is a unicast address the discovery network assumes that it is the address of the master node which has the list of all other hosts. If that unicast address is the same as the address of the running host, the discovery network will consider itself the master.

An IPv4 UDP multicast address is specified by an address in the range 224.0.0.0 to 239.255.255.255, inclusive, along with a port. An IPv6 multicast address is specified by an IPv6 address with a high-order byte ff. This will be used when MODE_TCP_WITH_DISCOVERY is set. It must include a port, like ip:port. There is a default address which will be used if none is set, both for IPv4 and IPv6.

This can only be configured before has been started.

Note that discovery mode will be disabled if any hosts are added using the add_configured_hosts method.

See also:

get_discovery_address()

Parameters

address

The discovery address and port.

Returns

0, in case of success, -1 in case of failure.

Sets the discovery identifier. The discovery identifier restricts the cluster to hosts that use the same identifier. This can be used to make sure that only compatible or selected nodes can join the cluster. In particular, if several clusters exist this identifier can be used to ensure that the host does not by accident join the wrong cluster. There is a default identifier which will be used if none is set.

This can only be configured before has been started.

See also:

get_discovery_identifier()

Parameters

identifier

The discovery identifier.

Returns

0, in case of success, -1 in case of failure.

Sets the networking mode. This can only be called before has been started.

See also:

get_mode()

Parameters

mode

The desired networking mode.

Returns

0, in case of success, -1 in case of failure.

Sets the base multicast address to be used for networking. This address will be used for UDP mode networking. An IPv4 UDP multicast address is specified by an address in the range 224.0.0.0 to 239.255.255.255, inclusive, along with a port. An IPv6 multicast address is specified by an IPv6 address with a high-order byte ff.

Note that actually not just one, but several multicast addresses are used. The other multicast addresses are obtained by incrementing the last octet. Hence, the value configured here is called the base multicast address.

This can only be configured before has been started.

See also:

get_multicast_address()

Parameters

address

The base multicast address and port.

Returns

0, in case of success, -1 in case of failure.

Sets the time to live (TTL/hops) of multicast packets. The default value is 1.

This can only be configured before has been started.

See also:

get_multicast_ttl()

Parameters

ttl

The new TTL/hop value.

Set the RDMA InfiniBand interface to be used. The string can be either the interface name or it's address, which can be expressed in CIDR format as well, similar to set_cluster_interface. Note that only interface names that start with the prefix 'ib' are accepted.

If unspecified, an arbitrary RDMA InfiniBand interface will be chosen.

This can only be configured before has been started.

See also:

get_rdma_interface()

Parameters

rdma_interface

The RDMA InfiniBand interface to be used, either "ib0", "ib1", etc. or the address of an InfiniBand interface.

Returns

0, in case of success, -1 in case of failure.

Sets the redundancy level to be used for storing objects in the database. This can only be configured before has been started.

See also:

get_redundancy_level()

Parameters

level

The redundancy level. This is limited to a compiled in maximum that is currently set to 4. If the given value exceeds the possible maximum the return value will signal an error but the value will be set to the possible maximum.

Returns

0, in case of success, -1 in case of failure.

Enables or disables the usage of RDMA InfiniBand. The default value is false (disabled).

See also:

get_use_rdma()

Parameters

use_rdma

Indicates whether RDMA InfiniBand should be used (if it is available).

Returns

0, in case of success, -1 in case of failure.

Unregisters a callback for cluster changes.

See also:

register_host_callback()

Parameters

callback

The callback to be unregistered.

Returns

• 0: Success.
• -1: Invalid parameters (NULL pointer).
• -2: callback is not a registered callback.