Expand description
§tor-rpc-connect
Functionality related to RPC connect points.
§Overview
A “connect point” is Toml string that describes how an RPC client should connect to an RPC server; and how an RPC server should wait for client connections.
This crate implements parsing for the format, and facilities to either connect to an RPC server or listen as an RPC server given a connect point.
License: MIT OR Apache-2.0
Modules§
- auth
- Representations for types of required RPC connections.
- client
rpc-client
- Client operations for working with connect points.
- connpt 🔒
- Connect point types, and the code to parse them and resolve them.
- load
- Functionality for reading a connect point from a file, and verifying that its permissions are correct.
- server
rpc-server
- Server operations for working with connect points.
Structs§
- Parsed
Connect Point - A connect point, as deserialized from TOML.
- Resolved
Connect Point - A connect point, with all paths resolved.
Enums§
- Client
Error Action - An action that an RPC client should take when a connect point fails.
- Connect
Error - A failure to connect or bind to a
ResolvedConnectPoint
. - Resolve
Error - A failure from
ParsedConnectPoint::resolve()
.
Constants§
- SYSTEM_
DEFAULT_ CONNECT_ POINT - Default connect point for a system-wide Arti instance.
- USER_
DEFAULT_ CONNECT_ POINT - Default connect point for a user-owned Arti instance.
Traits§
- HasClient
Error Action - An error that has a
ClientErrorAction
.
Functions§
- fs_
error_ 🔒action - Return the ClientErrorAction for an IO error encountered while accessing the filesystem.
- net_
error_ 🔒action - Return the ClientErrorAction for an IO error encountered while opening a socket.
- socket_
parent_ 🔒path rpc-client
orrpc-server
- Given a
general::SocketAddr
, try to return the path of its parent directory (if any).