Struct ListeningSocketSource

pub struct ListeningSocketSource { /* private fields */ }

Available on crate feature wayland_frontend only.

A Wayland listening socket event source.

This implements EventSource and may be inserted into an event loop.

Implementations

impl ListeningSocketSource

pub fn new_auto() -> Result<ListeningSocketSource, BindError>

Creates a new listening socket, automatically choosing the next available wayland socket name.

pub fn with_name(name: &str) -> Result<ListeningSocketSource, BindError>

Creates a new listening socket with the specified name.

pub fn socket_name(&self) -> &OsStr

Returns the name of the listening socket.

Trait Implementations

impl Debug for ListeningSocketSource

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

Formats the value using the given formatter.

impl EventSource for ListeningSocketSource

type Event = UnixStream

A stream to the new client.

You must register the client using the stream by calling DisplayHandle::insert_client.

type Metadata = ()

Some metadata of your event source

type Ret = ()

The return type of the user callback

type Error = Error

The error type returned from process_events() (not the user callback!).

fn process_events<F>( &mut self, readiness: Readiness, token: Token, callback: F, ) -> Result<PostAction>

where F: FnMut(Self::Event, &mut Self::Metadata) -> Self::Ret,

Process any relevant events

fn register( &mut self, poll: &mut Poll, token_factory: &mut TokenFactory, ) -> Result<()>

Register yourself to this poll instance

fn reregister( &mut self, poll: &mut Poll, token_factory: &mut TokenFactory, ) -> Result<()>

Re-register your file descriptors

fn unregister(&mut self, poll: &mut Poll) -> Result<()>

Unregister your file descriptors

const NEEDS_EXTRA_LIFECYCLE_EVENTS: bool = false

Whether this source needs to be sent the EventSource::before_sleep and EventSource::before_handle_events notifications. These are opt-in because they require more expensive checks, and almost all sources will not need these notifications

fn before_sleep(&mut self) -> Result<Option<(Readiness, Token)>, Error>

Notification that a single poll is about to begin

fn before_handle_events(&mut self, events: EventIterator<'_>)

Notification that polling is complete, and EventSource::process_events will be called with the given events for this source. The iterator may be empty, which indicates that no events were generated for this source