Struct SharedUnlockPeer 

pub struct SharedUnlockPeer<D: SharedUnlockDriver>(Arc<InnerPeer<D>>);

One participant in the shared unlock protocol.

Tuple Fields

0: Arc<InnerPeer<D>>

Implementations

impl<D: SharedUnlockDriver + Send + Sync + 'static> SharedUnlockPeer<D>

pub fn create(driver: D, ipc_client: Arc<dyn IpcClient>) -> Self

Creates a peer. Nothing is sent until SharedUnlockPeer::start is called.

pub fn create_for_test( driver: D, ipc_client: Arc<dyn IpcClient>, sync_interval: Duration, vault_timeout_grace_period: Duration, peer_stale_after: Duration, ) -> Self

Creates a peer that syncs on the given timings rather than the production ones, so tests do not have to wait out a 5s interval. Compiled only for tests and under test-support.

fn create_with_timing( driver: D, ipc_client: Arc<dyn IpcClient>, timing: SharedUnlockTiming, ) -> Self

pub fn set_destinations( &self, user_id: UserId, destinations: Vec<SharedUnlockClient>, )

Sets which clients this peer shares one user’s unlock state with, in both directions: a client that is not in the set is never synced that user, and that user’s syncs from it are dropped on arrival. Replaces any previous set for the user.

Every user defaults to no client at all — a peer neither sends nor accepts anything for a user until this is called for it.

fn is_destination(&self, user_id: UserId, endpoint: &Endpoint) -> bool

pub async fn start( &self, cancellation_token: Option<CancellationToken>, ) -> Result<(), PeerStartError>

Starts the receive loop and the sync timer, then announces this peer’s state once so it does not have to wait a full interval to be discovered.

pub async fn receive_message( &self, incoming_message: TypedIncomingMessage<SharedUnlockSync>, ) -> Result<(), ()>

Handles a sync from another peer.

pub async fn handle_device_event(&self, event: DeviceEvent) -> Result<(), ()>

Records a lock state change made on this device and syncs it to every peer immediately.

async fn apply_remote_state( &self, user_id: UserId, remote: TimestampedLockState, ) -> Result<(), ()>

Applies a peer’s state if it is newer than what this device has recorded.

async fn sync_all_users(&self)

Sends this peer’s state for every logged-in user to every peer it syncs with.

async fn sync_user(&self, user_id: UserId)

async fn sync_all_users_to(&self, target: &SyncTarget)

Sends this peer’s state for every logged-in user to one specific peer.

async fn sync_user_to(&self, user_id: UserId, target: &SyncTarget)

async fn may_sync_user_to(&self, user_id: UserId, target: &SyncTarget) -> bool

Whether a user’s state may be sent to a peer.

The peer must be among the user’s configured destinations.

A web peer is additionally entitled only to the users whose vault URL is the origin it was validated against — the same rule SharedUnlockPeer::receive_message applies to incoming syncs, applied outbound so a page served by one vault is never handed another vault’s key material. A web peer with no recorded origin fails closed.

async fn sync_targets(&self) -> Vec<SyncTarget>

This peer’s leader, if it has one, plus every peer that syncs to it.

async fn send_message(&self, message: SharedUnlockSync, recipient: Endpoint)

pub fn recorded_changed_at(&self, user_id: UserId) -> Option<u64>

The date this peer has recorded for a user, for tests that assert two peers converged on one date and not merely on one state. Compiled only for tests and under test-support.

fn recorded_state(&self, user_id: UserId) -> Option<TimestampedLockState>

fn advertised_state(&self, user_id: UserId) -> TimestampedLockState

The state to advertise for a user: the recorded one, or a presence marker.

fn record_remote_state(&self, user_id: UserId, state: TimestampedLockState)

Records a state reported by a peer, if it still supersedes what is recorded.

fn record_local_state(&self, user_id: UserId, lock_state: LockState)

Records a change made on this device.

Trait Implementations

impl<D: SharedUnlockDriver> Clone for SharedUnlockPeer<D>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.