1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
//! iscpクレートは、iSCP version 2を用いたリアルタイムAPIにアクセスするためのクライアントライブラリです。
//!
//! iscpクレートを使用することで、iSCPを利用するクライアントアプリケーションを実装することができます。
//!
//! iSCPで通信を行うためには、コネクション[`iscp::Conn`]を確立した後、ストリームやE2Eコールを使用してデータを送受信してください。
//!
//! # Examples
//!
//! ## Connect To intdash API
//!
//! このサンプルではintdash APIとのコネクションを確立します。
//!
//! ```
//! use std::env;
//! use std::sync::Arc;
//!
//! #[derive(Clone)]
//! struct TokenSource {
//! access_token: String,
//! }
//!
//! #[async_trait::async_trait]
//! impl iscp::TokenSource for TokenSource {
//! async fn token(&self) -> iscp::Result<String> {
//! Ok(self.access_token.clone())
//! }
//! }
//!
//! let host = env::var("EXAMPLE_HOST").unwrap_or_else(|_| "xxx.xxx.jp".to_string());
//! let port = env::var("EXAMPLE_PORT")
//! .unwrap_or_else(|_| "11443".to_string())
//! .parse::<i32>()
//! .unwrap();
//! let api_token = env::var("EXAMPLE_TOKEN").unwrap_or_else(|_| {
//! "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx".to_string()
//! });
//! let node_id = env::var("EXAMPLE_NODE_ID")
//! .unwrap_or_else(|_| "11111111-1111-1111-1111-111111111111".to_string());
//!
//! let addr = format!("{}:{}", host, port);
//!
//! let token_source = Arc::new(TokenSource {
//! // TODO: アクセストークンはintdash-apiからoauth2で動的に取得してください。
//! access_token: api_token,
//! });
//!
//! let builder = iscp::ConnBuilder::new(&addr, iscp::TransportKind::Quic)
//! .quic_config(Some(iscp::tr::QuicConfig {
//! host, // `host` は、サーバー証明書の検証に使用されます。
//! mtu: 1000,
//! ..Default::default()
//! }))
//! .encoding(iscp::enc::EncodingKind::Proto)
//! .token_source(Some(token_source))
//! .node_id(node_id);
//!
//! tokio::runtime::Runtime::new().unwrap().block_on(async {
//! let conn = builder.connect().await.unwrap();
//! conn.close().await.unwrap();
//! });
//! ```
//!
//! ## Start Upstream
//!
//! アップストリームの送信サンプルです。このサンプルでは、コネクションからアップストリームを開き、基準時刻のメタデータと、文字列型のデータポイントをiSCPサーバーへ送信しています。
//!
//! ```
//! use std::env;
//! use std::sync::Arc;
//!
//! #[derive(Clone)]
//! struct TokenSource {
//! access_token: String,
//! }
//!
//! #[async_trait::async_trait]
//! impl iscp::TokenSource for TokenSource {
//! async fn token(&self) -> iscp::Result<String> {
//! Ok(self.access_token.clone())
//! }
//! }
//!
//! let host = env::var("EXAMPLE_HOST").unwrap_or_else(|_| "xxx.xxx.jp".to_string());
//! let port = env::var("EXAMPLE_PORT")
//! .unwrap_or_else(|_| "11443".to_string())
//! .parse::<i32>()
//! .unwrap();
//! let api_token = env::var("EXAMPLE_TOKEN").unwrap_or_else(|_| {
//! "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx".to_string()
//! });
//! let node_id = env::var("EXAMPLE_NODE_ID")
//! .unwrap_or_else(|_| "11111111-1111-1111-1111-111111111111".to_string());
//!
//! let addr = format!("{}:{}", host, port);
//!
//! let token_source = Arc::new(TokenSource {
//! // TODO: アクセストークンはintdash-apiからoauth2で動的に取得してください。
//! access_token: api_token,
//! });
//!
//! let builder = iscp::ConnBuilder::new(&addr, iscp::TransportKind::Quic)
//! .quic_config(Some(iscp::tr::QuicConfig {
//! host, // `host` は、サーバー証明書の検証に使用されます。
//! mtu: 1000,
//! ..Default::default()
//! }))
//! .encoding(iscp::enc::EncodingKind::Proto)
//! .token_source(Some(token_source))
//! .node_id(node_id);
//!
//! tokio::runtime::Runtime::new().unwrap().block_on(async {
//! let conn = builder.connect().await.unwrap();
//!
//! let session_id = uuid::Uuid::new_v4().to_string(); // セッションIDを払い出します。
//! let base_time = chrono::Utc::now();
//!
//! let up = conn
//! .upstream_builder(&session_id)
//! .flush_policy(iscp::FlushPolicy::IntervalOnly {
//! interval: std::time::Duration::from_millis(5),
//! })
//! .ack_interval(chrono::Duration::milliseconds(1000))
//! .persist(true)
//! .build()
//! .await
//! .unwrap();
//!
//! // 基準時刻をiSCPサーバーへ送信します。
//! conn.send_base_time(
//! iscp::msg::BaseTime {
//! elapsed_time: chrono::Duration::zero(),
//! name: "edge_rtc".to_string(),
//! base_time,
//! priority: 20,
//! session_id,
//! },
//! iscp::SendMetadataOptions {
//! persist: true,
//! },
//! )
//! .await
//! .unwrap();
//!
//! tokio::time::sleep(tokio::time::Duration::from_secs(1)).await;
//!
//! // データポイントをiSCPサーバーへ送信します。
//! up.write_data_points(iscp::DataPointGroup {
//! id: iscp::DataId::new("greeting", "string"),
//! data_points: vec![iscp::DataPoint {
//! payload: "hello".into(),
//! elapsed_time: chrono::Utc::now() - base_time,
//! }],
//! })
//! .await
//! .unwrap();
//!
//! up.close(Some(iscp::UpstreamCloseOptions {
//! close_session: true,
//! }))
//! .await
//! .unwrap();
//! conn.close().await.unwrap();
//! });
//! ```
//!
//! ## Start Downstream
//!
//! 前述のアップストリームで送信されたデータをダウンストリームで受信するサンプルです。
//! このサンプルでは、アップストリーム開始のメタデータ、基準時刻のメタデータ、 文字列型のデータポイントを受信しています。
//!
//! ```
//! use std::env;
//! use std::sync::Arc;
//!
//! #[derive(Clone)]
//! struct TokenSource {
//! access_token: String,
//! }
//!
//! #[async_trait::async_trait]
//! impl iscp::TokenSource for TokenSource {
//! async fn token(&self) -> iscp::Result<String> {
//! Ok(self.access_token.clone())
//! }
//! }
//!
//! let host = env::var("EXAMPLE_HOST").unwrap_or_else(|_| "xxx.xxx.jp".to_string());
//! let port = env::var("EXAMPLE_PORT")
//! .unwrap_or_else(|_| "11443".to_string())
//! .parse::<i32>()
//! .unwrap();
//! let api_token = env::var("EXAMPLE_TOKEN").unwrap_or_else(|_| {
//! "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx".to_string()
//! });
//! let node_id = env::var("EXAMPLE_NODE_ID")
//! .unwrap_or_else(|_| "11111111-1111-1111-1111-111111111111".to_string());
//! let source_node_id = env::var("EXAMPLE_SRC_NODE_ID")
//! .unwrap_or_else(|_| "22222222-2222-2222-2222-222222222222".to_string());
//!
//! let addr = format!("{}:{}", host, port);
//!
//! let token_source = Arc::new(TokenSource {
//! // TODO: アクセストークンはintdash-apiからoauth2で動的に取得してください。
//! access_token: api_token,
//! });
//!
//! let builder = iscp::ConnBuilder::new(&addr, iscp::TransportKind::Quic)
//! .quic_config(Some(iscp::tr::QuicConfig {
//! host, // `host` は、サーバー証明書の検証に使用されます。
//! mtu: 1000,
//! ..Default::default()
//! }))
//! .encoding(iscp::enc::EncodingKind::Proto)
//! .token_source(Some(token_source))
//! .node_id(node_id);
//!
//! tokio::runtime::Runtime::new().unwrap().block_on(async {
//! let conn = builder.connect().await.unwrap();
//!
//! let mut disconnect_notified = conn.subscribe_disconnect();
//!
//! let down = conn
//! .downstream_builder(
//! vec![iscp::DownstreamFilter {
//! source_node_id, // 送信元のノードIDを指定します。
//! data_filters: vec![iscp::DataId::new("#", "#").into()], // 受信したいデータを名称と型で指定します。この例では、ワイルドカード `#` を使用して全てのデータを取得します。
//! }],
//! )
//! .build()
//! .await
//! .unwrap();
//!
//! // ダウンストリーム開始のメタデータの受信
//! let metadata = down.read_metadata().await;
//! println!("{:?}", metadata.unwrap());
//!
//! // アップストリーム開始のメタデータの受信
//! let metadata = down.read_metadata().await;
//! println!("{:?}", metadata.unwrap());
//!
//! // 基準時刻のメタデータの受信
//! let metadata = down.read_metadata().await;
//! println!("{:?}", metadata.unwrap());
//!
//! // 文字列型のデータポイントの受信
//! let down_chunk = down.read_data_points().await.unwrap();
//! println!("{:?}", down_chunk);
//!
//! down.close().await.unwrap();
//! tokio::spawn(async move { conn.close().await.unwrap() });
//!
//! disconnect_notified.recv().await;
//! });
//! ```
#[macro_use]
mod internal;
pub mod encoding;
pub mod error;
pub mod iscp;
pub mod message;
pub mod token_source;
pub mod transport;
pub mod wire;
pub use crate::error::*;
pub use crate::iscp::*;
pub use crate::token_source::*;
pub use crate::encoding as enc;
pub use crate::message as msg;
pub use crate::transport as tr;
mod sync;
pub(crate) use crate::sync::*;
/// プロトコルのバージョンです。
pub const ISCP_VERSION: &str = "2.0.0";