ai.eloquent.raft

Class NetRaftTransport

java.lang.Object

ai.eloquent.raft.NetRaftTransport

All Implemented Interfaces:

RaftTransport

public class NetRaftTransport
extends java.lang.Object
implements RaftTransport

A Raft transport implemented directly over UDP

Nested Class Summary

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

RaftTransport.Type

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	serverName The name we should assign ourselves on the transport.
boolean	thread If true, run the handling of messages on the transport in a new thread.

Constructor Summary

Constructors

Constructor and Description
NetRaftTransport(java.lang.String serverName)
NetRaftTransport(java.lang.String serverName, int rpcListenPort, boolean async) Create a UDP transport.

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.
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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

Field Detail

serverName

public final java.lang.String serverName

The name we should assign ourselves on the transport.

thread

public final boolean thread

If true, run the handling of messages on the transport in a new thread.

Constructor Detail

NetRaftTransport

public NetRaftTransport(java.lang.String serverName,
                        int rpcListenPort,
                        boolean async)
                 throws java.io.IOException

Create a UDP transport.

Parameters:

serverName - The name of our server

rpcListenPort - The gRPC port to listen on.

async - If true, run messages on the transport in separate threads.

Throws:

java.net.UnknownHostException - Thrown if we could not get our own hostname.

java.io.IOException

NetRaftTransport

public NetRaftTransport(java.lang.String serverName)
                 throws java.io.IOException

Throws:

java.io.IOException

See Also:

NetRaftTransport(String, int, boolean)

Method Detail

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

bind

public void bind(RaftAlgorithm listener)

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()

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)

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)

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)

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()

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object