1
.TH "storage space for defaults" 3 "19 Mar 2004" "net-snmp" \" -*- nroff -*-
5
storage space for defaults \- The purpose of the default storage is three-fold:.
11
.RI "struct \fBnetsnmp_ds_read_config_s\fP"
18
.RI "int \fBnetsnmp_ds_set_boolean\fP (int storeid, int which, int value)"
20
.RI "\fIStores 'true' or 'false' given an int value for value into netsnmp_ds_booleans[store][which] slot.\fP"
22
.SH "DETAILED DESCRIPTION"
24
The purpose of the default storage is three-fold:.
26
1) To create a global storage space without creating a whole bunch of globally accessible variables or a whole bunch of access functions to work with more privately restricted variables.
28
2) To provide a single location where the thread lock- ing needs to be implemented. At the time of this writing, however, thread locking is not yet in place.
30
3) To reduce the number of cross dependencies between code pieces that may or may not be linked together in the long run. This provides for a single loca- tion in which configuration data, for example, can be stored for a separate section of code that may not be linked in to the application in question.
32
The functions defined here implement these goals.
34
Currently, three data types are supported: booleans, inte- gers, and strings. Each of these data types have separate storage spaces. In addition, the storage space for each data type is divided further by the application level. Currently, there are two storage spaces. The first is reserved for the SNMP library itself. The second is intended for use in applications and is not modified or checked by the library, and, therefore, this is the space usable by you.
36
These definitions correspond with the 'storid' argument to the API
38
define NETSNMP_DS_LIBRARY_ID 0
40
define NETSNMP_DS_APPLICATION_ID 1
42
define NETSNMP_DS_TOKEN_ID 2
44
These definitions correspond with the 'which' argument to the API, when the storeid argument is NETSNMP_DS_LIBRARY_ID
49
define NETSNMP_DS_LIB_MIB_ERRORS 0
51
define NETSNMP_DS_LIB_SAVE_MIB_DESCRS 1
53
define NETSNMP_DS_LIB_MIB_COMMENT_TERM 2
55
define NETSNMP_DS_LIB_MIB_PARSE_LABEL 3
57
define NETSNMP_DS_LIB_DUMP_PACKET 4
59
define NETSNMP_DS_LIB_LOG_TIMESTAMP 5
61
define NETSNMP_DS_LIB_DONT_READ_CONFIGS 6
63
define NETSNMP_DS_LIB_MIB_REPLACE 7 replace objects from latest module
65
define NETSNMP_DS_LIB_PRINT_NUMERIC_ENUM 8 print only numeric enum values
67
define NETSNMP_DS_LIB_PRINT_NUMERIC_OIDS 9 print only numeric enum values
69
define NETSNMP_DS_LIB_DONT_BREAKDOWN_OIDS 10 dont print oid indexes specially
71
define NETSNMP_DS_LIB_ALARM_DONT_USE_SIG 11 don't use the alarm() signal
73
define NETSNMP_DS_LIB_PRINT_FULL_OID 12 print fully qualified oids
75
define NETSNMP_DS_LIB_QUICK_PRINT 13 print very brief output for parsing
77
define NETSNMP_DS_LIB_RANDOM_ACCESS 14 random access to oid labels
79
define NETSNMP_DS_LIB_REGEX_ACCESS 15 regex matching to oid labels
81
define NETSNMP_DS_LIB_DONT_CHECK_RANGE 16 don't check values for ranges on send
83
define NETSNMP_DS_LIB_NO_TOKEN_WARNINGS 17 no warn about unknown config tokens
85
define NETSNMP_DS_LIB_NUMERIC_TIMETICKS 18 print timeticks as a number
87
define NETSNMP_DS_LIB_ESCAPE_QUOTES 19 shell escape quote marks in oids
89
define NETSNMP_DS_LIB_REVERSE_ENCODE 20 encode packets from back to front
91
define NETSNMP_DS_LIB_PRINT_BARE_VALUE 21 just print value (not OID = value)
93
define NETSNMP_DS_LIB_EXTENDED_INDEX 22 print extended index format [x1][x2]
95
define NETSNMP_DS_LIB_PRINT_HEX_TEXT 23 print ASCII text along with hex strings
97
define NETSNMP_DS_LIB_PRINT_UCD_STYLE_OID 24 print OID's using the UCD-style prefix suppression
99
define NETSNMP_DS_LIB_READ_UCD_STYLE_OID 25 require top-level OIDs to be prefixed with a dot
101
define NETSNMP_DS_LIB_HAVE_READ_PREMIB_CONFIG 26 have the pre-mib parsing config tokens been processed
103
define NETSNMP_DS_LIB_HAVE_READ_CONFIG 27 have the config tokens been processed
105
define NETSNMP_DS_LIB_QUICKE_PRINT 28
107
define NETSNMP_DS_LIB_DONT_PRINT_UNITS 29 don't print UNITS suffix
109
define NETSNMP_DS_LIB_NO_DISPLAY_HINT 30 don't apply DISPLAY-HINTs
111
define NETSNMP_DS_LIB_16BIT_IDS 31 restrict requestIDs, etc to 16-bit values
116
define NETSNMP_DS_LIB_MIB_WARNINGS 0
118
define NETSNMP_DS_LIB_SECLEVEL 1
123
define NETSNMP_DS_LIB_SECNAME 0
125
define NETSNMP_DS_LIB_CONTEXT 1
127
define NETSNMP_DS_LIB_PASSPHRASE 2
129
define NETSNMP_DS_LIB_AUTHPASSPHRASE 3
131
define NETSNMP_DS_LIB_PRIVPASSPHRASE 4
133
define NETSNMP_DS_LIB_OPTIONALCONFIG 5
135
define NETSNMP_DS_LIB_APPTYPE 6
137
define NETSNMP_DS_LIB_COMMUNITY 7
139
define NETSNMP_DS_LIB_PERSISTENT_DIR 8
141
define NETSNMP_DS_LIB_CONFIGURATION_DIR 9
143
define NETSNMP_DS_LIB_SECMODEL 10
145
define NETSNMP_DS_LIB_MIBDIRS 11
147
.SH "FUNCTION DOCUMENTATION"
149
.SS "int netsnmp_ds_set_boolean (int storeid, int which, int value)"
151
Stores 'true' or 'false' given an int value for value into netsnmp_ds_booleans[store][which] slot.
157
an index to the boolean storage container's first index(store)
160
an index to the boolean storage container's second index(which)
163
if > 0, 'true' is set into the slot otherwise 'false'
167
Returns SNMPPERR_GENERR if the storeid and which parameters do not correspond to a valid slot, or SNMPERR_SUCCESS otherwise.
169
Definition at line 183 of file default_store.c.
171
Referenced by init_agent().
added
removed
man/netsnmp_default_store.3
