Struct SurfacePeer 

pub struct SurfacePeer { /* private fields */ }

The app’s end of the connection to its session.

Cloneable pieces are not: the reader thread owns the receiving half.

Implementations

impl SurfacePeer

pub fn from_descriptor(number: i32) -> Option<SurfacePeer>

The peer on the already connected socket handed over as ACTIONS_FD_ENV’s number; None when the number names no socket.

pub fn of(stream: UnixStream) -> SurfacePeer

A peer on stream, one end of a socket to the session.

Trait Implementations

impl PeerTransport for SurfacePeer

fn is_connected(&self) -> bool

fn hosts_surface(&self) -> bool

Whether this app is a surface of the desktop it speaks to, rather than an app of a document: what it offers lives with that desktop, so no document history custodies its actions.

fn send(&mut self, request: CollabRequest) -> Result<(), String>

fn take_primary_route_result(&mut self) -> Option<Result<RouteSpec, String>>

The real broker acknowledgement of the latest Hello, never an optimistic echo.

fn set_wake(&mut self, wake: Box<dyn Fn() + Send + Sync>)

Install the callback that schedules this owner’s next frame, as super::CollabTransport::set_wake does for a host-supplied transport: a peer answered on a thread of its own calls it, so what it carries is not left waiting for an unrelated frame.

fn poll(&mut self) -> Vec<CollabEvent<SdkCustody>>

fn connection_snapshot(&self, _: &RouteSpec) -> Option<ConnectionSnapshot>

Authenticated connection provenance from the host, never app model state.

fn action_of( &self, _workspace: &str, _change: &[u8; 32], ) -> Option<CommitHistory>

The whole action the change change was part of, when the peer keeps the index of the actions it carries in workspace: every unit the action wrote, which is what one undo takes back.

fn join_route(&mut self, _: RouteSpec, _: RecordKind) -> Result<(), String>

Join route, whose record holds record_kind. The kind is what a host needs to create the record on this device’s first change.

fn send_to_route( &mut self, _: RouteSpec, _: CollabRequest, ) -> Result<(), String>

fn publish_action_directory(&mut self, _: String) -> Result<(), String>

fn take_action_directory_requests(&mut self) -> Vec<ActionDirectoryRequest>

fn install_document_encryption( &mut self, _: RouteSpec, _: ChannelGroup, ) -> Result<(), String>