io.aeron.cluster.service

Class ConsensusModuleProxy

java.lang.Object

io.aeron.cluster.service.ConsensusModuleProxy

All Implemented Interfaces:

AutoCloseable

public final class ConsensusModuleProxy
extends Object
implements AutoCloseable

Proxy for communicating with the Consensus Module over IPC.

Note: This class is not for public use.

Constructor Summary

Constructors

Constructor and Description
ConsensusModuleProxy(Publication publication) Construct a proxy to the consensus module that will send messages over a provided Publication.

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	clusterMembersQuery(long correlationId) Query for the current cluster members.
boolean	removeMember(int memberId, BooleanType isPassive) Remove a member by id from the cluster.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConsensusModuleProxy

public ConsensusModuleProxy(Publication publication)

Construct a proxy to the consensus module that will send messages over a provided Publication.

Parameters:

publication - for sending messages to the consensus module.

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

clusterMembersQuery

public boolean clusterMembersQuery(long correlationId)

Query for the current cluster members.

Parameters:

correlationId - for the request.

Returns:

true of the request was successfully sent, otherwise false.

removeMember

public boolean removeMember(int memberId,
                            BooleanType isPassive)

Remove a member by id from the cluster.

Parameters:

memberId - to be removed.

isPassive - to indicate if the member is passive or not.

Returns:

true of the request was successfully sent, otherwise false.