Rtos API example

Embed: (wiki syntax)

« Back to documentation index

snmpv3.h File Reference

snmpv3.h File Reference

Additional SNMPv3 functionality RFC3414 and RFC3826. More...

Go to the source code of this file.

Functions

void snmpv3_get_engine_id (const char **id, u8_t *len)
 Get engine ID from persistence.
err_t snmpv3_set_engine_id (const char *id, u8_t len)
 Store engine ID in persistence.
u32_t snmpv3_get_engine_boots (void)
 Get engine boots from persistence.
void snmpv3_set_engine_boots (u32_t boots)
 Store engine boots in persistence.
u32_t snmpv3_get_engine_time (void)
 RFC3414 2.2.2.
void snmpv3_reset_engine_time (void)
 Reset current engine time to 0.
err_t snmpv3_get_user (const char *username, u8_t *auth_algo, u8_t *auth_key, u8_t *priv_algo, u8_t *priv_key)
void snmpv3_engine_id_changed (void)
 Call this if engine has been changed.

Detailed Description

Additional SNMPv3 functionality RFC3414 and RFC3826.

Definition in file snmpv3.h.


Function Documentation

void snmpv3_engine_id_changed ( void   )

Call this if engine has been changed.

Has to reset boots, see below

Definition at line 50 of file lwip_snmpv3.c.

u32_t snmpv3_get_engine_boots ( void   )

Get engine boots from persistence.

Must be increased on each boot.

Returns:

Definition at line 111 of file lwip_snmpv3_dummy.c.

void snmpv3_get_engine_id ( const char **  id,
u8_t *  len 
)

Get engine ID from persistence.

Parameters:
id
len

Definition at line 87 of file lwip_snmpv3_dummy.c.

u32_t snmpv3_get_engine_time ( void   )

RFC3414 2.2.2.

Once the timer reaches 2147483647 it gets reset to zero and the engine boot ups get incremented.

Definition at line 132 of file lwip_snmpv3_dummy.c.

err_t snmpv3_get_user ( const char *  username,
u8_t *  auth_algo,
u8_t *  auth_key,
u8_t *  priv_algo,
u8_t *  priv_key 
)
Parameters:
usernameis a pointer to a string.
auth_algois a pointer to u8_t. The implementation has to set this if user was found.
auth_keyis a pointer to a pointer to a string. Implementation has to set this if user was found.
priv_algois a pointer to u8_t. The implementation has to set this if user was found.
priv_keyis a pointer to a pointer to a string. Implementation has to set this if user was found.

Definition at line 51 of file lwip_snmpv3_dummy.c.

void snmpv3_reset_engine_time ( void   )

Reset current engine time to 0.

Definition at line 141 of file lwip_snmpv3_dummy.c.

void snmpv3_set_engine_boots ( u32_t  boots )

Store engine boots in persistence.

Parameters:
boots

Definition at line 121 of file lwip_snmpv3_dummy.c.

err_t snmpv3_set_engine_id ( const char *  id,
u8_t  len 
)

Store engine ID in persistence.

Parameters:
id
len

Definition at line 99 of file lwip_snmpv3_dummy.c.