ai.eloquent.raft

Class InstantTransport

java.lang.Object

ai.eloquent.raft.InstantTransport

All Implemented Interfaces:

RaftTransport

public class InstantTransport
extends java.lang.Object
implements RaftTransport

This is used for benchmarking, and to do JIT burn-ins for latency sensitive code paths.

Nested Class Summary

Nested classes/interfaces inherited from interface ai.eloquent.raft.RaftTransport

RaftTransport.Type

Constructor Summary

Constructors

Constructor and Description
InstantTransport()

Method Summary

Modifier and Type	Method and Description
void	bind(RaftAlgorithm listener) Register a listener for RPCs.
java.util.Collection<RaftAlgorithm>	boundAlgorithms() Get the collection of algorithms that have been bound to this transport.
void	broadcastTransport(java.lang.String sender, EloquentRaftProto.RaftMessage message) Broadcast an RPC request over the transport to all members of the cluster.
static void	burnInJIT() We use this to burn in the important routines in Raft
Span	expectedNetworkDelay() The expected delay, in milliseconds, for a round-trip on this transport.
void	rpcTransport(java.lang.String sender, java.lang.String destination, EloquentRaftProto.RaftMessage message, java.util.function.Consumer<EloquentRaftProto.RaftMessage> onResponseReceived, java.lang.Runnable onTimeout, long timeout) Send an RPC request over the transport, expecting a reply.
void	schedule(SafeTimerTask timerTask, long delay) Schedule an event every |period| seconds.
void	scheduleAtFixedRate(SafeTimerTask timerTask, long period) Schedule an event every |period| seconds.
void	sendTransport(java.lang.String sender, java.lang.String destination, EloquentRaftProto.RaftMessage message) Send an RPC request over the transport, not necessarily expecting a reply.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.eloquent.raft.RaftTransport

broadcastTransport, create, getFuture, messageType, mkRaftMessage, mkRaftMessage, mkRaftRPC, now, rpcTransport, rpcTransportAsFuture, rpcTransportAsFuture, sendTransport, sleep, start, stop, threadsCanBlock

Constructor Detail

InstantTransport

public InstantTransport()

Method Detail

bind

public void bind(RaftAlgorithm listener)

Description copied from interface: RaftTransport

Register a listener for RPCs. This must be idempotent!

Specified by:

bind in interface RaftTransport

Parameters:

listener - The listener that should be called on all received RPC requests.

boundAlgorithms

public java.util.Collection<RaftAlgorithm> boundAlgorithms()

Description copied from interface: RaftTransport

Get the collection of algorithms that have been bound to this transport. This is primarily useful for unit testing.

Specified by:

boundAlgorithms in interface RaftTransport

rpcTransport

public void rpcTransport(java.lang.String sender,
                         java.lang.String destination,
                         EloquentRaftProto.RaftMessage message,
                         java.util.function.Consumer<EloquentRaftProto.RaftMessage> onResponseReceived,
                         java.lang.Runnable onTimeout,
                         long timeout)

Description copied from interface: RaftTransport

Send an RPC request over the transport, expecting a reply.

Specified by:

rpcTransport in interface RaftTransport

Parameters:

sender - The name of the node sending the message. In many implementations, this is redundant.

destination - The destination we are sending the message to. This is a server name on the same cluster as the node this transport is bound to.

message - The message to send, as a EloquentRaftProto.RaftMessage.

onResponseReceived - The callback to run when a response is received from the server for the RPC. Either this or onTimeout is always called.

onTimeout - Called when no response is received in the given timeout threshold.

timeout - The number of milliseconds to wait before considering an RPC timed out.

sendTransport

public void sendTransport(java.lang.String sender,
                          java.lang.String destination,
                          EloquentRaftProto.RaftMessage message)

Description copied from interface: RaftTransport

Send an RPC request over the transport, not necessarily expecting a reply.

Specified by:

sendTransport in interface RaftTransport

Parameters:

sender - The name of the node sending the message. In many implementations, this is redundant.

destination - The destination we are sending the message to. This is a server name on the same cluster as the node this transport is bound to.

message - The message to send, as a EloquentRaftProto.RaftMessage.

broadcastTransport

public void broadcastTransport(java.lang.String sender,
                               EloquentRaftProto.RaftMessage message)

Description copied from interface: RaftTransport

Broadcast an RPC request over the transport to all members of the cluster.

Specified by:

broadcastTransport in interface RaftTransport

Parameters:

sender - The name of the node sending the message. In many implementations, this is redundant.

message - The message to send, as a EloquentRaftProto.RaftMessage.

expectedNetworkDelay

public Span expectedNetworkDelay()

Description copied from interface: RaftTransport

The expected delay, in milliseconds, for a round-trip on this transport. This is used to calibrate the Raft algorithm, and to test the unit tests.

Specified by:

expectedNetworkDelay in interface RaftTransport

scheduleAtFixedRate

public void scheduleAtFixedRate(SafeTimerTask timerTask,
                                long period)

Schedule an event every |period| seconds. This is an alias for SafeTimer.scheduleAtFixedRate(SafeTimerTask, long, long), but mockable

Specified by:

scheduleAtFixedRate in interface RaftTransport

schedule

public void schedule(SafeTimerTask timerTask,
                     long delay)

Schedule an event every |period| seconds. This is an alias for SafeTimer.schedule(SafeTimerTask, long), but mockable

Specified by:

schedule in interface RaftTransport

burnInJIT

public static void burnInJIT()

We use this to burn in the important routines in Raft