abc/lwip
1
0
Fork 0
mirror of https://git.savannah.nongnu.org/git/lwip.git synced 2025-08-03 21:14:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

Document SNMP MIB2 functions

Browse Source
This commit is contained in:
Dirk Ziegelmeier 2016-07-27 06:37:26 +02:00
parent 6bce7509f7
commit 1993b0257c
2 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/apps/snmp/snmp_mib2.c
View File

@ -33,6 +33,11 @@
* Christiaan Simons <christiaan.simons@axon.tv> * Christiaan Simons <christiaan.simons@axon.tv>
*/ */
/**
* @defgroup snmp_mib2 MIB2
* @ingroup snmp
*/
#include "lwip/apps/snmp_opts.h" #include "lwip/apps/snmp_opts.h"
#if LWIP_SNMP && SNMP_LWIP_MIB2 /* don't build if not configured for use in lwipopts.h */ #if LWIP_SNMP && SNMP_LWIP_MIB2 /* don't build if not configured for use in lwipopts.h */

21
src/apps/snmp/snmp_mib2_system.c
View File

@ -86,6 +86,7 @@ static u16_t* syslocation_wr_len = NULL; /* if writable, points to
static u16_t syslocation_bufsize = 0; /* 0=not writable */ static u16_t syslocation_bufsize = 0; /* 0=not writable */
/** /**
* @ingroup snmp_mib2
* Initializes sysDescr pointers. * Initializes sysDescr pointers.
* *
* @param str if non-NULL then copy str pointer * @param str if non-NULL then copy str pointer
@ -101,9 +102,10 @@ snmp_mib2_set_sysdescr(const u8_t *str, const u16_t *len)
} }
/** /**
* @ingroup snmp_mib2
* Initializes sysContact pointers * Initializes sysContact pointers
* *
* * @param ocstr if non-NULL then copy str pointer * @param ocstr if non-NULL then copy str pointer
* @param ocstrlen points to string length, excluding zero terminator. * @param ocstrlen points to string length, excluding zero terminator.
* if set to NULL it is assumed that ocstr is NULL-terminated. * if set to NULL it is assumed that ocstr is NULL-terminated.
* @param bufsize size of the buffer in bytes. * @param bufsize size of the buffer in bytes.
@ -124,7 +126,10 @@ snmp_mib2_set_syscontact(u8_t *ocstr, u16_t *ocstrlen, u16_t bufsize)
} }
} }
/** see \ref snmp_mib2_set_syscontact but set pointer to readonly memory */ /**
* @ingroup snmp_mib2
* see \ref snmp_mib2_set_syscontact but set pointer to readonly memory
*/
void void
snmp_mib2_set_syscontact_readonly(const u8_t *ocstr, const u16_t *ocstrlen) snmp_mib2_set_syscontact_readonly(const u8_t *ocstr, const u16_t *ocstrlen)
{ {
@ -139,6 +144,7 @@ snmp_mib2_set_syscontact_readonly(const u8_t *ocstr, const u16_t *ocstrlen)
/** /**
* @ingroup snmp_mib2
* Initializes sysName pointers * Initializes sysName pointers
* *
* @param ocstr if non-NULL then copy str pointer * @param ocstr if non-NULL then copy str pointer
@ -162,7 +168,10 @@ snmp_mib2_set_sysname(u8_t *ocstr, u16_t *ocstrlen, u16_t bufsize)
} }
} }
/** see \ref snmp_mib2_set_sysname but set pointer to readonly memory */ /**
* @ingroup snmp_mib2
* see \ref snmp_mib2_set_sysname but set pointer to readonly memory
*/
void void
snmp_mib2_set_sysname_readonly(const u8_t *ocstr, const u16_t *ocstrlen) snmp_mib2_set_sysname_readonly(const u8_t *ocstr, const u16_t *ocstrlen)
{ {
@ -176,6 +185,7 @@ snmp_mib2_set_sysname_readonly(const u8_t *ocstr, const u16_t *ocstrlen)
} }
/** /**
* @ingroup snmp_mib2
* Initializes sysLocation pointers * Initializes sysLocation pointers
* *
* @param ocstr if non-NULL then copy str pointer * @param ocstr if non-NULL then copy str pointer
@ -199,7 +209,10 @@ snmp_mib2_set_syslocation(u8_t *ocstr, u16_t *ocstrlen, u16_t bufsize)
} }
} }
/** see \ref snmp_mib2_set_syslocation but set pointer to readonly memory */ /**
* @ingroup snmp_mib2
* see \ref snmp_mib2_set_syslocation but set pointer to readonly memory
*/
void void
snmp_mib2_set_syslocation_readonly(const u8_t *ocstr, const u16_t *ocstrlen) snmp_mib2_set_syslocation_readonly(const u8_t *ocstr, const u16_t *ocstrlen)
{ {