~ubuntu-branches/ubuntu/trusty/net-snmp/trusty

.TH "mib parsing and datatype manipulation routines." 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-

.RI "typedef \fB_PrefixList\fP * \fBPrefixListPtr\fP"

.RI "typedef \fB_PrefixList\fP \fBPrefixList\fP"

.RI "\fIPrints a timetick variable into a buffer. \fP"

.RI "\fIUniversal print routine, prints a variable into a buffer according to the variable type. \fP"

.RI "\fBtree\fP * \fBget_tree_head\fP (void)"

.RI "\fIRetrieves the tree head. \fP"

.RI "\fBtree\fP * \fBnetsnmp_sprint_realloc_objid_tree\fP (u_char **buf, size_t *buf_len, size_t *out_len, int allow_realloc, int *buf_overflow, const oid *objid, size_t objidlen)"

.RI "\fIPrints a variable to stdout. \fP"

.RI "\fIPrints a variable to a file descriptor. \fP"

.RI "\fBtree\fP * \fBget_tree\fP (const oid *objid, size_t objidlen, struct \fBtree\fP *subtree)"

.RI "\fI\fBSee also:\fP

.RS 4

comments on find_best_tree_node for usage after first time. 

.RE

.PP

\fP"

.RI "\fBtree\fP * \fBtree_head\fP"

.RI "\fBtree\fP * \fBMib\fP"

Prints a hexadecimal string into a buffer. 

.PP

The characters pointed by *cp are encoded as hexadecimal string.

.PP

References netsnmp_ds_get_boolean(), and snmp_realloc().

.PP

Referenced by sprint_realloc_hexstring().

Definition at line 3578 of file mib.c.

.PP

References build_oid_noalloc(), tree::indexes, and snmp_clone_mem().

.PP

Referenced by _netsnmp_tdata_generate_index_oid(), netsnmp_table_build_oid(), and netsnmp_table_data_generate_index_oid().

Takes the value in VAR and turns it into an OID segment in var->name. 

.PP

\fBParameters:\fP

\fIvar\fP The variable.

Definition at line 3442 of file mib.c.

.PP

References netsnmp_vardata::integer, variable_list::name, variable_list::name_length, variable_list::name_loc, NULL, netsnmp_vardata::objid, SNMP_FREE, netsnmp_vardata::string, variable_list::type, variable_list::val, and variable_list::val_len.

.PP

Referenced by build_oid_noalloc().

Prints on oid description into a file descriptor. 

.PP

\fBParameters:\fP

Definition at line 4437 of file mib.c.

.PP

References NULL, SNMP_FREE, and sprint_realloc_description().

.PP

Referenced by print_description().

Prints an oid to a file descriptor. 

.PP

\fBParameters:\fP

Definition at line 3163 of file mib.c.

.PP

References netsnmp_sprint_realloc_objid_tree(), NULL, and SNMP_FREE.

.PP

Referenced by print_objid().

Prints a variable to a file descriptor. 

.PP

\fBParameters:\fP

\fIvariable\fP The variable to print. 

Definition at line 3317 of file mib.c.

.PP

References NULL, SNMP_FREE, and sprint_realloc_variable().

.PP

Referenced by print_variable().

.SS "struct \fBtree\fP* get_tree_head (void)"

.PP

Retrieves the tree head. 

.PP

\fBReturns:\fP

the tree head. 

.PP

References tree_head.

.PP

Referenced by netsnmp_config_parse_table_set(), and snmp_add_var().

.SS "int get_wild_node (const char * name, oid * objid, size_t * objidlen)"

.PP

\fBSee also:\fP

Definition at line 5457 of file mib.c.

.PP

References get_node(), tree::label, NULL, and tree_head.

.PP

Referenced by snmp_parse_oid().

Definition at line 2479 of file mib.c.

.PP

References netsnmp_get_mib_directory(), netsnmp_getenv(), netsnmp_set_mib_directory(), NULL, and SNMP_FREE.

.PP

Referenced by netsnmp_init_mib().

Definition at line 2432 of file mib.c.

.PP

References netsnmp_ds_get_string(), netsnmp_getenv(), netsnmp_set_mib_directory(), and NULL.

.PP

Referenced by netsnmp_fixup_mib_directory(), and netsnmp_init_mib().

Initialises the mib reader. 

.PP

Reads in all settings from the environment. 

.PP

Definition at line 2526 of file mib.c.

.PP

References tree::child_list, tree::label, _PrefixList::len, Mib, mib_prefixes, netsnmp_fixup_mib_directory(), netsnmp_get_mib_directory(), netsnmp_getenv(), NULL, SNMP_FREE, _PrefixList::str, and tree_head.

.PP

Referenced by init_mib(), and init_snmp().

Converts an OID to its character form. 

.PP

in example 5 . 1 . 2 . 3 . 4 . 5 = 12345

Definition at line 6244 of file mib.c.

.PP

Referenced by netsnmp_oid2str().

Converts an OID to its string form. 

.PP

in example 5 . 'h' . 'e' . 'l' . 'l' . 'o' = 'hello\\0' (null terminated)

Definition at line 6272 of file mib.c.

.PP

References netsnmp_oid2chars().

Definition at line 2377 of file mib.c.

.PP

References netsnmp_ds_get_string(), netsnmp_ds_set_string(), NULL, and SNMP_FREE.

.PP

Referenced by netsnmp_fixup_mib_directory(), and netsnmp_get_mib_directory().

Converts a string to its OID form. 

.PP

in example 'hello' = 5 . 'h' . 'e' . 'l' . 'l' . 'o'

Definition at line 6209 of file mib.c.

Prints on oid description on stdout. 

.PP

\fBSee also:\fP

Definition at line 4421 of file mib.c.

.PP

References fprint_description().

Prints the MIBs to the file fp. 

.PP

\fBParameters:\fP

Definition at line 2741 of file mib.c.

.PP

References tree_head.

Prints an oid to stdout. 

.PP

\fBParameters:\fP

Definition at line 3149 of file mib.c.

.PP

References fprint_objid().

Prints a variable to stdout. 

.PP

\fBParameters:\fP

\fIvariable\fP The variable to print. 

Definition at line 3301 of file mib.c.

.PP

References fprint_variable().

Reads an object identifier from an input string into internal OID form. 

.PP

When called, out_len must hold the maximum length of the output array.

Definition at line 2839 of file mib.c.

.PP

References get_node(), netsnmp_ds_get_boolean(), NULL, SNMP_FREE, and tree_head.

.PP

Referenced by read_config_read_objid(), and snmp_parse_oid().

Set's the printing function printomat in a subtree according it's type. 

.PP

\fBParameters:\fP

Definition at line 2762 of file mib.c.

.PP

References NULL, tree::printer, tree::printomat, sprint_realloc_bitstring(), sprint_realloc_by_type(), sprint_realloc_counter(), sprint_realloc_counter64(), sprint_realloc_gauge(), sprint_realloc_integer(), sprint_realloc_ipaddress(), sprint_realloc_networkaddress(), sprint_realloc_nsapaddress(), sprint_realloc_null(), sprint_realloc_object_identifier(), sprint_realloc_octet_string(), sprint_realloc_opaque(), sprint_realloc_timeticks(), sprint_realloc_uinteger(), and tree::type.

Definition at line 2716 of file mib.c.

.PP

References tree::label, Mib, NULL, SNMP_FREE, and tree_head.

.PP

Referenced by snmp_shutdown().

Prints out a help usage for the in* toggle options. 

.PP

\fBParameters:\fP

Definition at line 2289 of file mib.c.

Given a string, parses an oid out of it (if possible). 

.PP

It will try to parse it based on predetermined configuration if present or by every method possible otherwise. If a suffix has been registered using NETSNMP_DS_LIB_OIDSUFFIX, it will be appended to the input string before processing.

Definition at line 5815 of file mib.c.

.PP

References clear_tree_flags(), get_node(), get_wild_node(), netsnmp_ds_get_boolean(), netsnmp_ds_get_string(), NULL, read_objid(), and tree_head.

.PP

Referenced by netsnmp_config_parse_table_set(), and snmp_add_var().

Prints an ascii string into a buffer. 

.PP

The characters pointed by *cp are encoded as an ascii string.

.PP

References snmp_realloc().

.PP

Referenced by asn_build_string(), asn_parse_string(), snprint_asciistring(), and sprint_realloc_octet_string().

Fallback routine for a bad type, prints 'Variable has bad type' into a buffer. 

.PP

If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)

\fIvar\fP The variable to encode. 

\fIenums\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References snmp_strcat().

.PP

Referenced by snprint_badtype(), and sprint_realloc_by_type().

Prints a bit string into a buffer. 

.PP

If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)

\fIvar\fP The variable to encode. 

\fIenums\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References netsnmp_vardata::bitstring, enum_list::label, netsnmp_ds_get_boolean(), enum_list::next, NULL, snmp_strcat(), sprint_realloc_by_type(), sprint_realloc_hexstring(), variable_list::type, variable_list::val, variable_list::val_len, and enum_list::value.

.PP

Referenced by set_function(), snprint_bitstring(), and sprint_realloc_by_type().

Universal print routine, prints a variable into a buffer according to the variable type. 

.PP

If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)

\fIvar\fP The variable to encode. 

\fIenums\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References sprint_realloc_badtype(), sprint_realloc_bitstring(), sprint_realloc_counter(), sprint_realloc_counter64(), sprint_realloc_gauge(), sprint_realloc_integer(), sprint_realloc_ipaddress(), sprint_realloc_null(), sprint_realloc_object_identifier(), sprint_realloc_octet_string(), sprint_realloc_opaque(), sprint_realloc_timeticks(), sprint_realloc_uinteger(), and variable_list::type.

.PP

Referenced by set_function(), snprint_by_type(), sprint_realloc_bitstring(), sprint_realloc_counter(), sprint_realloc_counter64(), sprint_realloc_gauge(), sprint_realloc_integer(), sprint_realloc_ipaddress(), sprint_realloc_networkaddress(), sprint_realloc_nsapaddress(), sprint_realloc_null(), sprint_realloc_object_identifier(), sprint_realloc_octet_string(), sprint_realloc_opaque(), sprint_realloc_timeticks(), sprint_realloc_uinteger(), sprint_realloc_value(), sprint_realloc_variable(), and table_helper_handler().

Prints a counter value into a buffer. 

.PP

If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)

\fIvar\fP The variable to encode. 

\fIenums\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References netsnmp_vardata::integer, netsnmp_ds_get_boolean(), NULL, snmp_strcat(), sprint_realloc_by_type(), variable_list::type, and variable_list::val.

.PP

Referenced by set_function(), snprint_counter(), and sprint_realloc_by_type().

Prints a counter into a buffer. 

.PP

The variable var is encoded as a counter value.

\fIvar\fP The variable to encode. 

\fIenums\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References netsnmp_vardata::counter64, netsnmp_ds_get_boolean(), NULL, snmp_cstrcat, sprint_realloc_by_type(), variable_list::type, and variable_list::val.

.PP

Referenced by set_function(), snprint_counter64(), sprint_realloc_by_type(), and sprint_realloc_opaque().

Prints a gauge value into a buffer. 

.PP

If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)

\fIvar\fP The variable to encode. 

\fIenums\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References netsnmp_vardata::integer, netsnmp_ds_get_boolean(), NULL, snmp_strcat(), sprint_realloc_by_type(), sprint_realloc_hinted_integer(), variable_list::type, and variable_list::val.

.PP

Referenced by set_function(), snprint_gauge(), and sprint_realloc_by_type().

Prints an integer according to the hint into a buffer. 

.PP

If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)

\fIval\fP The variable to encode. 

\fIdecimaltype\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References snmp_strcat().

.PP

Referenced by snprint_hinted_integer(), and sprint_realloc_gauge().

Prints an integer into a buffer. 

.PP

If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)

\fIvar\fP The variable to encode. 

\fIenums\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References netsnmp_vardata::integer, enum_list::label, netsnmp_ds_get_boolean(), enum_list::next, NULL, snmp_strcat(), sprint_realloc_by_type(), variable_list::type, variable_list::val, and enum_list::value.

.PP

Referenced by set_function(), snprint_integer(), and sprint_realloc_by_type().

Prints an ip-address into a buffer. 

.PP

If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)

\fIvar\fP The variable to encode. 

\fIenums\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References netsnmp_ds_get_boolean(), NULL, snmp_realloc(), snmp_strcat(), sprint_realloc_by_type(), netsnmp_vardata::string, variable_list::type, and variable_list::val.

.PP

Referenced by set_function(), snprint_ipaddress(), and sprint_realloc_by_type().

Prints a network address into a buffer. 

.PP

If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)

\fIvar\fP The variable to encode. 

\fIenums\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References netsnmp_ds_get_boolean(), NULL, snmp_realloc(), snmp_strcat(), sprint_realloc_by_type(), netsnmp_vardata::string, variable_list::type, variable_list::val, and variable_list::val_len.

.PP

Referenced by set_function(), and snprint_networkaddress().

Prints a null value into a buffer. 

.PP

If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)

\fIvar\fP The variable to encode. 

\fIenums\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References netsnmp_ds_get_boolean(), NULL, snmp_strcat(), sprint_realloc_by_type(), and variable_list::type.

.PP

Referenced by set_function(), snprint_null(), and sprint_realloc_by_type().

Prints an object identifier into a buffer. 

.PP

If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)

\fIvar\fP The variable to encode. 

\fIenums\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References netsnmp_ds_get_boolean(), netsnmp_sprint_realloc_objid_tree(), NULL, netsnmp_vardata::objid, snmp_strcat(), sprint_realloc_by_type(), variable_list::type, variable_list::val, and variable_list::val_len.

.PP

Referenced by set_function(), snprint_object_identifier(), and sprint_realloc_by_type().

Prints an octet string into a buffer. 

.PP

The variable var is encoded as octet string.

\fIvar\fP The variable to encode. 

\fIenums\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References netsnmp_ds_get_boolean(), netsnmp_ds_get_int(), NULL, snmp_cstrcat, SNMP_MIN, snmp_realloc(), sprint_realloc_asciistring(), sprint_realloc_by_type(), sprint_realloc_hexstring(), sprint_realloc_octet_string(), netsnmp_vardata::string, variable_list::type, variable_list::val, and variable_list::val_len.

.PP

Referenced by set_function(), snprint_octet_string(), sprint_realloc_by_type(), and sprint_realloc_octet_string().

Prints an object identifier into a buffer. 

.PP

If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)

\fIvar\fP The variable to encode. 

\fIenums\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References netsnmp_ds_get_boolean(), NULL, snmp_cstrcat, snmp_strcat(), sprint_realloc_by_type(), sprint_realloc_counter64(), sprint_realloc_hexstring(), netsnmp_vardata::string, variable_list::type, variable_list::val, and variable_list::val_len.

.PP

Referenced by set_function(), snprint_opaque(), and sprint_realloc_by_type().

Prints a timetick variable into a buffer. 

.PP

If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)

\fIvar\fP The variable to encode. 

\fIenums\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References netsnmp_vardata::integer, netsnmp_ds_get_boolean(), NULL, snmp_strcat(), sprint_realloc_by_type(), variable_list::type, and variable_list::val.

.PP

Referenced by set_function(), snprint_timeticks(), and sprint_realloc_by_type().

Prints an unsigned integer into a buffer. 

.PP

If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)

\fIvar\fP The variable to encode. 

\fIenums\fP The enumeration ff this variable is enumerated. may be NULL. 

.PP

References netsnmp_vardata::integer, enum_list::label, netsnmp_ds_get_boolean(), enum_list::next, NULL, snmp_strcat(), sprint_realloc_by_type(), variable_list::type, variable_list::val, and enum_list::value.

.PP

Referenced by set_function(), snprint_uinteger(), and sprint_realloc_by_type().

Converts timeticks to hours, minutes, seconds string. 

.PP

CMU compatible does not show centiseconds.

Definition at line 5780 of file mib.c.

.PP

References uptime_string_n().

.SS "\fBPrefixList\fP \fBmib_prefixes\fP[]"

.PP

\fBInitial value:\fP

.PP

Referenced by netsnmp_init_mib(), and netsnmp_sprint_realloc_objid_tree().