taktora_connector_host/lib.rs
1//! `ConnectorHost` / `ConnectorGateway` builders, the framework's
2//! [`Connector`] trait, and the [`HealthSubscription`] type returned by
3//! `Connector::subscribe_health`. Implements
4//! [`BB_0005`](../../spec/architecture/connector.rst) plus the
5//! `Connector` trait itself (`REQ_0220`–`REQ_0224`).
6//!
7//! Layering:
8//!
9//! * `taktora-connector-core` defines the small types ([`Routing`],
10//! [`PayloadCodec`], [`ConnectorHealth`], [`HealthEvent`],
11//! [`ChannelDescriptor`], [`ConnectorError`]).
12//! * `taktora-connector-transport-iox` defines the iceoryx2-backed
13//! handles ([`ChannelWriter`], [`ChannelReader`]).
14//! * This crate ties them together via the [`Connector`] trait and
15//! composes them with a [`taktora_executor::Executor`].
16//!
17//! [`Routing`]: taktora_connector_core::Routing
18//! [`PayloadCodec`]: taktora_connector_core::PayloadCodec
19//! [`ConnectorHealth`]: taktora_connector_core::ConnectorHealth
20//! [`HealthEvent`]: taktora_connector_core::HealthEvent
21//! [`ChannelDescriptor`]: taktora_connector_core::ChannelDescriptor
22//! [`ConnectorError`]: taktora_connector_core::ConnectorError
23//! [`ChannelWriter`]: taktora_connector_transport_iox::ChannelWriter
24//! [`ChannelReader`]: taktora_connector_transport_iox::ChannelReader
25
26#![warn(missing_docs)]
27
28pub mod connector;
29pub mod gateway;
30pub mod health_sub;
31pub mod host;
32
33pub use connector::Connector;
34pub use gateway::{ConnectorGateway, ConnectorGatewayBuilder};
35pub use health_sub::HealthSubscription;
36pub use host::{ConnectorHost, ConnectorHostBuilder};