UdpFace

Struct UdpFace 

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

NDN face over unicast UDP.

Uses an unconnected socket with send_to / recv_from rather than a connected socket with send / recv. On macOS (and some BSDs), a connected UDP socket that receives an ICMP port-unreachable enters a permanent error state where every subsequent send() fails with EPIPE (broken pipe). The unconnected approach avoids this entirely — each datagram is independent at the kernel level.

send_to is &self-safe: UdpSocket::send_to takes &self and UDP sends are atomic at the kernel level, so no mutex is needed.

Packets larger than the configured MTU are automatically fragmented into NDNLPv2 LpPacket fragments before sending.

Implementations§

Source§

impl UdpFace

Source

pub async fn bind( local: SocketAddr, peer: SocketAddr, id: FaceId, ) -> Result<Self>

Bind to local, targeting peer for all sends.

The socket is not connected — recv_from is used and datagrams from other sources are silently discarded.

If local is 0.0.0.0:0 (or [::]:0), the socket is bound to the specific local interface that the OS routes to peer. This avoids EHOSTUNREACH on macOS when the peer is on a non-default-route subnet (e.g. a VM bridge network).

Source

pub fn from_socket(id: FaceId, socket: UdpSocket, peer: SocketAddr) -> Self

Wrap an already-bound socket, targeting peer for all sends.

Source

pub fn from_shared_socket( id: FaceId, socket: Arc<UdpSocket>, peer: SocketAddr, ) -> Self

Create a face that shares an existing socket (e.g. the UDP listener socket).

Replies go out from the same port the listener is bound to, so the remote peer’s connected/filtered socket accepts them. The recv() loop filters datagrams by peer address.

Source

pub fn peer(&self) -> SocketAddr

Trait Implementations§

Source§

impl Face for UdpFace

Source§

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

Receive the next datagram from the peer.

Returns the raw datagram bytes (may be a bare packet or LpPacket). Fragment reassembly is handled by the pipeline’s TlvDecode stage, not here — keeping the Face layer protocol-agnostic.

Datagrams from addresses other than self.peer are silently discarded.

Source§

fn id(&self) -> FaceId

Source§

fn kind(&self) -> FaceKind

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:///run/nfd/nfd.sock). Returns None for face types that don’t expose local binding info.
Source§

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

Send a packet. Must not block the caller; use internal buffering. Read more
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
Link type of this face. 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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more