提交 30710bf6 authored 作者: Serhij S's avatar Serhij S

doc fixes

上级 7f35cc78
...@@ -6,6 +6,8 @@ ...@@ -6,6 +6,8 @@
* Custom real-time locking policies * Custom real-time locking policies
* [RTSC](https://crates.io/crates/rtsc) 0.3 integration
* Stability and architecture improvements * Stability and architecture improvements
* [RFlow](https://crates.io/crates/rflow) integration * [RFlow](https://crates.io/crates/rflow) integration
......
...@@ -62,17 +62,17 @@ width="550" /> ...@@ -62,17 +62,17 @@ width="550" />
* classic pub/sub patterns with no data serialization overhead * classic pub/sub patterns with no data serialization overhead
* based on [`pchannel`] which allows to mix different kinds of data and apply * based on [`policy_channel`] which allows to mix different kinds of data and
additional policies if required apply additional policies if required
* a fully passive model with no "server" thread. * a fully passive model with no "server" thread.
## pdeque and pchannel ## pdeque and policy_channel
A policy-based deque [`rtsc::pdeque::Deque`] is a component to build policy-based A policy-based deque [`rtsc::pdeque::Deque`] is a component to build policy-based
channels. channels.
[`pchannel`] is a channel module, based on the policy-based deque. [`policy_channel`] is a channel module, based on the policy-based deque.
Data policies supported: Data policies supported:
...@@ -88,11 +88,11 @@ Additionally, components support ordering by data priority and automatically ...@@ -88,11 +88,11 @@ Additionally, components support ordering by data priority and automatically
drop expired data if the data type has got an expiration marker method drop expired data if the data type has got an expiration marker method
implemented. implemented.
[`pchannel`] is a real-time safe channel, mean it may be not so fast as popular [`policy_channel`] is a real-time safe channel, mean it may be not so fast as
channel implementations (it may be even slower than channels provided by popular channel implementations (it may be even slower than channels provided
[`std::sync::mpsc`]). But it is **completely safe for real-time applications**, by [`std::sync::mpsc`]). But it is **completely safe for real-time
mean there are no spin loops, data is always delivered with minimal latency and applications**, mean there are no spin loops, data is always delivered with
threads do not block each other. minimal latency and threads do not block each other.
## Real-time ## Real-time
...@@ -159,18 +159,18 @@ Linux machines only. ...@@ -159,18 +159,18 @@ Linux machines only.
## Migration from 0.3.x ## Migration from 0.3.x
* [`roboplc::pchannel`] and [`roboplc::pchannel_async`] have been renamed to * `pchannel` and `pchannel_async` have been renamed to [`policy_channel`] and
[`roboplc::policy_channel`] and [`roboplc::policy_channel_async`] [`policy_channel_async`] respectively.
respectively.
* By default, the crate uses `parking_lot` for locking. To switch to more safe * By default, the crate uses
real-time locking, disable the crate default features and enable either [parking_lot](https://crates.io/crates/parking_lot) for locking. To switch to
`locking-rt` or `locking-rt-safe`. THIS IS IMPORTANT FOR REAL-TIME more safe real-time locking, disable the crate default features and enable
APPLICATIONS AND MUST BE ENABLED MANUALLY. either `locking-rt` or `locking-rt-safe`. **This is important for real-time
applications and must be enabled manually**.
* As [RTSC](https://crates.io/crates/rtsc) components are lock-agnostic, which * As [RTSC](https://crates.io/crates/rtsc) components are lock-agnostic, which
requires to specify generic locking types, the modules [`roboplc::channel`], requires to specify generic locking types, the modules [`channel`],
[`roboplc::policy_channel`], [`roboplc::buf`] and [`roboplc::semaphore`] are [`policy_channel`], [`buf`] and [`semaphore`] are now wrappers around RTSC
now wrappers around RTSC modules with the chosen locking policy. modules with the chosen locking policy.
* [`roboplc::hub_async`] now requires `async` feature to be enabled. * [`hub_async`] now requires `async` feature to be enabled.
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论