Struct Registry 

pub struct Registry { /* private fields */ }

Implementations

impl Registry

pub fn register( &self, username: &str, name: &str, platform: &str, device: &str, tx: UnboundedSender<LinkCommand>, wants_devices: bool, ) -> String

Add a client, replacing any earlier connection from the same device and account. Returns its id.

pub fn report(&self, id: &str, state: LinkState)

Record what a client says it is doing.

pub fn set_push(&self, username: &str, device: &str, token: &str, sandbox: bool)

Record where Apple’s push service reaches this device.

pub fn disconnect(&self, username: &str)

Close every link username has open. Dropping an entry’s sender ends its session, and the client must then sign in again to reconnect.

pub fn unregister(&self, id: &str)

pub fn watch_levels( &self, username: &str, watcher: &str, target: &str, on: bool, )

watcher has target’s playing bars on screen, or no longer has. The target is told to send its levels while anyone watches, and to stop when the last one goes. Only over a live link: levels are no reason to wake a phone or to queue a command for later.

pub fn levels(&self, username: &str, from: &str, f: Frame)

A frame of from’s levels, for each device watching it. Not stored: one that cannot be delivered now is of no use later.

pub fn share( &self, owner: &str, device: &str, grantee: &str, allow: bool, ) -> Result<(), String>

Let grantee control owner’s device device, or stop letting it. Asked by the device itself; the caller has checked grantee is an account on this server.

pub fn send_shares(&self, owner: &str, device: &str, error: Option<String>)

Tell owner’s device device whom it is shared with, and why its last request was refused, if it was.

pub fn seen_at(&self, device: &str, username: &str, addr: IpAddr)

device, of username’s, linked from addr.

pub fn wake(&self, username: &str, from: &str, to: &str, notify: bool)

Wake to, one of username’s devices that is not linked, for from (a device id), which chose it: with a background push, or with notify a notification asking to be tapped. Logged with the push’s round trip, and remembered so the link that follows is logged with how long it took.

pub fn forget(&self, username: &str, device: &str) -> Result<(), String>

Forget device, one of username’s that is not linked: what the server keeps of it, its push token included, so nothing is pushed to it again; and every linked device of the account drops it. Another account’s device is out of reach of this, by construction: every record is keyed by account. A device that links again is recorded afresh.

pub fn relay( &self, username: &str, to: &str, command: LinkCommand, ) -> Result<ClientInfo, String>

Relay command from one of username’s devices to another, to.

pub fn relay_from( &self, username: &str, from: Option<&str>, to: &str, command: LinkCommand, ) -> Result<ClientInfo, String>

relay, knowing which of username’s devices, from, sent it: what lets a device shared with another account hand its music to that account’s device, the one way a grant runs backwards.

pub fn set_activity( &self, username: &str, watcher: &str, activity: Option<(String, String, bool)>, )

Where to push a Live Activity’s updates: watcher shows target. None ends it.

pub fn list(&self, username: Option<&str>) -> Vec<ClientInfo>

Clients username may command, newest first; every client for None.

pub fn send( &self, username: Option<&str>, id: Option<&str>, cmd: LinkCommand, ) -> Result<ClientInfo, String>

Send to id (an id or a name), or with none to the client the command most likely means: the one playing, else the one that played within RECENT, else the only one linked. Err names the choices when there is no telling, so whoever asked can ask the person.

impl Registry

pub fn add_order(&self, order: Order)

pub fn orders(&self, username: Option<&str>) -> Vec<Order>

pub fn cancel_order(&self, username: Option<&str>, id: &str) -> bool

pub fn fulfil_orders(&self, find: impl Fn(&Order) -> Option<Vec<String>>)

Send every order whose album the library now holds, and drop it. find answers an order with the album’s track uids, in order.

impl Registry

pub fn broadcast(&self, username: Option<&str>, cmd: LinkCommand) -> Vec<String>

Send to every client username may command. The names of those it reached.

impl Registry

pub fn deliver( &self, username: Option<&str>, cmd: LinkCommand, ) -> (Vec<String>, Vec<String>)

Send to every device username may command: at once to those linked, and to those that have linked before but are away now, when they next link. For commands still right hours later (Sync, Evict), never playback. The names reached now, and the names it waits for.

Trait Implementations

impl Default for Registry

fn default() -> Self

Returns the “default value” for a type.