SNMP Public API

This group contains all the functions that can be used outside the OS level. More...

Macros
#define	OID(name, ...)
	Initializes statically an oid with the "null" terminator. More...
#define	MIB_RESOURCE(name, handler, ...)
	Declare a MIB resource. More...

Typedefs
typedef void(*	snmp_mib_resource_handler_t) (snmp_varbind_t *varbind, snmp_oid_t *oid)
	The MIB resource handler typedef. More...
typedef struct snmp_mib_resource_s	snmp_mib_resource_t
	The MIB Resource struct.

Functions
void	snmp_api_set_string (snmp_varbind_t *varbind, snmp_oid_t *oid, char *string)
	Function to set a varbind with a string. More...
void	snmp_api_set_time_ticks (snmp_varbind_t *varbind, snmp_oid_t *oid, uint32_t integer)
	Function to set a varbind with a time tick. More...
void	snmp_api_set_oid (snmp_varbind_t *varbind, snmp_oid_t *oid, snmp_oid_t *ret_oid)
	Function to set a varbind with a oid. More...
void	snmp_api_add_resource (snmp_mib_resource_t *new_resource)
	Function to add a new resource. More...

Detailed Description

This group contains all the functions that can be used outside the OS level.

Macro Definition Documentation

MIB_RESOURCE

#define MIB_RESOURCE	(		name,
			handler,
			...
	)

Value:

snmp_mib_resource_t name = { \
    NULL, \
    { \
      .data = { __VA_ARGS__ }, \
      .length = (sizeof((uint32_t[]){ __VA_ARGS__ }) / sizeof(uint32_t)) \
    }, \
    handler \
  };

Declare a MIB resource.

Parameters

name	A name for the MIB resource
handler	The handler function for this resource
...	The OID (comma-separated)

Definition at line 92 of file snmp-api.h.

OID

#define OID	(		name,
			...
	)

Value:

static snmp_oid_t name = { \
    .data = { __VA_ARGS__ }, \
    .length = (sizeof((uint32_t[]){ __VA_ARGS__ }) / sizeof(uint32_t)) \
  };

Initializes statically an oid with the "null" terminator.

Remarks

This should be used inside handlers when declaring an oid

Parameters

name	A name for the oid
...	The Oid (comma-separeted)

Definition at line 79 of file snmp-api.h.

Typedef Documentation

snmp_mib_resource_handler_t

typedef void(* snmp_mib_resource_handler_t) (snmp_varbind_t *varbind, snmp_oid_t *oid)

The MIB resource handler typedef.

Parameters

varbind	The varbind that is being changed
oid	The oid from the resource

Definition at line 64 of file snmp-api.h.

Function Documentation

snmp_api_add_resource()

void snmp_api_add_resource

(

snmp_mib_resource_t *

new_resource

)

Function to add a new resource.

Parameters

new_resource

The resource

Definition at line 74 of file snmp-api.c.

References snmp_mib_add().

snmp_api_set_oid()

void snmp_api_set_oid	(	snmp_varbind_t *	varbind,
		snmp_oid_t *	oid,
		snmp_oid_t *	ret_oid
	)

Function to set a varbind with a oid.

This function should be used inside a handler to set the varbind correctly

Parameters

varbind	The varbind from the handler
oid	The oid from the handler
ret_oid	The oid value

Definition at line 66 of file snmp-api.c.

References BER_DATA_TYPE_OBJECT_IDENTIFIER, snmp_varbind_s::oid, snmp_varbind_s::value, and snmp_varbind_s::value_type.

snmp_api_set_string()

void snmp_api_set_string	(	snmp_varbind_t *	varbind,
		snmp_oid_t *	oid,
		char *	string
	)

Function to set a varbind with a string.

This function should be used inside a handler to set the varbind correctly

Parameters

varbind	The varbind from the handler
oid	The oid from the handler
string	The string

Definition at line 49 of file snmp-api.c.

References BER_DATA_TYPE_OCTET_STRING, snmp_varbind_s::oid, snmp_varbind_s::string, snmp_varbind_s::value, and snmp_varbind_s::value_type.

snmp_api_set_time_ticks()

void snmp_api_set_time_ticks	(	snmp_varbind_t *	varbind,
		snmp_oid_t *	oid,
		uint32_t	integer
	)

Function to set a varbind with a time tick.

This function should be used inside a handler to set the varbind correctly

Parameters

varbind	The varbind from the handler
oid	The oid from the handler
integer	The time tick value

Definition at line 58 of file snmp-api.c.

References BER_DATA_TYPE_TIMETICKS, snmp_varbind_s::integer, snmp_varbind_s::oid, snmp_varbind_s::value, and snmp_varbind_s::value_type.