Struct Session 

pub struct Session { /* private fields */ }

A connected session: the server’s info, and the recording this client has open.

Implementations

impl Session

pub async fn connect( addr: SocketAddr, server_name: &str, config: ClientConfig, ) -> StreamResult<Self>

Connects to addr (certificate checked against server_name per config) and reads the server’s info. The local endpoint uses the address family of addr.

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

Accepts messages up to bytes long (default DEFAULT_MAX_MESSAGE_BYTES).

pub fn server(&self) -> &ServerInfo

Who the server is, who this client is to it, and what it may do.

pub fn recording(&self) -> Option<&RecordingInfo>

The recording this client has open (channels, units, exact rate, stored format): the server’s initial one, or the last Self::opened.

pub async fn subscribe( &mut self, first_sample: u64, ) -> StreamResult<SignalReceiver>

Starts (or restarts) the signal of the open recording at first_sample.

pub async fn view(&self, view: &View) -> StreamResult<Envelope>

The server’s answer to view of the open recording.

pub async fn list_files(&self, dir: &str) -> StreamResult<FileList>

The entries of directory dir under the server’s data root (“” = the root).

pub async fn configure(&self, job: Configure) -> StreamResult<Status>

Sets the server’s job (control permission; only while nothing runs).

pub async fn start(&self) -> StreamResult<Status>

Starts the configured job (control permission).

pub async fn stop(&self) -> StreamResult<Status>

Asks the running job to stop (control permission).

pub async fn status(&self) -> StreamResult<Status>

The server’s state and its job’s progress.

pub async fn logs(&self, lines: u32) -> StreamResult<Vec<String>>

The job’s last lines log lines (0 = all the server keeps).

pub async fn fetch_file(&self, path: &str, dest: &Path) -> StreamResult<u64>

Fetches the file path under the server’s data root into dest (a new file, never overwritten); returns its size. A directory is fetched with Self::fetch.

pub async fn fetch(&self, path: &str, dest: &Path) -> StreamResult<(usize, u64)>

Fetches path (a file, or a directory such as a .sorting.zarr, file by file) into the new local path dest; returns files and bytes. Names from the server are checked: plain, not hidden, no separators, so nothing lands outside dest.

pub async fn open( &mut self, path: &str, source: Option<&str>, ) -> StreamResult<&RecordingInfo>

Opens the recording at path under the server’s data root (source: one of the file’s sources, None = its default); views and the signal are then of it.

pub async fn close(self)

Ends the session (the server stops streaming).