SpscFace

Struct SpscFace 

Source
pub struct SpscFace { /* private fields */ }
Expand description

Engine-side SPSC SHM face.

Create with SpscFace::create; register with the engine via ForwarderEngine::add_face. Give the name to the application so it can call SpscHandle::connect.

Implementations§

Source§

impl SpscFace

Source

pub fn create(id: FaceId, name: &str) -> Result<Self, ShmError>

Create the SHM region and set up the wakeup mechanism.

name identifies this face (e.g. "sensor-0"); pass it to SpscHandle::connect in the application process.

Source

pub fn create_with( id: FaceId, name: &str, capacity: u32, slot_size: u32, ) -> Result<Self, ShmError>

Create with explicit ring parameters.

Trait Implementations§

Source§

impl Drop for SpscFace

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Face for SpscFace

Source§

fn id(&self) -> FaceId

Source§

fn kind(&self) -> FaceKind

Source§

async fn recv(&self) -> Result<Bytes, FaceError>

Receive the next packet. Blocks until a packet arrives or the face closes.
Source§

async fn send(&self, pkt: Bytes) -> Result<(), FaceError>

Send a packet. Must not block the caller; use internal buffering. Read more
Source§

fn remote_uri(&self) -> Option<String>

Remote URI (e.g. udp4://192.168.1.1:6363). Returns None for face types that don’t have a meaningful remote endpoint.
Source§

fn local_uri(&self) -> Option<String>

Local URI (e.g. unix:///tmp/ndn.sock). Returns None for face types that don’t expose local binding info.
Source§

fn recv_with_addr( &self, ) -> impl Future<Output = Result<(Bytes, Option<FaceAddr>), FaceError>> + Send

Receive the next packet together with the link-layer sender address. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<F> ErasedFace for F
where F: Face,

Source§

fn id(&self) -> FaceId

Source§

fn kind(&self) -> FaceKind

Source§

fn remote_uri(&self) -> Option<String>

Source§

fn local_uri(&self) -> Option<String>

Source§

fn send_bytes( &self, pkt: Bytes, ) -> Pin<Box<dyn Future<Output = Result<(), FaceError>> + Send + '_>>

Source§

fn recv_bytes( &self, ) -> Pin<Box<dyn Future<Output = Result<Bytes, FaceError>> + Send + '_>>

Source§

fn recv_bytes_with_addr( &self, ) -> Pin<Box<dyn Future<Output = Result<(Bytes, Option<FaceAddr>), FaceError>> + Send + '_>>

Object-safe version of Face::recv_with_addr. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.