Struct jupiter::commands::CommandDictionary

pub struct CommandDictionary { /* private fields */ }

Represents an internally mutable dictionary which maps commands to queues.

A command dictionary is used by the server to keep track of all known commands and to determine which queue is used to handle a certain command.

Note that the dictionary itself isn’t used to actually dispatch a command. This is the job of the Dispatcher which is a readonly copy of the dictionary which can be used without any synchronization overhead.

Implementations

impl CommandDictionary

pub fn new() -> Self

Creates a new and empty dictionary.

Note that most probably a dictionary is already present and can be obtained from the Platform:

let commands = platform.require::<CommandDictionary>();

pub fn install(platform: &Arc<Platform>) -> Arc<Self>

Creates and installs the default dictionary into the given Platform.

Note that this is automatically performed by the Builder unless disabled.

pub fn register_command(&self, name: &'static str, queue: Queue, token: usize)

Registers a command for the given name to be dispatched into the given queue.

As most probably multiple commands are dispatched to a single queue, their calls can be disambiguated by using the given token.

Example

let (queue, mut endpoint) = queue();

// Attach an actor to the endpoint of the queue...
// jupiter::spawn!(...)

// Register the command...
let commands = CommandDictionary::new();
commands.register_command("PING", queue, 0);

pub fn commands(&self) -> Vec<Arc<Command>>

Reports the usage metrics (and names) of all known commands.

pub fn dispatcher(&self) -> Dispatcher

Creates a readonly copy of the known commands and returns them as dispatcher.

Trait Implementations

impl Default for CommandDictionary

fn default() -> CommandDictionary

Returns the “default value” for a type.