README.md

   1 # connect-rs
   2
   3 [![Crates.io][crates-badge]][crates-url]
   4 [![Docs.rs][docs-badge]][docs-url]
   5
   6 [crates-badge]: https://img.shields.io/crates/v/connect.svg
   7 [crates-url]: https://crates.io/crates/connect
   8 [docs-badge]: https://docs.rs/connect/badge.svg
   9 [docs-url]: https://docs.rs/connect
  10
  11 This Rust crate provides a simple, brokerless message-queue abstraction over asynchronous network
  12 streams.
  13
  14 ## Examples
  15 Please use the [example programs](https://github.com/sachanganesh/connect-rs/tree/main/examples)
  16 provided to help understand crate usage.
  17
  18 ## Why?
  19 When building networked applications, developers shouldn't have to focus on repeatedly solving
  20 the problem of reliable, fault-tolerant message delivery over byte-streams. By using a message
  21 queue abstraction, crate users can focus on core application logic and leave the low-level
  22 networking and message-queue guarantees to the abstraction.
  23
  24 ## Feature Status
  25
  26 | Feature                                               | Status        |
  27 |-----------------------------------------------------  |--------       |
  28 | [TCP Client](examples/tcp-client)                         |    ✓    |
  29 | [TCP Server](examples/tcp-echo-server)                    |    ✓    |
  30 | [TLS Client](examples/tls-client)                         |    ✓    |
  31 | [TLS Server](examples/tls-echo-server)                    |    ✓    |
  32 | SCTP Client                                           |               |
  33 | SCTP Server                                           |               |
  34 | DTLS-SCTP Client                                      |               |
  35 | DTLS-SCTP Server                                      |               |