Skip to main content

Endpoint

Struct Endpoint 

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

Everything the routes need.

Cloneable and cheap: an Arc of each service.

Implementations§

Source§

impl Endpoint

Source

pub const MAX_WAITING_NODES: usize = LongPoll::MAX_WAITING

The most long-polling nodes one endpoint will remember.

waitForPairing carries no bearer and its body is a list of identifiers the caller chose, so the table it fills is bounded. A LAN endpoint talks to tens of devices.

Source

pub const MAX_NODES_PER_POLL: usize = LongPoll::MAX_PER_POLL

The most nodes a single waitForPairing may ask about.

Source

pub fn new(pairing: Arc<PairingService>, session: Arc<SessionService>) -> Self

An endpoint serving both APIs.

Source

pub const fn with_max_message_bytes(self, bytes: usize) -> Self

Buffer no WebSocket frame larger than this.

Defaults to DecodeOptions::DEFAULT_MAX_BYTES, the mebibyte the codec and the session engines already use. Raise it only together with the session’s own max_message_bytes: a frame larger than the codec will parse is a frame that is buffered and then refused.

Source

pub const fn max_message_bytes(&self) -> usize

The largest WebSocket frame this endpoint will buffer.

Source

pub fn on_prepare_pairing( self, handler: impl Fn(PrepareSignal) + Send + Sync + 'static, ) -> Self

React to a client announcing that its user has started pairing.

Typically: show the pairing code on a display, or light an LED. The handler runs inside the request, so it must not block — and it must not be trusted, because the signal is unauthenticated and only reaches you at all through the same-subnet check in lan_router.

Source

pub fn with_clock(self, clock: fn() -> Timestamp) -> Self

Use a different clock — a virtual one, in a test.

Source

pub fn session(&self) -> &Arc<SessionService> ⓘ

The session service, for a host that also terminates the WebSocket.

Source

pub fn instruct_waiting_node(&self, client: NodeId, action: WaitAction)

Tell a long-polling node to do something the next time it asks.

This is the other half of lan_router’s waitForPairing: a Resource Manager with no listening socket cannot be dialled, so when a person presses the pairing button here the instruction waits until that node next checks in. A request that is already held open is woken at once, so “waits” is usually microseconds.

Source

pub fn waiting_nodes(&self) -> Vec<(NodeId, WaitingNode)>

Every node that is long-polling this endpoint, and what it has said about itself.

What a user interface lists when somebody asks “what is out there to pair with?” — the counterpart of GET /v1/nodes for clients that have no server to browse.

Source

pub fn live_attempts(&self) -> usize

How many attempts the router is tracking. For a test, and for a health endpoint.

Trait Implementations§

Source§

impl Clone for Endpoint

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Endpoint

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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