rust-libp2p

mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-06-30 02:01:35 +00:00

Files

Sumit c52a2fc3af feat(swarm): allow configuration to idle connection timeout

Previously, a connection would be shut down immediately as soon as its `ConnectionHandler` reports `KeepAlive::No`. As we have gained experience with libp2p, it turned out that this isn't ideal.

For one, tests often need to keep connections alive longer than the configured protocols require. Plus, some usecases require connections to be kept alive in general.

Both of these needs are currently served by the `keep_alive::Behaviour`. That one does essentially nothing other than statically returning `KeepAlive::Yes` from its `ConnectionHandler`.

It makes much more sense to deprecate `keep_alive::Behaviour` and instead allow users to globally configure an `idle_conncetion_timeout` on the `Swarm`. This timeout comes into effect once a `ConnectionHandler` reports `KeepAlive::No`. To start with, this timeout is 0. Together with https://github.com/libp2p/rust-libp2p/issues/3844, this will allow us to move towards a much more aggressive closing of idle connections, together with a more ergonomic way of opting out of this behaviour.

Fixes #4121.

Pull-Request: #4161.

2023-09-19 22:32:29 +00:00

src

feat(swarm): allow configuration to idle connection timeout

2023-09-19 22:32:29 +00:00

Cargo.toml

feat(swarm): log local peer id on swarm creation

2023-09-12 10:09:27 +00:00

README.md

docs(examples): add a README to each example

2023-06-01 07:40:22 +00:00

README.md

Description

The ping example showcases how to create a network of nodes that establish connections, negotiate the ping protocol, and ping each other.

Usage

To run the example, follow these steps:

In a first terminal window, run the following command:
```
cargo run
```
This command starts a node and prints the PeerId and the listening addresses, such as Listening on "/ip4/0.0.0.0/tcp/24915".
In a second terminal window, start a new instance of the example with the following command:
```
cargo run -- /ip4/127.0.0.1/tcp/24915
```
Replace /ip4/127.0.0.1/tcp/24915 with the listen address of the first node obtained from the first terminal window.
The two nodes will establish a connection, negotiate the ping protocol, and begin pinging each other.

Conclusion

The ping example demonstrates the basic usage of libp2p to create a simple p2p network and implement a ping protocol. By running multiple nodes and observing the ping behavior, users can gain insights into how libp2p facilitates communication and interaction between peers.