mirror of
https://github.com/fafhrd91/actix-net
synced 2025-03-20 16:05:18 +01:00
update readme
This commit is contained in:
parent
93865de848
commit
296294061f
66
README.md
66
README.md
@ -1,9 +1,12 @@
|
|||||||
# Actix net [](https://codecov.io/gh/actix/actix-net) [](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.
|
||||||
|
|
||||||
|

|
||||||
|
[](https://codecov.io/gh/actix/actix-net)
|
||||||
|
[](https://discord.gg/NWpN5mmg3x)
|
||||||
|
|
||||||
## Build statuses
|
## Build statuses
|
||||||
|
|
||||||
| Platform | Build Status |
|
| Platform | Build Status |
|
||||||
| ---------------- | ------------ |
|
| ---------------- | ------------ |
|
||||||
| Linux | [](https://github.com/actix/actix-net/actions?query=workflow%3A"CI+(Linux)") |
|
| Linux | [](https://github.com/actix/actix-net/actions?query=workflow%3A"CI+(Linux)") |
|
||||||
@ -11,59 +14,13 @@ Actix net - framework for composable network services
|
|||||||
| Windows | [](https://github.com/actix/actix-net/actions?query=workflow%3A"CI+(Windows)") |
|
| Windows | [](https://github.com/actix/actix-net/actions?query=workflow%3A"CI+(Windows)") |
|
||||||
| Windows (MinGW) | [](https://github.com/actix/actix-net/actions?query=workflow%3A"CI+(Windows-mingw)") |
|
| Windows (MinGW) | [](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
|
## Example
|
||||||
|
See `actix-server/examples` and `actix-tls/examples` for some basic examples.
|
||||||
|
|
||||||
```rust
|
### MSRV
|
||||||
fn main() -> io::Result<()> {
|
This repo's Minimum Supported Rust Version (MSRV) is 1.46.0.
|
||||||
// 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<TcpStream>
|
|
||||||
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()
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under either of
|
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))
|
* 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
|
## Code of Conduct
|
||||||
|
|
||||||
Contribution to the actix-net crate is organized under the terms of the
|
Contribution to the actix-net repo is organized under the terms of the Contributor Covenant.
|
||||||
Contributor Covenant, the maintainer of actix-net, @fafhrd91, promises to
|
The Actix team promises to intervene to uphold that code of conduct.
|
||||||
intervene to uphold that code of conduct.
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user