Rtos API example

Embed: (wiki syntax)

« Back to documentation index

snmp_node_instance Struct Reference

snmp_node_instance Struct Reference

SNMP node instance. More...

#include <snmp_core.h>

Data Fields

struct snmp_nodenode
 prefilled with the node, get_instance() is called on; may be changed by user to any value to pass an arbitrary node between calls to get_instance() and get_value/test_value/set_value
struct snmp_obj_id instance_oid
 prefilled with the instance id requested; for get_instance() this is the exact oid requested; for get_next_instance() this is the relative starting point, stack expects relative oid of next node here
u8_t asn1_type
 ASN type for this object (see snmp_asn1.h for definitions)
snmp_access_t access
 one out of instance access types defined above (SNMP_NODE_INSTANCE_READ_ONLY,...)
node_instance_get_value_method get_value
 returns object value for the given object identifier.
node_instance_set_test_method set_test
 tests length and/or range BEFORE setting
node_instance_set_value_method set_value
 sets object value, only called when set_test() was successful
node_instance_release_method release_instance
 called in any case when the instance is not required anymore by stack (useful for freeing memory allocated in get_instance/get_next_instance methods)
union snmp_variant_value reference
 reference to pass arbitrary value between calls to get_instance() and get_value/test_value/set_value
u32_t reference_len
 see reference (if reference is a pointer, the length of underlying data may be stored here or anything else)

Detailed Description

SNMP node instance.

Definition at line 192 of file snmp_core.h.


Field Documentation

one out of instance access types defined above (SNMP_NODE_INSTANCE_READ_ONLY,...)

Definition at line 202 of file snmp_core.h.

u8_t asn1_type

ASN type for this object (see snmp_asn1.h for definitions)

Definition at line 200 of file snmp_core.h.

node_instance_get_value_method get_value

returns object value for the given object identifier.

Return values <0 to indicate an error

Definition at line 205 of file snmp_core.h.

prefilled with the instance id requested; for get_instance() this is the exact oid requested; for get_next_instance() this is the relative starting point, stack expects relative oid of next node here

Definition at line 197 of file snmp_core.h.

struct snmp_node* node

prefilled with the node, get_instance() is called on; may be changed by user to any value to pass an arbitrary node between calls to get_instance() and get_value/test_value/set_value

Definition at line 195 of file snmp_core.h.

reference to pass arbitrary value between calls to get_instance() and get_value/test_value/set_value

Definition at line 214 of file snmp_core.h.

see reference (if reference is a pointer, the length of underlying data may be stored here or anything else)

Definition at line 216 of file snmp_core.h.

node_instance_release_method release_instance

called in any case when the instance is not required anymore by stack (useful for freeing memory allocated in get_instance/get_next_instance methods)

Definition at line 211 of file snmp_core.h.

node_instance_set_test_method set_test

tests length and/or range BEFORE setting

Definition at line 207 of file snmp_core.h.

node_instance_set_value_method set_value

sets object value, only called when set_test() was successful

Definition at line 209 of file snmp_core.h.