https://github.com/williamvenner/viaduct
A duplex communication channel between a parent and child process, using unnamed pipes
https://github.com/williamvenner/viaduct
communication duplex ipc multiprocess multiprocessing pipe pipes rust
Last synced: about 1 month ago
JSON representation
A duplex communication channel between a parent and child process, using unnamed pipes
- Host: GitHub
- URL: https://github.com/williamvenner/viaduct
- Owner: WilliamVenner
- License: apache-2.0
- Created: 2022-08-05T21:44:39.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-08-13T21:13:16.000Z (about 3 years ago)
- Last Synced: 2024-10-11T11:33:27.255Z (about 1 year ago)
- Topics: communication, duplex, ipc, multiprocess, multiprocessing, pipe, pipes, rust
- Language: Rust
- Homepage: https://docs.rs/viaduct
- Size: 113 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
[](https://crates.io/crates/viaduct)
[](https://docs.rs/viaduct/)
[](https://github.com/WilliamVenner/viaduct/blob/master/LICENSE)
Viaduct is a library for establishing a duplex communication channel between a parent and child process, using unnamed pipes.
# Example
## Shared library
```rust
#[derive(Serialize, Deserialize)]
pub enum ExampleRpc {
Cow,
Pig,
Horse
}
#[derive(Serialize, Deserialize)]
pub enum ExampleRequest {
DoAFrontflip,
DoABackflip,
}
#[derive(Serialize, Deserialize, PartialEq, Eq)]
pub struct FrontflipError;
#[derive(Serialize, Deserialize, PartialEq, Eq)]
pub struct BackflipError;
```
## Parent process
```rust
let child = std::process::Command::new("child.exe");
let ((tx, rx), mut child) = ViaductParent::new(child).unwrap().build().unwrap();
std::thread::spawn(move || {
rx.run(
|rpc: ExampleRpc| match rpc {
ExampleRpc::Cow => println!("Moo"),
ExampleRpc::Pig => println!("Oink"),
ExampleRpc::Horse => println!("Neigh"),
},
|request: ExampleRequest, tx| match request {
ExampleRequest::DoAFrontflip => {
println!("Doing a frontflip!");
tx.respond(Ok::<_, FrontflipError>(())).unwrap();
},
ExampleRequest::DoABackflip => {
println!("Doing a backflip!");
tx.respond(Ok::<_, BackflipError>(())).unwrap();
},
},
).unwrap();
});
tx.rpc(ExampleRpc::Cow).unwrap();
tx.rpc(ExampleRpc::Pig).unwrap();
tx.rpc(ExampleRpc::Horse).unwrap();
let response: Result<(), FrontflipError> = tx.request(ExampleRequest::DoAFrontflip).unwrap();
assert_eq!(response, Ok(()));
```
## Child process
```rust
let (tx, rx) = unsafe { ViaductChild::new() }.unwrap();
std::thread::spawn(move || {
rx.run(
|rpc: ExampleRpc| match rpc {
ExampleRpc::Cow => println!("Moo"),
ExampleRpc::Pig => println!("Oink"),
ExampleRpc::Horse => println!("Neigh"),
},
|request: ExampleRequest, tx| match request {
ExampleRequest::DoAFrontflip => {
println!("Doing a frontflip!");
tx.respond(Ok::<_, FrontflipError>(())).unwrap();
},
ExampleRequest::DoABackflip => {
println!("Doing a backflip!");
tx.respond(Ok::<_, BackflipError>(())).unwrap();
},
},
).unwrap();
});
tx.rpc(ExampleRpc::Horse).unwrap();
tx.rpc(ExampleRpc::Pig).unwrap();
tx.rpc(ExampleRpc::Cow).unwrap();
let response: Result<(), BackflipError> = tx.request(ExampleRequest::DoABackflip).unwrap();
assert_eq!(response, Ok(()));
```
# Use Cases
Viaduct was designed for separating user interface from application logic in a cross-platform manner.
For example, an application may want to run a GUI in a separate process from the application logic, for modularity or performance reasons.
Viaduct allows for applications like this to communicate between these processes in a natural way, without having to manually implement IPC machinery & synchronization.
# Usage
Check out [the documentation](https://docs.rs/viaduct/) for usage information.
# License
Viaduct is licensed under the MIT license or the Apache License v2.0, at your choice.