77fbe57819
... and update some outdated stuff in the README while we're at it. Change-Id: Ib3a12596bd1ba61e91ac6e1d37106b616da3030d Reviewed-on: https://cl.tvl.fyi/c/depot/+/5232 Reviewed-by: tazjin <tazjin@tvl.su> Tested-by: BuildkiteCI
44 lines
1.3 KiB
Markdown
44 lines
1.3 KiB
Markdown
posix_mq
|
|
========
|
|
|
|
[](https://crates.io/crates/posix_mq)
|
|
|
|
This is a simple, relatively high-level library for the POSIX [message queue API][]. It wraps the lower-level API in a
|
|
simpler interface with more robust error handling.
|
|
|
|
Check out this project's [sister library][] in Kotlin.
|
|
|
|
Usage example:
|
|
|
|
```rust
|
|
// Values that need to undergo validation are wrapped in safe types:
|
|
let name = Name::new("/test-queue").unwrap();
|
|
|
|
// Queue creation with system defaults is simple:
|
|
let queue = Queue::open_or_create(name).expect("Opening queue failed");
|
|
|
|
// Sending a message:
|
|
let message = Message {
|
|
data: "test-message".as_bytes().to_vec(),
|
|
priority: 0,
|
|
};
|
|
queue.send(&message).expect("message sending failed");
|
|
|
|
// ... and receiving it!
|
|
let result = queue.receive().expect("message receiving failed");
|
|
```
|
|
|
|
## Development
|
|
|
|
Development happens in the [TVL
|
|
monorepo](https://cs.tvl.fyi/depot/-/tree/ops/posix_mq.rs).
|
|
|
|
Starting from version `3771.0.0`, the version numbers correspond to
|
|
_revisions_ of the TVL repository, available as git refs (e.g.
|
|
`refs/r/3771`).
|
|
|
|
See the TVL documentation for more information about how to contribute
|
|
to the codebase.
|
|
|
|
[message queue API]: https://linux.die.net/man/7/mq_overview
|
|
[sister library]: https://github.com/aprilabank/posix_mq.kt
|