3.3.0.0R11
Software Development Kit
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules
Snmp

SNMP Agent MIB registration. More...

Data Structures

struct  MIB
 
struct  MIBTAB
 
struct  MIBVAR
 
struct  OID
 

Enumerations

enum  SnmpOperationType
 

Maximums

This define specifies the maximum number of keys. For example, the standard MIB-II includes the tcpConnTable which has four values in its INDEX clause. When encoded in the identifier, two of those index values may be 8 bytes each and the other two may be 3 bytes each for a total of 22 bytes. These values cannot be changed by the SDK.

#define MAXKEY   4
 
#define MAXKLEN   22
 
#define MAXOID   32
 

MIB variable characteristics.

These defines are options used to define the charactistics for a MIB variable.

#define MIBOPT_IMMED   0x01
 
#define MIBOPT_IMMED2   0x02
 
#define MIBOPT_BASE1   0x03
 
#define MIBOPT_SCALAR   0x04
 
#define MIBOPT_W   0x08
 
#define MIBOPT_SX   0x10
 
#define MIBOPT_NWORDER   0x20
 
#define MIBOPT_CAR   0x40
 
#define MIBOPT_CAW   0x80
 

MIB variable types.

These defines are the MIB variable types.

#define SNMP_Integer   0x02
 
#define SNMP_String   0x04
 
#define SNMP_Null   0x05
 
#define SNMP_Identifier   0x06
 
#define SNMP_OctetString   0x14
 
#define SNMP_Sequence   0x30
 
#define SNMP_IpAddress   0x40
 
#define SNMP_Counter   0x41
 
#define SNMP_Counter32   0x41
 
#define SNMP_Gauge   0x42
 
#define SNMP_Ticks   0x43
 
#define SNMP_Uinteger32   0x47
 

Return Values.

These defines are the return values that can be returned by the various MIB handler callback functions.

#define SNMP_RV_ok   0
 
#define SNMP_RV_tooBig   1
 
#define SNMP_RV_noSuchName   2
 
#define SNMP_RV_badValue   3
 
#define SNMP_RV_readOnly   4
 
#define SNMP_RV_genErr   5
 
#define SNMP_RV_noAccess   6
 
#define SNMP_RV_wrongType   7
 
#define SNMP_RV_wrongLength   8
 
#define SNMP_RV_wrongEncoding   9
 
#define SNMP_RV_wrongValue   10
 
#define SNMP_RV_noCreation   11
 
#define SNMP_RV_inconsistentValue   12
 
#define SNMP_RV_resourceUnavailable   13
 
#define SNMP_RV_commitFailed   14
 
#define SNMP_RV_undoFailed   15
 
#define SNMP_RV_authorizationError   16
 
#define SNMP_RV_notWritable   17
 
#define SNMP_RV_inconsistentName   18
 

Detailed Description

SNMP Agent MIB registration.

This module is used to register MIB handlers for custom MIB implementations.

Macro Definition Documentation

#define MAXOID   32

This define specifies the maximum length of an OID in encoded format. This value cannot be changed by the SDK.

#define MIBOPT_BASE1   0x03

base 0 in data space, base 1 in MIB

#define MIBOPT_CAR   0x40

call application cbk for read

#define MIBOPT_CAW   0x80

call application cbk for write

#define MIBOPT_IMMED   0x01

immediate value located in (MIBVAR->len)

#define MIBOPT_IMMED2   0x02

immediate value (MIBVAR->type + MIBVAR->len)

#define MIBOPT_NWORDER   0x20

network byte ordering for basic type

#define MIBOPT_SCALAR   0x04

table not indexed directly (no offset)

#define MIBOPT_SX   0x10

sequential table index inferred

#define MIBOPT_W   0x08

writes are allowed

#define SNMP_OctetString   0x14

Uses length, not zero termination. Externally seen as 0x04.

Enumeration Type Documentation

This enum defines the SNMP Operation of the request.