Struct Channel

pub struct Channel { /* private fields */ }

An asynchronous, bounded, and bi-directional message-passing mechanism between processes.

Implementations

impl Channel

pub fn from_handle(handle: OwnedHandle) -> Channel

Creates a new channel from a handle.

pub fn create() -> Result<(Channel, Channel), FtlError>

Creates a new channel pair, connected to each other.

pub fn handle(&self) -> &OwnedHandle

Returns the handle of the channel.

pub fn split(self) -> (ChannelSender, ChannelReceiver)

Splits the channel into sender/receiver halves.

Currently, it’s no more than Arc<Channel>, but splitting a channel whenever you can is recommended for future compatibility.

pub fn send<M: MessageSerialize>(&self, msg: M) -> Result<(), FtlError>

Sends a message to the channel’s peer. Non-blocking.

Note

If the peer’s message queue is full, this method will return an error immediately without blocking.

pub fn send_with_buffer<M: MessageSerialize>( &self, buffer: &mut MessageBuffer, msg: M, ) -> Result<(), FtlError>

Sends a message to the channel’s peer using the provided buffer. Non-blocking.

pub fn try_recv<'a, M: MessageDeserialize>( &self, buffer: &'a mut MessageBuffer, ) -> Result<Option<M::Reader<'a>>, RecvError>

Receives a message from the channel’s peer. Non-blocking.

See Self::recv for more details.

pub fn recv<'a, M: MessageDeserialize>( &self, msgbuffer: &'a mut MessageBuffer, ) -> Result<M::Reader<'a>, RecvError>

Receives a message from the channel’s peer using the provided buffer. Blocking.

Kernel writes the received message into the buffer (msgbuffer), this library deserializes the message, and returns a typed message object.

Example

use starina_api::types::message::MessageBuffer;

let mut msgbuffer = MessageBuffer::new();
let reply = ch.recv::<PingReply>(&mut msgbuffer);
debug!("reply = {}", reply.value);

pub fn call<'a, M>( &self, msgbuffer: &'a mut MessageBuffer, request: M, ) -> Result<<M::Reply as MessageDeserialize>::Reader<'a>, CallError>

where M: MessageCallable,

Send a message and then receive a reply. Blocking.

See Self::recv for more details on buffer.

Trait Implementations

impl Debug for Channel

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

Formats the value using the given formatter.

impl From<Channel> for (ChannelSender, ChannelReceiver)

fn from(channel: Channel) -> (ChannelSender, ChannelReceiver)

Converts to this type from the input type.

impl From<Channel> for HandleField

fn from(channel: Channel) -> HandleField

Converts to this type from the input type.

impl From<Channel> for MovedHandle

fn from(channel: Channel) -> MovedHandle

Converts to this type from the input type.

impl From<MovedHandle> for Channel

fn from(moved_handle: MovedHandle) -> Channel

Converts to this type from the input type.