Struct base::sys::unix::tube::Tube

pub struct Tube {
    socket: ScmSocket<StreamChannel>,
}

Bidirectional tube that support both send and recv.

Fields

socket: ScmSocket<StreamChannel>

Implementations

impl Tube

pub fn split_to_send_recv(self) -> Result<(SendTube, RecvTube)>

Given a Tube end, creates two new ends, one each for sending and receiving.

pub fn directional_pair() -> Result<(SendTube, RecvTube)>

Creates a Send/Recv pair of Tubes.

pub fn try_clone_send_tube(&self) -> Result<SendTube>

impl Tube

pub fn pair() -> Result<(Tube, Tube)>

Create a pair of connected tubes. Request is sent in one direction while response is in the other direction.

pub fn new(socket: StreamChannel) -> Result<Tube>

Create a new Tube from a StreamChannel. The StreamChannel must use FramingMode::Message (meaning, must use a SOCK_SEQPACKET as the underlying socket type), otherwise, this method returns an error.

pub fn new_from_unix_seqpacket(sock: UnixSeqpacket) -> Result<Tube>

Create a new Tube from a UnixSeqpacket. The StreamChannel is implicitly constructed to have the right FramingMode by being constructed from a UnixSeqpacket.

pub fn try_clone(&self) -> Result<Self>

👎Deprecated

DO NOT USE this method directly as it will become private soon (b/221484449). Use a directional Tube pair instead.

pub fn send<T: Serialize>(&self, msg: &T) -> Result<()>

Sends a message via a Tube. The number of file descriptors that this method can send is limited to TUBE_MAX_FDS. If you want to send more descriptors, use send_with_max_fds instead.

pub fn send_with_max_fds<T: Serialize>( &self, msg: &T, max_fds: usize ) -> Result<()>

Sends a message with at most max_fds file descriptors via a Tube. Note that max_fds must not exceed SCM_SOCKET_MAX_FD_COUNT (= 253).

pub fn recv<T: DeserializeOwned>(&self) -> Result<T>

Recieves a message from a Tube. If the sender sent file descriptors more than TUBE_MAX_FDS with send_with_max_fds, use recv_with_max_fds instead.

pub fn recv_with_max_fds<T: DeserializeOwned>( &self, max_fds: usize ) -> Result<T>

Recieves a message with at most max_fds file descriptors from a Tube.

pub fn set_send_timeout(&self, timeout: Option<Duration>) -> Result<()>

pub fn set_recv_timeout(&self, timeout: Option<Duration>) -> Result<()>

fn send_proto<M: Message>(&self, msg: &M) -> Result<()>

fn recv_proto<M: Message>(&self) -> Result<M>

Trait Implementations

impl AsRawDescriptor for Tube

fn as_raw_descriptor(&self) -> RawDescriptor

Returns the underlying raw descriptor.

impl AsRawFd for Tube

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<'de> Deserialize<'de> for Tube

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ReadNotifier for Tube

fn get_read_notifier(&self) -> &dyn AsRawDescriptor

Gets a descriptor that can be used in EventContext to wait for events to be available (e.g. to avoid receive_events blocking).

impl Serialize for Tube

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.