You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/examples/channel.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@
3
3
The `Channel` trait in our MPC engine provides a flexible and extensible abstraction for message-passing between parties. It allows communication to be implemented in various ways, enabling users to choose between platform-specific implementations. Polytune is deliberately communication-agnostic, while remaining quite flexible, offering the following features:
4
4
5
5
-**Customizable Transport**: Implement the `Channel` trait using any transport mechanism — HTTP, WebSockets, in-memory queues, or custom networking protocols.
6
-
-**Serialization-Aware**: The trait ensures that messages can be efficiently serialized and chunked when necessary, making it ideal for large payloads.
6
+
-**Serialization-Aware**: The trait ensures that messages can be efficiently serialized.
7
7
8
8
We provide example implementations for:
9
9
@@ -37,13 +37,13 @@ trait Channel {
37
37
&self,
38
38
p:usize,
39
39
msg:Vec<u8>,
40
-
info:SendInfo,
40
+
phase:&str,
41
41
) ->Result<(), Self::SendError>;
42
42
43
43
asyncfnrecv_bytes_from(
44
44
&self,
45
45
p:usize,
46
-
info:RecvInfo,
46
+
phase:&str,
47
47
) ->Result<Vec<u8>, Self::RecvError>;
48
48
}
49
49
```
@@ -53,7 +53,7 @@ trait Channel {
53
53
1.**Channel Parameters**:
54
54
55
55
-`p`: Index of the target party for send/receive
56
-
-`info`: Various information useful for logging
56
+
-`phase`: Phase of the protocol where the message is sent
57
57
-`msg`: Message sent to the target party (only in `send_bytes_to`)
0 commit comments