You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
48 lines
1.3 KiB
48 lines
1.3 KiB
// ssip-client -- Speech Dispatcher client in Rust
|
|
// Copyright (c) 2021-2022 Laurent Pelecq
|
|
//
|
|
// Licensed under the Apache License, Version 2.0
|
|
// <LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0> or the MIT
|
|
// license <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
// option. All files in the project carrying such notice may not be copied,
|
|
// modified, or distributed except according to those terms.
|
|
|
|
//! # 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
|
|
//! ```no_run
|
|
//! 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()?;
|
|
//! # Ok::<(), ssip_client::ClientError>(())
|
|
//! ```
|
|
|
|
#[macro_use]
|
|
mod protocol;
|
|
|
|
mod poll;
|
|
mod types;
|
|
|
|
pub mod client;
|
|
pub mod constants;
|
|
pub mod fifo;
|
|
pub mod net;
|
|
pub mod tcp;
|
|
|
|
#[cfg(any(not(feature = "async-mio"), doc))]
|
|
pub use client::Client;
|
|
|
|
pub use client::{Request, Response};
|
|
pub use constants::*;
|
|
pub use poll::QueuedClient;
|
|
pub use types::*;
|