Struct zircon_object::ipc::Socket

pub struct Socket { /* fields omitted */ }

Bidirectional streaming IPC transport.

SYNOPSIS

Sockets are a bidirectional stream transport. Unlike channels, sockets only move data (not handles).

Implementations

impl Socket

pub fn create(flags: u32) -> ZxResult<(Arc<Self>, Arc<Self>)>

Create a socket.

pub fn write(&self, data: &[u8]) -> ZxResult<usize>

Write data to the socket. If successful, the number of bytes actually written are returned.

A SOCKET_STREAM(default) socket write can be short if the socket does not have enough space for all of data. Otherwise, if the socket was already full, the call returns ZxError::SHOULD_WAIT.

A SOCKET_DATAGRAM socket write is never short. If the socket has insufficient space for data, it writes nothing and returns ZxError::SHOULD_WAIT. Attempting to write a packet larger than the datagram socket’s capacity will fail with ZxError::OUT_OF_RANGE.

pub fn read(&self, peek: bool, data: &mut [u8]) -> ZxResult<usize>

Read data from the socket. If successful, the number of bytes actually read are returned.

If the socket was created with SOCKET_DATAGRAM, this method reads only the first available datagram in the socket (if one is present). If data is too small for the datagram, then the read will be truncated, and any remaining bytes in the datagram will be discarded.

If peek is true, leave the message in the socket. Otherwise consume the message.

pub fn get_info(&self) -> SocketInfo

Get information of the socket.

pub fn shutdown(&self, read: bool, write: bool) -> ZxResult

Prevent reading or writing.

pub fn set_read_threshold(&self, threshold: usize) -> ZxResult

Set the read threshold of the socket.

When the bytes queued on the socket (available for reading) is equal to or greater than this value, the SOCKET_READ_THRESHOLD signal is asserted. Read threshold signalling is disabled by default (and when set, writing a value of 0 for this property disables it).

pub fn set_write_threshold(&self, threshold: usize) -> ZxResult

Set the write threshold of the socket.

When the space available for writing on the socket is equal to or greater than this value, the SOCKET_WRITE_THRESHOLD signal is asserted. Write threshold signalling is disabled by default (and when set, writing a value of 0 for this property disables it).

pub fn get_rx_tx_threshold(&self) -> (usize, usize)

Get the read and write thresholds of the socket.

Trait Implementations

impl Debug for Socket

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

Formats the value using the given formatter.

impl Drop for Socket

fn drop(&mut self)

Executes the destructor for this type.

impl KernelObject for Socket

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 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 get_child(&self, _id: KoID) -> ZxResult<Arc<dyn KernelObject>>

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

fn allowed_signals(&self) -> Signal

Get object’s allowed signals.