Struct ListeningSocket

pub struct ListeningSocket { /* private fields */ }

An utility representing a unix socket on which your compositor is listening for new clients

Implementations

impl ListeningSocket

pub fn bind<S: AsRef<OsStr>>(socket_name: S) -> Result<Self, BindError>

Attempt to bind a listening socket with given name

This method will acquire an associate lockfile. The socket will be created in the directory pointed to by the XDG_RUNTIME_DIR environment variable.

pub fn bind_auto( basename: &str, range: impl IntoIterator<Item = usize>, ) -> Result<Self, BindError>

Attempt to bind a listening socket from a sequence of names

This method will repeatedly try to bind sockets in the form {basename}-{n} for values of n yielded from the provided range and returns the first one that succeeds.

This method will acquire an associate lockfile. The socket will be created in the directory pointed to by the XDG_RUNTIME_DIR environment variable.

pub fn bind_absolute(socket_path: PathBuf) -> Result<Self, BindError>

Attempt to bind a listening socket with given name

The socket will be created at the specified path, and this method will acquire an associatet lockfile alongside it.

pub fn accept(&self) -> Result<Option<UnixStream>>

Try to accept a new connection to the listening socket

This method will never block, and return Ok(None) if no new connection is available.

pub fn socket_name(&self) -> Option<&OsStr>

Returns the name of the listening socket.

Will only be Some if that socket was created with bind() or bind_auto().

Trait Implementations

impl AsFd for ListeningSocket

fn as_fd(&self) -> BorrowedFd<'_>

Returns a file descriptor that may be polled for readiness.

This file descriptor may be polled using apis such as epoll and kqueue to be told when a client has found the socket and is trying to connect.

When the polling system reports the file descriptor is ready, you can use accept() to get a stream to the new client.

impl AsRawFd for ListeningSocket

fn as_raw_fd(&self) -> RawFd

Returns a file descriptor that may be polled for readiness.

This file descriptor may be polled using apis such as epoll and kqueue to be told when a client has found the socket and is trying to connect.

When the polling system reports the file descriptor is ready, you can use accept() to get a stream to the new client.

impl Debug for ListeningSocket

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for ListeningSocket

fn drop(&mut self)

Executes the destructor for this type.