Crate ssip_client_async

SSIP client

ssip-client implements a Speech Dispatcher SSIP client library in pure rust.

See client::Client for the synchronous API and poll::QueuedClient for the asynchronous API.

Example

use ssip_client::{fifo, ClientName};
let mut client = fifo::Builder::new().build()?;
client
    .set_client_name(ClientName::new("joe", "hello"))?
    .check_client_name_set()?;
let msg_id = client.speak()?.send_line("hello")?.receive_message_id()?;
client.quit()?;

Re-exports

• pub use client::Client;
• pub use ssip as types;
• pub use constants::*;

Modules

• async_std
• client
• constants
• fifo
• net
• tcp
• tokio

Structs

• ClientName
  Client name
• Event
  Notification event
• EventId
  Event identifier
• HistoryClientStatus
  History client status
• QueuedClient
  Client with a queue of requests.
• StatusLine
  Command status line
• SynthesisVoice
  Synthesis voice

Enums

• CapitalLettersRecognitionMode
  Capital letters recognition mode.
• ClientError
  Client error, either I/O error or SSIP error.
• ClientScope
  Client identifiers
• CursorDirection
  Cursor motion in history
• EventType
  Notification event type (returned by server)
• HistoryPosition
  Position in history
• KeyName
  Symbolic key names
• MessageScope
  Message identifiers
• NotificationType
  Notification type
• Ordering
  Sort ordering
• Priority
  Priority
• PunctuationMode
  Punctuation mode.
• Request
  Request for SSIP server.
• Response
  Response from SSIP server.
• SortDirection
  Sort direction in history
• SortKey
  Property messages are ordered by in history

Type Aliases

• ClientId
  Client identifier
• ClientResult
  Client result.
• ClientStatus
  Client result consisting in a single status line
• MessageId
  Message identifier
• ReturnCode
  Return code of SSIP commands