connect

Function connect 

Source
pub fn connect(
    path: impl AsRef<Path>,
    logon: ClientLogon,
    timeout: Duration,
) -> Result<ClientSession, ClientHandshakeError>
๐Ÿ‘ŽDeprecated since 3.1.0: This crate has been marked for formal inclusion in the Agave Unstable API. From v4.0.0 onward, the agave-unstable-api crate feature must be specified to acknowledge use of an interface that may break without warning.
Expand description

Connects to the scheduler server on the given IPC path.

ยงTimeout

Timeout is enforced at the syscall level. In the typical case, this function will do two syscalls, one to send the logon message and one to receive the response. However, if for whatever reason the OS does not accept 1024 bytes in a single syscall, then multiple writes could be needed. As such this timeout is meant to guard against a broken server but not necessarily ensure this function always returns before the timeout (this is somewhat in line with typical timeouts because you have no guarantee of being rescheduled).