Struct Service 

pub struct Service<D, S, G> { /* private fields */ }

The node service.

Implementations

impl<D, S, G> Service<D, S, G>

pub fn node_id(&self) -> NodeId

Get the local node id.

pub fn local_time(&self) -> LocalTime

Get the local service time.

pub fn emitter(&self) -> Emitter<Event>

impl<D, S, G> Service<D, S, G>

where D: Store, S: ReadStorage + 'static, G: Signer<Signature>,

pub fn new( config: Config, db: Stores<D>, storage: S, policies: Config<Write>, signer: Device<G>, rng: Rng, node: NodeAnnouncement, emitter: Emitter<Event>, ) -> Self

pub fn started(&self) -> Option<LocalTime>

Whether the service was started (initialized) and if so, at what time.

pub fn next(&mut self) -> Option<Io>

Return the next i/o action to execute.

pub fn seed(&mut self, id: &RepoId, scope: Scope) -> Result<bool, Error>

Seed a repository. Returns whether or not the repo policy was updated.

pub fn unseed(&mut self, id: &RepoId) -> Result<bool, Error>

Unseed a repository. Returns whether or not the repo policy was updated. Note that when unseeding, we don’t announce anything to the network. This is because by simply not announcing it anymore, it will eventually be pruned by nodes.

pub fn closest_peers(&self, n: usize) -> Vec<NodeId>

Find the closest n peers by proximity in seeding graphs. Returns a sorted list from the closest peer to the furthest. Peers with more seedings in common score score higher.

pub fn database(&self) -> &Stores<D>

Get the database.

pub fn database_mut(&mut self) -> &mut Stores<D>

Get the mutable database.

pub fn storage(&self) -> &S

Get the storage instance.

pub fn storage_mut(&mut self) -> &mut S

Get the mutable storage instance.

pub fn policies(&self) -> &Config<Write>

Get the node policies.

pub fn signer(&self) -> &Device<G>

Get the local signer.

pub fn events(&mut self) -> Events

Subscriber to inner Emitter events.

pub fn outbox(&mut self) -> &mut Outbox

Get I/O outbox.

pub fn config(&self) -> &Config

Get configuration.

pub fn lookup(&self, rid: RepoId) -> Result<Lookup, LookupError>

Lookup a repository, both locally and in the routing table.

pub fn initialize(&mut self, time: LocalTime) -> Result<(), Error>

Initialize service with current time. Call this once.

pub fn tick(&mut self, now: LocalTime, metrics: &Metrics)

pub fn wake(&mut self)

pub fn command(&mut self, cmd: Command)

pub fn fetched( &mut self, rid: RepoId, remote: NodeId, result: Result<FetchResult, FetchError>, )

pub fn dequeue_fetches(&mut self)

Attempt to dequeue fetches from all peers. At most one fetch is dequeued per peer. If the fetch cannot be processed, it is put back on the queue for that peer.

Fetches are queued for two reasons:

1. The RID was already being fetched.
2. The session was already at fetch capacity.

pub fn accepted(&mut self, ip: IpAddr) -> bool

Inbound connection attempt.

pub fn attempted(&mut self, nid: NodeId, addr: Address)

pub fn listening(&mut self, local_addr: SocketAddr)

pub fn connected(&mut self, remote: NodeId, addr: Address, link: Link)

pub fn disconnected( &mut self, remote: NodeId, link: Link, reason: &DisconnectReason, )

pub fn received_message(&mut self, remote: NodeId, message: Message)

pub fn handle_announcement( &mut self, relayer: &NodeId, relayer_addr: &Address, announcement: &Announcement, ) -> Result<Option<AnnouncementId>, Error>

Handle an announcement message.

Returns true if this announcement should be stored and relayed to connected peers, and false if it should not.

pub fn handle_info(&mut self, remote: NodeId, info: &Info) -> Result<(), Error>

pub fn handle_message( &mut self, remote: &NodeId, message: Message, ) -> Result<(), Error>

Trait Implementations

impl<D: Debug, S: Debug, G: Debug> Debug for Service<D, S, G>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<D, S, G> ServiceState for Service<D, S, G>

where D: Store, G: Signer<Signature>, S: ReadStorage,

fn nid(&self) -> &NodeId

Get the Node ID.

fn sessions(&self) -> &Sessions

Get the existing sessions.

fn fetching(&self) -> &HashMap<RepoId, FetchState>

Get fetch state.

fn outbox(&self) -> &Outbox

Get outbox.

fn limiter(&self) -> &RateLimiter

Get rate limiter.

fn emitter(&self) -> &Emitter<Event>

Get event emitter.

fn get(&self, rid: RepoId) -> Result<Option<Doc>, RepositoryError>

Get a repository from storage.

fn clock(&self) -> &LocalTime

Get the clock.

fn clock_mut(&mut self) -> &mut LocalTime

Get the clock mutably.

fn config(&self) -> &Config

Get service configuration.

fn metrics(&self) -> &Metrics

Get service metrics.