NotificationReceiver

Struct NotificationReceiver 

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

SNMP Notification Receiver.

Listens for incoming SNMP notifications (traps and informs) on a UDP socket. For InformRequest notifications, automatically sends a Response-PDU.

§V3 Authentication

To receive authenticated V3 notifications, use the builder pattern to configure USM credentials:

use async_snmp::notification::NotificationReceiver;
use async_snmp::{AuthProtocol, PrivProtocol};

let receiver = NotificationReceiver::builder()
    .bind("0.0.0.0:162")
    .usm_user("trapuser", |u| {
        u.auth(AuthProtocol::Sha1, b"authpassword")
    })
    .build()
    .await?;

Implementations§

Source§

impl NotificationReceiver

Source

pub fn builder() -> NotificationReceiverBuilder

Create a builder for configuring the notification receiver.

Use this to configure USM credentials for V3 authentication.

Source

pub async fn bind(addr: impl AsRef<str>) -> Result<Self>

Bind to a local address.

The standard SNMP notification port is 162. For V3 authentication support, use NotificationReceiver::builder() instead.

For IPv6 bind addresses, the socket has IPV6_V6ONLY set to true.

§Example
use async_snmp::notification::NotificationReceiver;

// Bind to the standard trap port (requires root/admin on most systems)
let receiver = NotificationReceiver::bind("0.0.0.0:162").await?;

// Or use an unprivileged port for testing
let receiver = NotificationReceiver::bind("0.0.0.0:1162").await?;
Source

pub fn local_addr(&self) -> SocketAddr

Get the local address this receiver is bound to.

Source

pub async fn recv(&self) -> Result<(Notification, SocketAddr)>

Receive a notification.

This method blocks until a notification is received. For InformRequest notifications, a Response-PDU is automatically sent back to the sender.

Returns the notification and the source address.

Trait Implementations§

Source§

impl Clone for NotificationReceiver

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. 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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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