Skip to main content

Beacon

Struct Beacon 

Source
pub struct Beacon { /* private fields */ }
Expand description

What this node says about itself: the signer plus the advertised facts, with one monotonically increasing sequence shared by every transmitting provider — a reader deduplicates by (instance, seq) regardless of which transport delivered first.

Implementations§

Source§

impl Beacon

Source

pub fn new( identity: Arc<NodeIdentity>, endpoints: Vec<String>, caps: Vec<String>, repos: Vec<String>, version: &str, ) -> Self

A beacon over this node’s identity and advertised facts, for the node’s unnamed runtime; Beacon::with_runtime names one.

Source

pub fn with_runtime(self, runtime: &str) -> Self

The same beacon, announcing one runtime slot of the node (16 hex). A node may run a server per checkout, and a listener that only heard the node could not tell those apart or address one of them; naming the runtime is what makes an advertisement answerable by the particular server that sent it. It is a builder step rather than an argument to Beacon::new because a node with a single unnamed runtime is a complete configuration.

use std::sync::Arc;
use majordomus_cli::mesh::identity::NodeIdentity;
use majordomus_cli::mesh::provider::Beacon;

let identity = Arc::new(NodeIdentity::ephemeral().unwrap());
let bare = Beacon::new(identity.clone(), vec![], vec![], vec![], "docs");
assert_eq!(bare.runtime(), "", "a node may run one unnamed runtime");

let named = Beacon::new(identity, vec![], vec![], vec![], "docs").with_runtime("0123456789abcdef");
assert_eq!(named.runtime(), "0123456789abcdef");
assert_eq!(named.next_envelope().adv.rt, "0123456789abcdef");
Source

pub fn next_envelope(&self) -> Envelope

The next signed envelope, sequence advanced.

Source

pub fn identity(&self) -> &NodeIdentity

The public identity behind the beacon.

Source

pub fn runtime(&self) -> &str

The runtime slot this beacon announces; empty for the unnamed runtime.

Source

pub fn endpoints(&self) -> &[String]

The host:port authorities this beacon puts into every advertisement it signs. They are fixed when the beacon is built, so that every transport announces the same reachability and a listener never has to reconcile two accounts of where one node answers.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more