Skip to main content

LanClient

Struct LanClient 

Source
pub struct LanClient { /* private fields */ }
Available on crate feature connect-client only.
Expand description

Asks a LAN endpoint what it is, before anyone has decided to pair with it.

Implementations§

Source§

impl LanClient

Source

pub fn new(base_url: &str) -> Result<Self, Error>

Point at an endpoint’s base URL — unversioned, as DNS-SD advertises it; the version is read from its index on the first request.

The certificate is self-signed and unverified, exactly as during pairing — and nothing this client returns is authenticated. It is material for a user interface, not a basis for a decision. See proto::lan.

Source

pub async fn endpoint(&self) -> Result<EndpointDescription, Error>

GET /v1/endpoint — the endpoint’s own description.

Source

pub async fn nodes(&self) -> Result<Vec<NodeDescription>, Error>

GET /v1/nodes — every node this endpoint hosts.

Note that the schema returns bare NodeDescriptions, with no NodeIdAlias — so a user interface can show a list but cannot tell which entry a pairing code’s alias names (erratum E21).

Source

pub async fn prepare_pairing(&self, body: &PreparePairing) -> Result<(), Error>

POST /v1/preparePairing — “the end user has started the process on the client”.

A hint that lets the server show the pairing code at the moment the user is looking for it. Best effort by design: “When a preparePairing is called, it is not guaranteed that a call to pairingRequest or cancelPreparePairing will follow.”

Source

pub async fn cancel_prepare_pairing( &self, body: &CancelPreparePairing, ) -> Result<(), Error>

POST /v1/cancelPreparePairing — the user changed their mind.

Source

pub async fn wait_for_pairing( &self, nodes: &[WaitForPairing], ) -> Result<Vec<WaitInstruction>, Error>

POST /v1/waitForPairing — hold a request open until the endpoint has something to say.

This is how a Resource Manager that is “purely an HTTPS client” — no listening socket, nothing for a CEM to dial — takes part in a pairing at all: it asks the other endpoint what to do, and the answer arrives whenever a person presses a button there. The server holds the request for up to LONG_POLL_HOLD and then answers 204, read here as an empty list; that is not an error, it is “nothing yet, ask again”.

S2C §Long-polling: “the client can represent multiple nodes so the request body and the response contains a list”, and the server “may only provide at most one item for each clientNodeId”. Call it in a loop:

loop {
    for instruction in client.wait_for_pairing(&mine).await? {
        match instruction.action {
            WaitAction::RequestPairing => { /* start `Pairing::run` now */ }
            WaitAction::SendNodeDescription => { /* answer with descriptions */ }
            _ => {}
        }
    }
}

Trait Implementations§

Source§

impl Debug for LanClient

Source§

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

Formats the value using the given formatter. Read more

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
Source§

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

Source§

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.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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