Skip to main content

Agent

Struct Agent 

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

SNMP Agent.

Listens for and responds to SNMP requests (GET, GETNEXT, GETBULK, SET).

§Example

use async_snmp::agent::Agent;
use async_snmp::oid;

let agent = Agent::builder()
    .bind("0.0.0.0:161")
    .community(b"public")
    .build()
    .await?;

agent.run().await

Implementations§

Source§

impl Agent

Source

pub fn builder() -> AgentBuilder

Create a builder for configuring the agent.

Source

pub fn local_addr(&self) -> SocketAddr

Get the local address the agent is bound to.

Source

pub fn engine_id(&self) -> &[u8]

Get the engine ID.

Source

pub fn cancel(&self) -> CancellationToken

Get the cancellation token for this agent.

Call token.cancel() to initiate graceful shutdown.

Source

pub fn snmp_invalid_msgs(&self) -> u32

Get the snmpInvalidMsgs counter value.

This counter tracks messages with invalid msgFlags, such as privacy-without-authentication (RFC 3412 Section 7.2 Step 5d).

OID: 1.3.6.1.6.3.11.2.1.2

Source

pub fn snmp_unknown_security_models(&self) -> u32

Get the snmpUnknownSecurityModels counter value.

This counter tracks messages with unrecognized security models (RFC 3412 Section 7.2 Step 2).

OID: 1.3.6.1.6.3.11.2.1.1

Source

pub fn snmp_silent_drops(&self) -> u32

Get the snmpSilentDrops counter value.

This counter tracks confirmed-class PDUs (GetRequest, GetNextRequest, GetBulkRequest, SetRequest, InformRequest) that were silently dropped because even an empty Response-PDU would exceed the maximum message size constraint (RFC 3412 Section 7.1).

OID: 1.3.6.1.6.3.11.2.1.3

Source

pub fn usm_unknown_engine_ids(&self) -> u32

Get the usmStatsUnknownEngineIDs counter value.

This counter tracks messages with unknown engine IDs. Incremented when a non-discovery request arrives with an engine ID that does not match the local engine (RFC 3414 Section 3.2 Step 3).

OID: 1.3.6.1.6.3.15.1.1.4

Source

pub fn usm_unknown_usernames(&self) -> u32

Get the usmStatsUnknownUserNames counter value.

This counter tracks messages with unknown user names. Incremented when a message arrives with a user name not in the local user database (RFC 3414 Section 3.2 Step 1).

OID: 1.3.6.1.6.3.15.1.1.3

Source

pub fn usm_wrong_digests(&self) -> u32

Get the usmStatsWrongDigests counter value.

This counter tracks messages with incorrect authentication digests, as well as messages where the user has no auth key configured. (RFC 3414 Section 3.2 Steps 6 and 7).

OID: 1.3.6.1.6.3.15.1.1.5

Source

pub fn usm_not_in_time_windows(&self) -> u32

Get the usmStatsNotInTimeWindows counter value.

This counter tracks messages that fall outside the time window. Incremented when the message time differs from the local time by more than 150 seconds (RFC 3414 Section 3.2 Step 8).

OID: 1.3.6.1.6.3.15.1.1.2

Source

pub async fn run(&self) -> Result<()>

Run the agent, processing requests concurrently.

Requests are processed in parallel up to the configured max_concurrent_requests limit (default: 1000). This method runs until the cancellation token is triggered.

Trait Implementations§

Source§

impl Clone for Agent

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§

§

impl Freeze for Agent

§

impl !RefUnwindSafe for Agent

§

impl Send for Agent

§

impl Sync for Agent

§

impl Unpin for Agent

§

impl UnsafeUnpin for Agent

§

impl !UnwindSafe for Agent

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

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