io.atomix.protocols.raft.protocol

Class KeepAliveResponse

java.lang.Object

io.atomix.protocols.raft.protocol.AbstractRaftResponse

io.atomix.protocols.raft.protocol.KeepAliveResponse

All Implemented Interfaces:

RaftMessage, RaftResponse

public class KeepAliveResponse
extends AbstractRaftResponse

Session keep alive response.

Session keep alive responses are sent upon the completion of a KeepAliveRequest from a client. Keep alive responses, when successful, provide the current cluster configuration and leader to the client to ensure clients can evolve with the structure of the cluster and make intelligent decisions about connecting to the cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeepAliveResponse.Builder Status response builder.

Nested classes/interfaces inherited from interface io.atomix.protocols.raft.protocol.RaftResponse

RaftResponse.Status

Constructor Summary

Constructors

Constructor and Description
KeepAliveResponse(RaftResponse.Status status, RaftError error, MemberId leader, Collection<MemberId> members, long[] sessionIds)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
int	hashCode()
MemberId	leader() Returns the cluster leader.
Collection<MemberId>	members() Returns the cluster members.
static KeepAliveResponse.Builder	newBuilder() Returns a new keep alive response builder.
long[]	sessionIds() Returns the sessions that were successfully kept alive.
String	toString()

Methods inherited from class io.atomix.protocols.raft.protocol.AbstractRaftResponse

error, status

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

KeepAliveResponse

public KeepAliveResponse(RaftResponse.Status status,
                         RaftError error,
                         MemberId leader,
                         Collection<MemberId> members,
                         long[] sessionIds)

Method Detail

newBuilder

public static KeepAliveResponse.Builder newBuilder()

Returns a new keep alive response builder.

Returns:

A new keep alive response builder.

leader

public MemberId leader()

Returns the cluster leader.

Returns:

The cluster leader.

members

public Collection<MemberId> members()

Returns the cluster members.

Returns:

The cluster members.

sessionIds

public long[] sessionIds()

Returns the sessions that were successfully kept alive.

Returns:

The sessions that were successfully kept alive.

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractRaftResponse

equals

public boolean equals(Object object)

Overrides:

equals in class AbstractRaftResponse

toString

public String toString()

Overrides:

toString in class AbstractRaftResponse