Skip to main content

EngineState

Struct EngineState 

Source
pub struct EngineState {
    pub engine_id: Bytes,
    pub engine_boots: u32,
    pub engine_time: u32,
    pub synced_at: Instant,
    pub latest_received_engine_time: u32,
    pub msg_max_size: u32,
}
Expand description

Discovered engine state.

Fields§

§engine_id: Bytes

Authoritative engine ID

§engine_boots: u32

Engine boot count

§engine_time: u32

Engine time at last sync

§synced_at: Instant

Local time when engine_time was received

§latest_received_engine_time: u32

Latest received engine time (for anti-replay, RFC 3414 Section 2.3)

§msg_max_size: u32

Maximum message size the remote engine can accept (from its advertised msgMaxSize header). This is the remote’s outbound limit and is used to constrain the size of messages we send to it. It is NOT the value we advertise in our own outgoing messages: RFC 3412 Section 6.3 requires msgMaxSize to carry the sender’s OWN receive capacity (our transport’s max_message_size), tracked separately from this field.

Implementations§

Source§

impl EngineState

Source

pub fn new(engine_id: Bytes, engine_boots: u32, engine_time: u32) -> Self

Create new engine state from discovery response.

Source

pub fn with_msg_max_size( engine_id: Bytes, engine_boots: u32, engine_time: u32, msg_max_size: u32, ) -> Self

Create with explicit msgMaxSize from agent’s header.

Source

pub fn with_msg_max_size_capped( engine_id: Bytes, engine_boots: u32, engine_time: u32, reported_msg_max_size: u32, session_max: u32, ) -> Self

Create with msgMaxSize capped to session maximum.

Non-compliant agents may advertise msgMaxSize values larger than they can handle. This caps the value to a known safe session limit.

Source

pub fn estimated_time(&self) -> u32

Get the estimated current engine time.

This adds elapsed local time to the synced engine time. Per RFC 3414 Section 2.2.1, the result is capped at MAX_ENGINE_TIME (2^31-1).

Note: the client does not locally increment engine_boots when the estimated time reaches MAX_ENGINE_TIME. The authoritative engine (agent) is responsible for the boots increment; the client will learn the new boots value from the agent’s next response or from a notInTimeWindow Report. Until that happens, the capped time is the best estimate the client can produce.

Source

pub fn update_time(&mut self, response_boots: u32, response_time: u32) -> bool

Update time from a response.

Per RFC 3414 Section 3.2 Step 7b, only update if:

  • Response boots > local boots, OR
  • Response boots == local boots AND response time > latest_received_engine_time
Source

pub fn resync(&mut self, boots: u32, time: u32)

Unconditionally set boots/time from an authenticated source, allowing the local notion to move backward.

Unlike update_time, which only moves forward for anti-replay, this replaces the boots/time even when the new values are lower. It must only be called after the source message’s authenticity has been verified: per RFC 3414 Section 2.3, an authenticated notInTimeWindow Report carries the authoritative engine’s true boots/time, so trusting it recovers from an agent that reset its time without incrementing boots (e.g. a restart that does not persist snmpEngineBoots).

Source

pub fn check_and_update_timeliness( &mut self, msg_boots: u32, msg_time: u32, ) -> bool

Timeliness check for messages from a remote authoritative engine (RFC 3414 Section 3.2 Step 7b, non-authoritative role).

First updates the local notion of the remote engine’s boots/time if the message is newer (see update_time), then evaluates the asymmetric time window: the message is outside the window only if the local boots notion is latched at the maximum, the message’s boots value is older than the local notion, or the message’s time is more than 150 seconds behind the local notion.

The caller must verify the message is authentic before calling this, since it mutates the timeliness state.

Returns true if the message is within the time window.

Source

pub fn is_in_time_window(&self, msg_boots: u32, msg_time: u32) -> bool

Check if a message time is within the time window.

Per RFC 3414 Section 2.2.3, a message is outside the window if:

  • Local boots is 2,147,483,647 (latched), OR
  • Message boots differs from local boots, OR
  • |message_time - local_time| > 150 seconds

Trait Implementations§

Source§

impl Clone for EngineState

Source§

fn clone(&self) -> EngineState

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EngineState

Source§

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

Formats the value using the given formatter. 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> 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