com.hivemq.spi.callback.cluster

Interface ClusterDiscoveryCallback

All Superinterfaces:

AsynchronousCallback, Callback

public interface ClusterDiscoveryCallback
extends AsynchronousCallback

This callback is meant to regularly discover the addresses of all available HiveMQ cluster nodes.

Notice: It is used only if cluster is enabled and discovery is set to "plugin" in the HiveMQ config file.

Since:

3.1

Author:

Christoph Schäbel

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy() Gets called when the cluster is shut down.
com.google.common.util.concurrent.ListenableFuture<List<ClusterNodeAddress>>	getNodeAddresses() Gets called every X seconds by HiveMQ to discover all available cluster nodes.
void	init(String clusterId, ClusterNodeAddress ownAddress) Gets called before the HiveMQ instance starts looking for other HiveMQ instances to form a cluster with.

Method Detail

init

void init(String clusterId,
        ClusterNodeAddress ownAddress)

Gets called before the HiveMQ instance starts looking for other HiveMQ instances to form a cluster with.

This method can be used to register this HiveMQ instance with some kind of central registry or save it to a database or file server for example.

Parameters:

clusterId - this HiveMQ instance's unique cluster node ID

ownAddress - this HiveMQ instance's address

getNodeAddresses

com.google.common.util.concurrent.ListenableFuture<List<ClusterNodeAddress>> getNodeAddresses()

Gets called every X seconds by HiveMQ to discover all available cluster nodes.

The interval at which this method is called can be configured in the HiveMQ config file.

Returns:

a list of all the cluster node's addresses

destroy

void destroy()

Gets called when the cluster is shut down.

This method can be used to unregister this HiveMQ instance from a central registry.