io.atomix.protocols.raft.protocol

Interface RaftResponse

All Superinterfaces:

RaftMessage

All Known Implementing Classes:

AbstractRaftResponse, AppendResponse, CloseSessionResponse, CommandResponse, ConfigurationResponse, ConfigureResponse, HeartbeatResponse, InstallResponse, JoinResponse, KeepAliveResponse, LeaveResponse, MetadataResponse, OpenSessionResponse, OperationResponse, PollResponse, QueryResponse, ReconfigureResponse, SessionResponse, TransferResponse, VoteResponse

public interface RaftResponse
extends RaftMessage

Base interface for responses.

Each response has a non-null RaftResponse.Status of either RaftResponse.Status.OK or RaftResponse.Status.ERROR. Responses where status() is RaftResponse.Status.ERROR may provide an optional error() code.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RaftResponse.Builder<T extends RaftResponse.Builder<T,U>,U extends RaftResponse> Response builder.
static class	RaftResponse.Status Response status.

Method Summary

Modifier and Type	Method and Description
RaftError	error() Returns the response error if the response status is Status.ERROR
RaftResponse.Status	status() Returns the response status.

Method Detail

status

RaftResponse.Status status()

Returns the response status.

Returns:

The response status.

error

RaftError error()

Returns the response error if the response status is Status.ERROR

Returns:

The response error.