Struct audio_processor_standalone_midi::host::MidiHost

pub struct MidiHost { /* private fields */ }

Host for MIDI messages, opens all ports & forwards them onto a lock-free queue the audio-thread can pop from.

The host will close all MIDI connections on drop.

Implementations

impl MidiHost

pub fn new(handle: &Handle, capacity: usize) -> Self

Create the host, linked to GC Handle and with queue capacity of messages.

pub fn default_with_handle(handle: &Handle) -> Self

Create the host with default 100 capacity

pub fn default_with_queue(handle: &Handle, queue: MidiMessageQueue) -> Self

Build a MidiHost with a pre-built queue

pub fn messages(&self) -> &MidiMessageQueue

Get a reference to the message queue

pub fn start_midi(&mut self) -> Result<(), MidiError>

Start the MIDI connections

Trait Implementations

impl Actor for MidiHost

type Context = Context<Self>

Actor execution context type

fn started(&mut self, ctx: &mut Self::Context)

Called when an actor gets polled the first time.

fn stopping(&mut self, ctx: &mut Self::Context) -> Running

Called after an actor is in Actor::Stopping state.

fn stopped(&mut self, ctx: &mut Self::Context)

Called after an actor is stopped.

fn start(self) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>, 

Start a new asynchronous actor, returning its address.

fn start_default() -> Addr<Self> where
    Self: Actor<Context = Context<Self>> + Default, 

Construct and start a new asynchronous actor, returning its address.

fn start_in_arbiter<F>(wrk: &ArbiterHandle, f: F) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>,
    F: 'static + FnOnce(&mut Context<Self>) -> Self + Send, 

Start new actor in arbiter’s thread.

fn create<F>(f: F) -> Addr<Self> where
    Self: Actor<Context = Context<Self>>,
    F: FnOnce(&mut Context<Self>) -> Self, 

Start a new asynchronous actor given a Context.

impl Default for MidiHost

fn default() -> Self

Returns the “default value” for a type.

impl Drop for MidiHost

fn drop(&mut self)

Executes the destructor for this type.

impl Handler<GetQueueMessage> for MidiHost

type Result = GetQueueMessageResult

The type of value that this handler will return.

fn handle(
    &mut self,
    _msg: GetQueueMessage,
    _ctx: &mut Self::Context
) -> Self::Result

This method is called for every message received by this actor.

impl Handler<StartMessage> for MidiHost

type Result = Result<(), MidiError>

The type of value that this handler will return.

fn handle(
    &mut self,
    _msg: StartMessage,
    _ctx: &mut Self::Context
) -> Self::Result

This method is called for every message received by this actor.

impl Supervised for MidiHost

fn restarting(&mut self, ctx: &mut Self::Context)

Called when the supervisor restarts a failed actor.

impl SystemService for MidiHost

fn service_started(&mut self, _ctx: &mut Context<Self>)

Method is called during service initialization.

fn start_service(wrk: &ArbiterHandle) -> Addr<Self>

Construct and start system service

fn from_registry() -> Addr<Self>

Get actor’s address from system registry