Struct Link 

pub struct Link { /* private fields */ }

A handshaked link to one station. Cloning it shares the link.

Implementations

impl Link

pub async fn call(&self, c: Call) -> Result<Value, LinkError>

Signs c as a CALL, sends it, and waits for the RESULT or ERROR that verifies for it.

impl Link

pub async fn put_record(&self, wire: &[u8]) -> Result<(), LinkError>

Stores a signed record, as its wire bytes, in the station’s DHT.

pub async fn find_record(&self, key: &[u8; 32]) -> Result<Verified, LinkError>

The record stored under key, verified.

pub async fn find_records( &self, key: &[u8; 32], ) -> Result<(Vec<Verified>, usize), LinkError>

Every record stored under key that verifies, and how many the station returned that did not.

pub async fn find_records_by_type( &self, t: RecordType, ) -> Result<(Vec<Verified>, usize), LinkError>

Every record of type t the station holds that verifies, and how many it returned that did not.

impl Link

pub async fn publish(&self, p: Publication) -> Result<(), LinkError>

Signs p as a PUBLISH and sends it.

pub async fn publish_signed( &self, p: &SignedPublication, ) -> Result<(), LinkError>

Sends a publication signed once for several links, as it is.

pub async fn subscribe( &self, realm: &[u8; 32], topic: &str, ) -> Result<Subscription, LinkError>

Subscribes to topic in realm: the first subscription to a realm and topic on the link sends SUBSCRIBE.

impl Link

pub async fn serve(&self, o: Offer) -> Result<Served, LinkError>

Advertises o’s procedure on the link and answers its CALLs until stopped. For an org procedure it resolves the org directory and this node’s procedure delegation from the DHT; a procedure in this node’s own namespace needs neither, and another node’s namespace is refused. It signs the advertisement with this node’s identity key, naming the connected station as the serving station and living no longer than the records it carries nor 5 minutes, and checks its authorization (against the realm key for an org procedure) before sending it in an ADVERTISE and putting it in the DHT. The advertisement is renewed at half its lifetime.

impl Link

pub async fn open_stream(&self, c: StreamCall) -> Result<Stream, LinkError>

Opens a streaming session: a QUIC stream of its own, on which it writes the signed STREAM_OPEN. A stream it opens but cannot write the open on is released before the error returns.

impl Link

pub async fn dial(cfg: Config) -> Result<Link, LinkError>

Dials cfg.target, runs the v4 handshake as a client, and returns the link once the station’s HELLO accepts it, within HANDSHAKE_TIMEOUT.

pub fn station_node_id(&self) -> [u8; 32]

The node_id of the station the link reached.

pub fn serial(&self) -> u64

A number distinct for every link this process dials.

pub fn node_id(&self) -> [u8; 32]

The node_id this link connected as.

pub fn station_capabilities(&self) -> u64

The capability bits the station’s HELLO announced.

pub fn profile(&self) -> Profile

The profile the link runs.

pub fn error(&self) -> Option<LinkError>

Why the link ended, or None while it runs.

pub async fn done(&self) -> LinkError

Waits until the link has ended, and says why.

pub fn unrouted(&self) -> HashMap<String, u64>

The frames received that nothing on this link handles, by what they were.

pub async fn close(&self, reason: &str) -> Result<(), LinkError>

Sends a GOODBYE with reason, closes the control stream’s sending side, waits up to a second for the station to close the connection, and ends the link. Closing an ended link does nothing.

Trait Implementations

impl Clone for Link

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.