ai.eloquent.data

Interface Transport

All Known Implementing Classes:

UDPTransport

public interface Transport

An interface for a transport layer used in the Eloquent codebase.

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.concurrent.ExecutorService	POOL A thread pool from which to run tasks.

Method Summary

Modifier and Type	Method and Description
void	bind(UDPBroadcastProtos.MessageType channel, java.util.function.Consumer<byte[]> listener) Bind a consumer to this transport, to listen on incoming messages.
boolean	broadcastTransport(UDPBroadcastProtos.MessageType messageType, byte[] message) Broadcast a message to everyone listening on the transport.
default void	doAction(boolean async, java.lang.String description, java.lang.Runnable action) Do a given action.
boolean	sendTransport(java.lang.String destination, UDPBroadcastProtos.MessageType messageType, byte[] message) Send a message on the transport.

Field Detail

POOL

static final java.util.concurrent.ExecutorService POOL

A thread pool from which to run tasks.

Method Detail

bind

void bind(UDPBroadcastProtos.MessageType channel,
          java.util.function.Consumer<byte[]> listener)

Bind a consumer to this transport, to listen on incoming messages.

Parameters:

channel - The type of message we're listing for.

listener - The listener, taking as input a raw byte stream.

sendTransport

boolean sendTransport(java.lang.String destination,
                      UDPBroadcastProtos.MessageType messageType,
                      byte[] message)

Send a message on the transport.

Parameters:

destination - The location we're sending the message to. This is transport-dependent, but is often the IP address of the destination.

messageType - The type of message we're sending. This should match the channel in bind(UDPBroadcastProtos.MessageType, Consumer).

message - The message, as a raw byte stream.

Returns:

True if the message was sent.

broadcastTransport

boolean broadcastTransport(UDPBroadcastProtos.MessageType messageType,
                           byte[] message)

Broadcast a message to everyone listening on the transport.

Parameters:

messageType - The type of message we're sending. This should match the channel in bind(UDPBroadcastProtos.MessageType, Consumer).

message - The message, as a raw byte stream.

Returns:

True if the message was sent to everyone.

doAction

default void doAction(boolean async,
                      java.lang.String description,
                      java.lang.Runnable action)

Do a given action. This method is called on the main IO reader loop; if we want to offload it to a thread, this is the place to do it.

Parameters:

async - If true, run the action asynchronously on POOL.

description - A human-readable description of the action

action - The action to perform.