From 296294061fcf89d3fab6f79bf24fc95d2609cbab Mon Sep 17 00:00:00 2001 From: Rob Ede Date: Thu, 31 Dec 2020 02:52:55 +0000 Subject: [PATCH] update readme --- README.md | 66 ++++++++++--------------------------------------------- 1 file changed, 11 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 1f7f063a..95500e43 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ -# Actix net [![codecov](https://codecov.io/gh/actix/actix-net/branch/master/graph/badge.svg)](https://codecov.io/gh/actix/actix-net) [![Join the chat at https://gitter.im/actix/actix](https://badges.gitter.im/actix/actix.svg)](https://gitter.im/actix/actix?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +# Actix Net -Actix net - framework for composable network services +> A collection of lower-level libraries for composable network services. + +![Apache 2.0 or MIT licensed](https://img.shields.io/crates/l/actix-server) +[![codecov](https://codecov.io/gh/actix/actix-net/branch/master/graph/badge.svg)](https://codecov.io/gh/actix/actix-net) +[![Chat on Discord](https://img.shields.io/discord/771444961383153695?label=chat&logo=discord)](https://discord.gg/NWpN5mmg3x) ## Build statuses - | Platform | Build Status | | ---------------- | ------------ | | Linux | [![build status](https://github.com/actix/actix-net/workflows/CI%20%28Linux%29/badge.svg?branch=master&event=push)](https://github.com/actix/actix-net/actions?query=workflow%3A"CI+(Linux)") | @@ -11,59 +14,13 @@ Actix net - framework for composable network services | Windows | [![build status](https://github.com/actix/actix-net/workflows/CI%20%28Windows%29/badge.svg?branch=master&event=push)](https://github.com/actix/actix-net/actions?query=workflow%3A"CI+(Windows)") | | Windows (MinGW) | [![build status](https://github.com/actix/actix-net/workflows/CI%20%28Windows-mingw%29/badge.svg?branch=master&event=push)](https://github.com/actix/actix-net/actions?query=workflow%3A"CI+(Windows-mingw)") | -## Documentation & community resources - -* [Chat on Gitter](https://gitter.im/actix/actix) -* Minimum supported Rust version: 1.46 or later - ## Example +See `actix-server/examples` and `actix-tls/examples` for some basic examples. -```rust -fn main() -> io::Result<()> { - // load ssl keys - let mut builder = SslAcceptor::mozilla_intermediate(SslMethod::tls()).unwrap(); - builder.set_private_key_file("./examples/key.pem", SslFiletype::PEM).unwrap(); - builder.set_certificate_chain_file("./examples/cert.pem").unwrap(); - let acceptor = builder.build(); - - let num = Arc::new(AtomicUsize::new(0)); - - // bind socket address and start workers. By default server uses number of - // available logical cpu as threads count. actix net start separate - // instances of service pipeline in each worker. - Server::build() - .bind( - // configure service pipeline - "basic", "0.0.0.0:8443", - move || { - let num = num.clone(); - let acceptor = acceptor.clone(); - - // construct transformation pipeline - pipeline( - // service for converting incoming TcpStream to a SslStream - fn_service(move |stream: actix_rt::net::TcpStream| async move { - SslAcceptorExt::accept_async(&acceptor, stream.into_parts().0).await - .map_err(|e| println!("Openssl error: {}", e)) - })) - // .and_then() combinator chains result of previos service call to argument - /// for next service calll. in this case, on success we chain - /// ssl stream to the `logger` service. - .and_then(fn_service(logger)) - // Next service counts number of connections - .and_then(move |_| { - let num = num.fetch_add(1, Ordering::Relaxed); - println!("got ssl connection {:?}", num); - future::ok(()) - }) - }, - )? - .run() -} -``` +### MSRV +This repo's Minimum Supported Rust Version (MSRV) is 1.46.0. ## License - This project is licensed under either of * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)) @@ -73,6 +30,5 @@ at your option. ## Code of Conduct -Contribution to the actix-net crate is organized under the terms of the -Contributor Covenant, the maintainer of actix-net, @fafhrd91, promises to -intervene to uphold that code of conduct. +Contribution to the actix-net repo is organized under the terms of the Contributor Covenant. +The Actix team promises to intervene to uphold that code of conduct.