@@ -4,29 +4,29 @@ Management Component Transport Protocol (MCTP) support
4
4
This crate provides a set of generic types and traits for MCTP support in Rust.
5
5
It provides:
6
6
7
- * a few base types (` Eid ` , ` Tag ` , ` MsgType ` ) to match MCTP protocol
8
- definitions,
7
+ * A few base types (` Eid ` , ` Tag ` , ` MsgType ` , ` MsgIC ` ) to match MCTP protocol
8
+ definitions.
9
9
10
- * ` Comm ` and ` Listener ` traits, to abstract communication implementation details; and
10
+ * Traits to abstract communication implementation details. These are
11
+ ` ReqChannel ` , ` Listener ` , and ` RespChannel ` . Async equivalents are
12
+ ` AsyncReqChannel ` , ` AsyncListener ` , and ` AsyncRespChannel ` .
11
13
12
- * some support types (` MctpError ` , ` Result ` ) for the traits.
14
+ * Some support types (` mctp::Error ` , ` mctp:: Result` ) for the traits.
13
15
14
16
There are two typical interfaces to the crate:
15
17
16
- * Transport implementations: code that provides implementations of the ` Comm `
17
- and ` Listner ` traits. These interface to hardware (either directly, in
18
+ * Transport implementations: code that provides implementations of the traits.
19
+ These interface to hardware (either directly, in some
18
20
embedded environments, or through an operating system interface), and
19
- provide the base message send/receive functions
21
+ provide the base message send/receive functions.
20
22
21
- * Application implementations: code that uses makes use of the ` Comm ` trait ,
23
+ * Application implementations: code that uses makes use of the traits ,
22
24
in order to provide some MCTP-based functionality.
23
25
24
26
API status
25
27
----------
26
28
27
- While this is fairly early prototype code, there are a couple of uses "in the
28
- field" to help validate the API conventions. While we don't expect much API
29
- breakage in future, there may be reworks coming.
29
+ We don't expect much API breakage in future, though changes may be made where
30
+ it makes sense.
30
31
31
32
Any API changes will be appropriately versioned.
32
-
0 commit comments