Expand description
§Overview
correspondent is a high-level networking library which facilitates a non-hierarchical network of peers to send messages.
correspondent uses DNS-SD to discover peers on the local network.
correspondent uses Quinn, an implementation of the QUIC protocol, as a transport layer. These docs may assume some familiarity with Quinn’s API.
See examples/chat.rs for a simple example application.
§Supported Services
| Operating System | Service |
|---|---|
| Windows 10 | Dnsapi.dll |
| Linux | Avahi (via dbus) |
Structs§
- Certificate
Response - Type to return from
CertificateSigner::sign_certificate. - Events
- Stream of events happening on the correspondent Socket
- PeerId
- Unique identifier for a connection.
- Peer
NotConnected - Error returned by Socket::connect if an error happens when connecting to a peer.
- Socket
- A socket represents an endpoint and other state correspondent uses to connect to peers.
- Socket
Builder - Options for configuring the creation of a socket.
- Socket
Certificate - Required information correspondent uses to verify the identity of peers
Enums§
- Event
- A network event on the correspondent Socket
Traits§
- Certificate
Signer - Used by
SocketBuilder::with_new_certificateto sign the newly generated certificate. - Identity
Canonicalizer - A correspondent socket must be created with a specific identity.