Aeronet

https://docs.rs/aeronet/0.19.1/
Admin
Aeronet is a set of Bevy-native networking crates providing robust and rock-solid data transfer...
Tokens:2,245
Snippets:47
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Run move_box_server example

Source: https://docs.rs/aeronet

Execute the server binary for the move_box example, demonstrating bevy_replicon integration.

```bash
cargo run --bin move_box_server
```

--------------------------------

### Run move_box_client example

Source: https://docs.rs/aeronet

Execute the client binary for the move_box example, demonstrating bevy_replicon integration.

```bash
cargo run --bin move_box_client
```

--------------------------------

### Run aeronet_channel example

Source: https://docs.rs/aeronet

Execute the example for in-memory MPSC channels.

```bash
cargo run --example channel
```

--------------------------------

### Run aeronet_steam client example

Source: https://docs.rs/aeronet

Execute the Steam client example. Requires the 'client' feature flag.

```bash
cargo run --example steam_client -F client
```

--------------------------------

### Run aeronet_websocket server example

Source: https://docs.rs/aeronet

Execute the WebSocket server example. Requires the 'server' feature flag.

```bash
cargo run --example websocket_server -F server
```

--------------------------------

### Run aeronet_webtransport server example

Source: https://docs.rs/aeronet

Execute the WebTransport server example. Requires the 'server' feature flag.

```bash
cargo run --example webtransport_server -F server
```

--------------------------------

### Run aeronet_websocket client example

Source: https://docs.rs/aeronet

Execute the WebSocket client example. Requires the 'client' feature flag.

```bash
cargo run --example websocket_client -F client
```

--------------------------------

### Run aeronet_webtransport client example

Source: https://docs.rs/aeronet

Execute the WebTransport client example. Requires the 'client' and 'dangerous-configuration' feature flags.

```bash
cargo run --example webtransport_client -F client,dangerous-configuration
```

--------------------------------

### Run aeronet_steam server example (Steam peers)

Source: https://docs.rs/aeronet

Execute the Steam server example, listening for Steam peers. Requires the 'server' feature flag and '--peer' argument.

```bash
cargo run --example steam_server -F server -- peer
```

--------------------------------

### Run aeronet_steam server example (socket address)

Source: https://docs.rs/aeronet

Execute the Steam server example, listening on a socket address. Requires the 'server' feature flag and '--addr' argument.

```bash
cargo run --example steam_server -F server -- addr
```

--------------------------------

### Run aeronet_websocket client example for WASM

Source: https://docs.rs/aeronet

Execute the WebSocket client example for WASM. Requires wasm-server-runner and the 'client' feature flag.

```bash
cargo install wasm-server-runner
cargo run --example websocket_client -F client --target wasm32-unknown-unknown
```

--------------------------------

### Run aeronet_webtransport client example for WASM

Source: https://docs.rs/aeronet

Execute the WebTransport client example for WASM. Requires wasm-server-runner and the 'client' feature flag.

```bash
cargo install wasm-server-runner
cargo run --example webtransport_client -F client --target wasm32-unknown-unknown
```

--------------------------------

### Modules

Source: https://docs.rs/aeronet

Overview of the project's modules.

```APIDOC
## Modules

_docs
    Long-form documentation.

```

--------------------------------

### Testing Guidelines

Source: https://docs.rs/aeronet

Information on Continuous Integration (CI) checks and quality standards for pull requests.

```APIDOC
## Testing

When submitting a pull request, make sure that all continuous integration (CI) checks pass. CI is intentionally set to be as strict as reasonably possible, to keep the quality of code in `main` high.
```

--------------------------------

### Version Compatibility

Source: https://docs.rs/aeronet

A table showing the compatibility between Bevy versions and Aeronet versions.

```APIDOC
## Versions

`bevy`| `aeronet`  
---|---
`0.18`| `0.19.0` - `0.20.0`  
`0.17`| `0.17.0` - `0.18.0`  
`0.16`| `0.13.0` - `0.16.0`  
`0.15`| `0.11.0` - `0.12.0`  
`0.14`| `0.9.0` - `0.10.0`
```

--------------------------------

### Run Fuzz Tests for Aeronet Transport

Source: https://docs.rs/aeronet

Navigate to the aeronet_transport crate directory and execute fuzz tests using cargo +nightly fuzz run. Replace <fuzz target> with the specific fuzz target name.

```bash
cd crates/aeronet_transport
cargo +nightly fuzz run <fuzz target>
```

--------------------------------

### Structs

Source: https://docs.rs/aeronet

Information about the AeronetPlugins struct.

```APIDOC
## Structs

AeronetPlugins
    Adds the default networking plugins.
```

--------------------------------

### Add Packet Loss using tc (Linux)

Source: https://docs.rs/aeronet

Use the 'tc' command on Linux to introduce packet loss on the loopback interface. This command emulates unreliable network conditions.

```bash
sudo tc qdisc add dev lo root netem loss 50%
```

--------------------------------

### Feature Flags

Source: https://docs.rs/aeronet

List of available feature flags and their descriptions.

```APIDOC
### Feature flags
  * **`document-features`**— Enable this when generating docs.
  * **`std`**_(enabled by default)_ — Enables standard library support.
  * **`visualizer`**— Enables`aeronet_transport/visualizer`.
```

--------------------------------

### Add Network Delay with Jitter using tc (Linux)

Source: https://docs.rs/aeronet

Use the 'tc' command on Linux to add network delay with a distribution of jitter to the loopback interface. This command emulates variable network latency.

```bash
sudo tc qdisc add dev lo root netem delay 200ms 50ms distribution normal
```

--------------------------------

### Add Network Delay using tc (Linux)

Source: https://docs.rs/aeronet

Use the 'tc' command on Linux to add network delay to the loopback interface. This command emulates network latency for testing purposes.

```bash
sudo tc qdisc add dev lo root netem delay 250ms
```

--------------------------------

### Re-exporting Aeronet modules

Source: https://docs.rs/aeronet

Exposes the io and transport modules for easier access.

```rust
pub use aeronet_io as io;
```

```rust
pub use aeronet_transport as transport;
```

--------------------------------

### Re-exports

Source: https://docs.rs/aeronet

Details on modules that are re-exported for easier access.

```APIDOC
## Re-exports

`pub use aeronet_io as io;`

`pub use aeronet_transport as transport;`
```

--------------------------------

### Delete Network Configuration using tc (Linux)

Source: https://docs.rs/aeronet

Use the 'tc' command on Linux to remove all network queuing disciplines applied to the loopback interface. This command resets network conditions.

```bash
sudo tc qdisc delete dev lo root
```
Tokens:
Raw