Struct zircon_object::signal::Port

pub struct Port { /* fields omitted */ }

Signaling and mailbox primitive

SYNOPSIS

Ports allow threads to wait for packets to be delivered from various events. These events include explicit queueing on the port, asynchronous waits on other handles bound to the port, and asynchronous message delivery from IPC transports.

Implementations

impl Port

pub fn new(options: u32) -> ZxResult<Arc<Self>>

Create a new Port.

pub fn push(&self, packet: impl Into<PortPacket>)

Push a packet into the port.

pub fn push_user(&self, packet: impl Into<PortPacket>) -> ZxResult<()>

Push a User type packet into the port.

pub async fn wait(self: &Arc<Self>) -> PortPacket

Asynchronous wait until at least one packet is available, then take out the earliest (in FIFO order) available packet.

pub fn can_bind_to_interrupt(&self) -> bool

Check whether the port can be bound to an interrupt.

Trait Implementations

impl Debug for Port

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

Formats the value using the given formatter.

impl KernelObject for Port

fn id(&self) -> KoID

Get object’s KoID.

fn type_name(&self) -> &str

Get the name of the type of the kernel object.

fn name(&self) -> String

Get object’s name.

fn set_name(&self, name: &str)

Set object’s name.

fn signal(&self) -> Signal

Get the signal status.

fn signal_set(&self, signal: Signal)

Assert signal.

fn signal_clear(&self, signal: Signal)

Deassert signal.

fn signal_change(&self, clear: Signal, set: Signal)

Change signal status: first clear then set indicated bits.

fn add_signal_callback(&self, callback: SignalHandler)

Add callback for signal status changes.

fn get_child(&self, _id: KoID) -> ZxResult<Arc<dyn KernelObject>>

Attempt to find a child of the object with given KoID.

fn peer(&self) -> ZxResult<Arc<dyn KernelObject>>

Attempt to get the object’s peer.

fn related_koid(&self) -> KoID

If the object is related to another (such as the other end of a channel, or the parent of a job), returns the KoID of that object, otherwise returns zero.

fn allowed_signals(&self) -> Signal

Get object’s allowed signals.