Crate hopr_transport_session

Expand description

Session object providing the session functionality over the HOPR transport

The session proxies the user interactions with the transport to hide the advanced interactions and functionality.

The SessionManager allows for automatic management of sessions via the Start protocol.

This crate implements RFC-0007.

Modules§

ByteCapabilities: Wrapper for Capabilities that makes conversion to/from u8 possible.
IncomingSession: Wrapper for incoming Session along with other information extracted from the Start protocol during the session establishment.
Session: Represents the Session protocol socket over HOPR.
SessionClientConfig: Configuration for the session.
SessionId: Unique ID of a specific Session in a certain direction.
SessionManager: Manages lifecycles of Sessions.
SessionManagerConfig: Configuration for the SessionManager.
SurbBalancerConfig: Configuration for the SurbBalancer.
ValidatedPath: Represents [NonEmptyPath] that has been resolved and validated.

Capability: Individual capabilities of a Session.
DestinationRouting: Routing information containing forward or return routing options.
DispatchResult: Indicates the result of processing a message.
IpOrHost: Implements a host name with port. This could be either a DNS name with port or an IP address with port represented by std::net::SocketAddr.
IpProtocol: Lists some of the IP protocols.
ResolvedTransportRouting: Contains the resolved routing information for the packet.
RoutingOptions: Represents routing options in a mixnet with a maximum number of hops.
SealedHost: Contains optionally encrypted IpOrHost.
SessionTarget: Defines what should happen with the data at the recipient where the data from the established session are supposed to be forwarded to some target.
SurbMatcher: Allows finding saved SURBs based on different criteria.

MIN_BALANCER_SAMPLING_INTERVAL: Smallest possible interval for balancer sampling.
MIN_SURB_BUFFER_DURATION: Minimum time the SURB buffer must endure if no SURBs are being produced.
SESSION_MTU: Number of bytes that can be sent in a single Session protocol payload.
SURB_SIZE: Size of the HOPR SURB in bytes.

transfer_session: Convenience function to copy data in both directions between a Session and arbitrary async IO stream. This function is only available with Tokio and will panic with other runtimes.

Capabilities: Set of Session capabilities.
ServiceId: Describes a node service target. These are specialized SessionTargets that are local to the Exit node and have different purposes, such as Cover Traffic.