Struct Engine 

pub struct Engine<I: AsyncRead + Unpin, O: AsyncWrite + Unpin> { /* private fields */ }

The main connector to the Yate Telephone Engine.

Implementations

impl Engine<AllowStdIo<Stdin>, AllowStdIo<Stdout>>

pub fn stdio() -> Self

Initialize a connection to the engine via standard I/O.

impl<I: AsyncRead + Send + Unpin, O: AsyncWrite + Send + Unpin> Engine<I, O>

pub fn from_io(rx: I, tx: O) -> Self

Initialize a connection to the engine with the provided I/O.

If the I/O is a socket or a TCP stream, the module must register itself with a Self::connect before doing anything.

pub async fn install( &self, priority: impl Into<Option<u64>>, name: impl Into<String>, filter: impl Into<Option<(String, Option<String>)>>, ) -> Result<bool, Error>

Request the engine to install a message handler with the provided priority.

pub async fn uninstall(&self, name: impl Into<String>) -> Result<bool, Error>

Request the engine to remove a previously installed handler.

pub async fn watch(&self, name: impl Into<String>) -> Result<bool, Error>

Request the engine to install a message watcher.

pub async fn unwatch(&self, name: impl Into<String>) -> Result<bool, Error>

Request the engine to remove a previously installed watcher.

pub async fn setlocal( &self, name: impl Into<String>, value: impl Into<String>, ) -> Result<bool, Error>

Request the engine to set a local variable.

pub async fn getlocal(&self, name: impl Into<String>) -> Result<String, Error>

Request the value of a local variable.

pub async fn message( &self, name: impl Into<String>, retvalue: impl Into<String>, kv: BTreeMap<String, String>, ) -> Result<(bool, String, BTreeMap<String, String>), Error>

Send a Message to the telephony engine for processing.

pub fn messages(&self) -> impl TryStream<Ok = Req, Error = Error>

Receive messages from the telephony engine for processing.

pub async fn ack(&self, req: Req, processed: bool) -> Result<(), Error>

Acknowledge the message from the engine, letting it forward it to the next handler if !processed.

pub async fn connect( &self, role: ConnectRole, channel: impl Into<Option<(String, Option<String>)>>, ) -> Result<(), Error>

Send a connect message to the engine for socket-based modules.

pub async fn output(&self, text: impl Into<String>) -> Result<(), Error>

Output some arbitrary text to engine’s log, this is especially useful on socket-based modules.

pub async fn debug( &self, level: DebugLevel, text: impl Into<String>, ) -> Result<(), Error>

Output some debug text to engine’s log, this is especially useful on socket-based modules.

pub async fn quit(&self) -> Result<(), Error>

Tell the engine we desire to stop handling messages.