38 releases (breaking)

0.27.0 Aug 9, 2024
0.26.3 Jun 4, 2024
0.26.2 May 1, 2024
0.26.1 Dec 9, 2023
0.1.1 Jul 13, 2020

#1822 in Network programming

Download history 45406/week @ 2024-07-30 56167/week @ 2024-08-06 65871/week @ 2024-08-13 52835/week @ 2024-08-20 63743/week @ 2024-08-27 69693/week @ 2024-09-03 60419/week @ 2024-09-10 60866/week @ 2024-09-17 62888/week @ 2024-09-24 67736/week @ 2024-10-01 62274/week @ 2024-10-08 65302/week @ 2024-10-15 64809/week @ 2024-10-22 56583/week @ 2024-10-29 63894/week @ 2024-11-05 41332/week @ 2024-11-12

241,600 downloads per month
Used in 216 crates (6 directly)

MIT license

1MB
16K SLoC

Generic request/response protocols.

General Usage

The Behaviour struct is a NetworkBehaviour that implements a generic request/response protocol or protocol family, whereby each request is sent over a new substream on a connection. Behaviour is generic over the actual messages being sent, which are defined in terms of a Codec. Creating a request/response protocol thus amounts to providing an implementation of this trait which can then be given to Behaviour::with_codec. Further configuration options are available via the Config.

Requests are sent using Behaviour::send_request and the responses received as Message::Response via Event::Message.

Responses are sent using Behaviour::send_response upon receiving a Message::Request via Event::Message.

Predefined codecs

In case your message types implement serde::Serialize and serde::Deserialize, you can use two predefined behaviours:

Protocol Families

A single Behaviour instance can be used with an entire protocol family that share the same request and response types. For that purpose, Codec::Protocol is typically instantiated with a sum type.

Limited Protocol Support

It is possible to only support inbound or outbound requests for a particular protocol. This is achieved by instantiating Behaviour with protocols using ProtocolSupport::Inbound or ProtocolSupport::Outbound. Any subset of protocols of a protocol family can be configured in this way. Such protocols will not be advertised during inbound respectively outbound protocol negotiation on the substreams.

Dependencies

~8–15MB
~184K SLoC