Module radicle::node

Re-exports

• pub use address::KnownAddress;
• pub use config::Config;
• pub use db::Database;
• pub use events::Event;
• pub use events::Events;
• pub use seed::SyncedAt;
• pub use timestamp::Timestamp;

Modules

• address
• config
• db
  Note on database migrations
• events
  Events for upload-pack processes.
• notifications
• policy
• refs
• routing
• seed
• timestamp

Structs

• Address
  Peer public protocol address.
• Alias
  Node alias.
• AnnounceResult
  Announcement result returned by Node::announce.
• ConnectOptions
  Options passed to the “connect” node command.
• Features
  Advertized node features. Signals what services the node supports.
• FetchResults
  Holds multiple fetch results.
• LineIter
  Iterator of results T when passing a Command to Node::call.
• Node
  Node controller.
• PeerAddr
• Penalty
  Node connection penalty. Nodes with a high penalty are deprioritized as peers.
• Seed
  A seed for some repository, with metadata about its status.
• Seeds
  Represents a set of seeds with associated metadata. Uses an RNG underneath, so every iteration returns a different ordering.
• Session
  An established network connection with a peer.
• Success
  A success response.

Enums

• AliasError
• AnnounceEvent
  A sync event, emitted by Node::announce.
• Command
  Command name.
• CommandResult
  Result of a command, on the node control socket.
• ConnectResult
• Error
  Error returned by Handle functions.
• FetchResult
• HostName
  A host name covers multiple types which are not necessarily resolved by an OS and may require additional name resolvers (like via SOCKS5 etc). The type doesn’t provide an information about the resolver; for that use super::ProxiedHost.
• Link
  Connection link direction.
• PingState
• Severity
  Severity of a peer misbehavior or a connection problem.
• State
• SyncStatus
  Repository sync status for our own refs.

Constants

• DEFAULT_PORT
  Default radicle protocol port.
• DEFAULT_SOCKET_NAME
  Default name for control socket file.
• DEFAULT_SUBSCRIBE_TIMEOUT
  Default timeout when waiting for an event to be received on the Handle::subscribe channel.
• DEFAULT_TIMEOUT
  Default timeout when waiting for the node to respond with data.
• MAX_ALIAS_LENGTH
  Maximum length in bytes of a node alias.
• NODE_ANNOUNCEMENT_FILE
  Filename of last node announcement, when running in debug mode.
• NODE_DB_FILE
  Filename of node database under the node directory.
• NOTIFICATIONS_DB_FILE
  Filename of notifications database under the node directory.
• PENALTY_BAN_THRESHOLD
  Penalty threshold at which point we ban this node.
• PENALTY_CONNECT_THRESHOLD
  Penalty threshold at which point we avoid connecting to this node.
• POLICIES_DB_FILE
  Filename of policies database under the node directory.

Traits

• AliasStore
  A trait for different sources which can potentially return an alias.
• Handle
  A handle to send commands to the node or request information.

Type Aliases

• NodeId
  Public node & device identifier.