documentation update
git-svn-id: file:///home/hardaker/lib/sf-bkups/net-snmp-convert-svnrepo/branches/V5-4-patches@17802 06827809-a52a-0410-b366-d66718629ded
diff --git a/man/netsnmp_agent.3 b/man/netsnmp_agent.3
index 9f2a7c7..4feb208 100644
--- a/man/netsnmp_agent.3
+++ b/man/netsnmp_agent.3
@@ -1,20 +1,20 @@
-.TH "The Net-SNMP agent" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "The Net-SNMP agent" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-The Net-SNMP agent \- The snmp agent responds to SNMP queries from management stations.
-
+The Net-SNMP agent \-
.PP
+The snmp agent responds to SNMP queries from management stations.
+
.SS "Modules"
.in +1c
.ti -1c
.RI "\fBNet-SNMP Agent handler and extensibility API\fP"
.br
-.RI "\fIThe basic theory goes something like this: In the past, with the original mib module api (which derived from the original CMU SNMP code) the underlying mib modules were passed very little information (only the truly most basic information about a request). \fP"
.PP
-.in +1c
+.RI "\fIThe basic theory goes something like this: In the past, with the original mib \fBmodule\fP api (which derived from the original CMU SNMP code) the underlying mib modules were passed very little information (only the truly most basic information about a request). \fP"
.ti -1c
.RI "\fBMaintain a registry of MIB subtrees, together with related information regarding mibmodule, sessions, etc\fP"
.br
@@ -28,5 +28,6 @@
.SH "Detailed Description"
.PP
The snmp agent responds to SNMP queries from management stations.
-.PP
-
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_agent_registry.3 b/man/netsnmp_agent_registry.3
index 8a692f5..7f2d99a 100644
--- a/man/netsnmp_agent_registry.3
+++ b/man/netsnmp_agent_registry.3
@@ -1,4 +1,4 @@
-.TH "Maintain a registry of MIB subtrees, together with related information regarding mibmodule, sessions, etc" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "Maintain a registry of MIB subtrees, together with related information regarding mibmodule, sessions, etc" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -30,10 +30,10 @@
.in +1c
.ti -1c
-.RI "typedef \fBlookup_cache_s\fP \fBlookup_cache\fP"
+.RI "typedef struct \fBlookup_cache_s\fP \fBlookup_cache\fP"
.br
.ti -1c
-.RI "typedef \fBlookup_cache_context_s\fP \fBlookup_cache_context\fP"
+.RI "typedef struct \fBlookup_cache_context_s\fP \fBlookup_cache_context\fP"
.br
.in -1c
.SS "Functions"
@@ -210,16 +210,14 @@
.RI "int \fBexternal_signal_scheduled\fP [NUM_EXTERNAL_SIGS]"
.br
.ti -1c
-.RI "void(*[NUM_EXTERNAL_SIGS]) \fBexternal_signal_handler\fP (int)"
+.RI "void(* \fBexternal_signal_handler\fP [NUM_EXTERNAL_SIGS])(int)"
.br
.in -1c
.SH "Function Documentation"
.PP
.SS "int netsnmp_acm_check_subtree (\fBnetsnmp_pdu\fP * pdu, oid * name, size_t namelen)"
.PP
-checks to see if everything within a given subtree is either: in view, not in view, or possibly both.
-.PP
-If the entire subtree is not-in-view we can use this information to skip calling the sub-handlers entirely.
+checks to see if everything within a given subtree is either: in view, not in view, or possibly both. If the entire subtree is not-in-view we can use this information to skip calling the sub-handlers entirely.
.PP
\fBReturns:\fP
.RS 4
@@ -229,15 +227,9 @@
.PP
Definition at line 1323 of file agent_registry.c.
-.PP
-References view_parameters::check_subtree, view_parameters::errorcode, snmp_pdu::flags, view_parameters::name, view_parameters::namelen, view_parameters::pdu, snmp_call_callbacks(), and snmp_pdu::version.
-.PP
-Referenced by netsnmp_add_varbind_to_cache().
.SS "int netsnmp_get_lookup_cache_size (void)"
.PP
-retrieves the current value of the lookup cache size
-.PP
-\fBReturns:\fP
+retrieves the current value of the lookup cache size \fBReturns:\fP
.RS 4
the current lookup cache size
.RE
@@ -245,15 +237,9 @@
.PP
Definition at line 1396 of file agent_registry.c.
-.PP
-References lookup_cache_size.
-.PP
-Referenced by netsnmp_register_mib(), and unregister_mib_context().
.SS "void netsnmp_set_lookup_cache_size (int newsize)"
.PP
-set the lookup cache size for optimized agent registration performance.
-.PP
-\fBParameters:\fP
+set the lookup cache size for optimized agent registration performance. \fBParameters:\fP
.RS 4
\fInewsize\fP set to the maximum size of a cache for a given context. Set to 0 to completely disable caching, or to -1 to set to the default cache size (8), or to a number of your chosing. The rough guide is that it should be equal to the maximum number of simultanious managers you expect to talk to the agent (M) times 80% (or so, he says randomly) the average number (N) of varbinds you expect to receive in a given request for a manager. ie, M times N. Bigger does NOT necessarily mean better. Certainly 16 should be an upper limit. 32 is the hard coded limit.
.RE
@@ -261,15 +247,9 @@
.PP
Definition at line 1383 of file agent_registry.c.
-.PP
-References lookup_cache_size, SUBTREE_DEFAULT_CACHE_SIZE, and SUBTREE_MAX_CACHE_SIZE.
-.PP
-Referenced by init_master_agent(), netsnmp_register_mib(), and unregister_mib_context().
.SS "int unregister_mib_context (oid * name, size_t len, int priority, int range_subid, oid range_ubound, const char * context)"
.PP
-Unregisters an OID that has an associated context name value.
-.PP
-Typically used when a module has multiple contexts defined. The parameters priority, range_subid, and range_ubound should be used in conjunction with agentx, see RFC 2741, otherwise these values should always be 0.
+Unregisters an OID that has an associated context name value. Typically used when a \fBmodule\fP has multiple contexts defined. The parameters priority, range_subid, and range_ubound should be used in conjunction with agentx, see RFC 2741, otherwise these values should always be 0.
.PP
\fBParameters:\fP
.RS 4
@@ -293,7 +273,6 @@
.PP
Definition at line 969 of file agent_registry.c.
-.PP
-References netsnmp_subtree_s::children, netsnmp_get_lookup_cache_size(), netsnmp_oid_equals(), netsnmp_set_lookup_cache_size(), netsnmp_subtree_find(), netsnmp_subtree_find_first(), netsnmp_subtree_free(), netsnmp_subtree_unload(), netsnmp_subtree_s::next, and NULL.
-.PP
-Referenced by netsnmp_register_mib(), netsnmp_unregister_handler(), remove_tree_entry(), and unregister_mib_range().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_agent_trap.3 b/man/netsnmp_agent_trap.3
index 118ea9a..2a41c77 100644
--- a/man/netsnmp_agent_trap.3
+++ b/man/netsnmp_agent_trap.3
@@ -1,4 +1,4 @@
-.TH "Trap generation routines for mib modules to use" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "Trap generation routines for mib modules to use" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -80,7 +80,7 @@
.ti -1c
.RI "void \fBsend_v2trap\fP (\fBnetsnmp_variable_list\fP *vars)"
.br
-.RI "\fIUses the supplied list of variable bindings to form an SNMPv2 trap, which is sent to SNMPv2-capable sinks on the configured list. \fP"
+.RI "\fIUses the supplied list of \fBvariable\fP bindings to form an SNMPv2 trap, which is sent to SNMPv2-capable sinks on the configured list. \fP"
.ti -1c
.RI "void \fBsend_trap_pdu\fP (\fBnetsnmp_pdu\fP *pdu)"
.br
@@ -110,10 +110,10 @@
.in +1c
.ti -1c
-.RI "\fBtrap_sink\fP * \fBsinks\fP = NULL"
+.RI "struct \fBtrap_sink\fP * \fBsinks\fP = NULL"
.br
.ti -1c
-.RI "timeval \fBstarttime\fP"
+.RI "struct timeval \fBstarttime\fP"
.br
.ti -1c
.RI "oid \fBobjid_enterprisetrap\fP [] = { NETSNMP_NOTIFICATION_MIB }"
@@ -195,15 +195,9 @@
Captures responses or the lack there of from INFORMs that were sent 1) a response is received from an INFORM 2) one isn't received and the retries/timeouts have failed.
.PP
Definition at line 850 of file agent_trap.c.
-.PP
-References snmp_increment_statistic().
-.PP
-Referenced by send_trap_to_sess().
.SS "int netsnmp_send_traps (int trap, int specific, oid * enterprise, int enterprise_length, \fBnetsnmp_variable_list\fP * vars, char * context, int flags)"
.PP
-This function allows you to make a distinction between generic traps from different classes of equipment.
-.PP
-For example, you may want to handle a SNMP_TRAP_LINKDOWN trap for a particular device in a different manner to a generic system SNMP_TRAP_LINKDOWN trap.
+This function allows you to make a distinction between generic traps from different classes of equipment. For example, you may want to handle a SNMP_TRAP_LINKDOWN trap for a particular device in a different manner to a generic system SNMP_TRAP_LINKDOWN trap.
.PP
\fBParameters:\fP
.RS 4
@@ -230,7 +224,7 @@
.br
\fIenterprise_length\fP is the length of the enterprise oid, use macro, OID_LENGTH, to compute length.
.br
-\fIvars\fP is used to supply list of variable bindings to form an SNMPv2 trap.
+\fIvars\fP is used to supply list of \fBvariable\fP bindings to form an SNMPv2 trap.
.br
\fIcontext\fP currently unused
.br
@@ -252,15 +246,9 @@
.PP
Definition at line 629 of file agent_trap.c.
-.PP
-References snmp_pdu::agent_addr, convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), snmp_pdu::enterprise, snmp_pdu::enterprise_length, find_varbind_in_list(), snmp_pdu::flags, variable_list::name, variable_list::name_length, netsnmp_get_agent_uptime(), trap_sink::next, variable_list::next_variable, NULL, netsnmp_vardata::objid, trap_sink::pdutype, send_trap_to_sess(), trap_sink::sesp, sinks, SNMP_AUTHENTICATED_TRAPS_DISABLED, snmp_clone_mem(), snmp_clone_varbind(), snmp_enableauthentraps, snmp_free_pdu(), snmp_free_varbind(), snmp_log(), snmp_oid_compare(), snmp_pdu_create(), snmp_varlist_add_variable(), snmptrap_oid, snmptrap_oid_len, snmptrapenterprise_oid, snmptrapenterprise_oid_len, snmp_pdu::specific_type, sysuptime_oid, sysuptime_oid_len, snmp_pdu::time, trap_prefix, snmp_pdu::trap_type, variable_list::val, snmp_pdu::variables, and trap_sink::version.
-.PP
-Referenced by send_enterprise_trap_vars().
.SS "void send_easy_trap (int trap, int specific)"
.PP
-Sends an SNMPv1 trap (or the SNMPv2 equivalent) to the list of configured trap destinations (or 'sinks'), using the provided values for the generic trap type and specific trap value.
-.PP
-This function eventually calls send_enterprise_trap_vars. If the trap type is not set to SNMP_TRAP_ENTERPRISESPECIFIC the enterprise and enterprise_length paramater is set to the pre defined NETSNMP_SYSTEM_MIB oid and length respectively. If the trap type is set to SNMP_TRAP_ENTERPRISESPECIFIC the enterprise and enterprise_length parameters are set to the pre-defined NETSNMP_NOTIFICATION_MIB oid and length respectively.
+Sends an SNMPv1 trap (or the SNMPv2 equivalent) to the list of configured trap destinations (or 'sinks'), using the provided values for the generic trap type and specific trap value. This function eventually calls send_enterprise_trap_vars. If the trap type is not set to SNMP_TRAP_ENTERPRISESPECIFIC the enterprise and enterprise_length paramater is set to the pre defined NETSNMP_SYSTEM_MIB oid and length respectively. If the trap type is set to SNMP_TRAP_ENTERPRISESPECIFIC the enterprise and enterprise_length parameters are set to the pre-defined NETSNMP_NOTIFICATION_MIB oid and length respectively.
.PP
\fBParameters:\fP
.RS 4
@@ -276,7 +264,7 @@
.PP
\fBSee also:\fP
.RS 4
-\fBsend_enterprise_trap_vars\fP
+send_enterprise_trap_vars
.PP
\fBsend_v2trap\fP
.RE
@@ -284,21 +272,15 @@
.PP
Definition at line 978 of file agent_trap.c.
-.PP
-References NULL, and send_trap_vars().
-.PP
-Referenced by handle_snmp_packet().
.SS "void send_v2trap (\fBnetsnmp_variable_list\fP * vars)"
.PP
-Uses the supplied list of variable bindings to form an SNMPv2 trap, which is sent to SNMPv2-capable sinks on the configured list.
-.PP
-An equivalent INFORM is sent to the configured list of inform sinks. Sinks that can only handle SNMPv1 traps are skipped.
+Uses the supplied list of \fBvariable\fP bindings to form an SNMPv2 trap, which is sent to SNMPv2-capable sinks on the configured list. An equivalent INFORM is sent to the configured list of inform sinks. Sinks that can only handle SNMPv1 traps are skipped.
.PP
This function eventually calls send_enterprise_trap_vars. If the trap type is not set to SNMP_TRAP_ENTERPRISESPECIFIC the enterprise and enterprise_length paramater is set to the pre defined NETSNMP_SYSTEM_MIB oid and length respectively. If the trap type is set to SNMP_TRAP_ENTERPRISESPECIFIC the enterprise and enterprise_length parameters are set to the pre-defined NETSNMP_NOTIFICATION_MIB oid and length respectively.
.PP
\fBParameters:\fP
.RS 4
-\fIvars\fP is used to supply list of variable bindings to form an SNMPv2 trap.
+\fIvars\fP is used to supply list of \fBvariable\fP bindings to form an SNMPv2 trap.
.RE
.PP
\fBReturns:\fP
@@ -310,7 +292,7 @@
.RS 4
\fBsend_easy_trap\fP
.PP
-\fBsend_enterprise_trap_vars\fP
+send_enterprise_trap_vars
.RE
.PP
@@ -320,13 +302,9 @@
\fBnotification.c\fP.
.PP
Definition at line 1007 of file agent_trap.c.
-.PP
-References send_trap_vars().
.SH "Variable Documentation"
.PP
-.SS "oid \fBsnmptrapenterprise_oid\fP[]"
-.PP
-\fBInitial value:\fP
+.SS "oid snmptrapenterprise_oid[]"\fBInitial value:\fP
.PP
.nf
@@ -334,5 +312,6 @@
.fi
.PP
Definition at line 99 of file agent_trap.c.
-.PP
-Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), init_traps(), and netsnmp_send_traps().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_asn1_packet_parse.3 b/man/netsnmp_asn1_packet_parse.3
index be93136..a3e31ef 100644
--- a/man/netsnmp_asn1_packet_parse.3
+++ b/man/netsnmp_asn1_packet_parse.3
@@ -1,10 +1,11 @@
-.TH "asn1 parsing and datatype manipulation routines." 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "asn1 parsing and datatype manipulation routines." 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-asn1 parsing and datatype manipulation routines. \- Note on.
-
+asn1 parsing and datatype manipulation routines. \-
.PP
+Note on.
+
.SS "Defines"
.in +1c
@@ -93,11 +94,41 @@
.ti -1c
.RI "int \fBasn_realloc\fP (u_char **pkt, size_t *pkt_len)"
.br
+.ti -1c
+.RI "int \fBasn_realloc_rbuild_length\fP (u_char **pkt, size_t *pkt_len, size_t *offset, int r, size_t length)"
+.br
+.ti -1c
+.RI "int \fBasn_realloc_rbuild_header\fP (u_char **pkt, size_t *pkt_len, size_t *offset, int r, u_char type, size_t length)"
+.br
+.ti -1c
+.RI "int \fBasn_realloc_rbuild_int\fP (u_char **pkt, size_t *pkt_len, size_t *offset, int r, u_char type, const long *intp, size_t intsize)"
+.br
+.ti -1c
+.RI "int \fBasn_realloc_rbuild_string\fP (u_char **pkt, size_t *pkt_len, size_t *offset, int r, u_char type, const u_char *str, size_t strlength)"
+.br
+.ti -1c
+.RI "int \fBasn_realloc_rbuild_unsigned_int\fP (u_char **pkt, size_t *pkt_len, size_t *offset, int r, u_char type, const u_long *intp, size_t intsize)"
+.br
+.ti -1c
+.RI "int \fBasn_realloc_rbuild_sequence\fP (u_char **pkt, size_t *pkt_len, size_t *offset, int r, u_char type, size_t length)"
+.br
+.ti -1c
+.RI "int \fBasn_realloc_rbuild_objid\fP (u_char **pkt, size_t *pkt_len, size_t *offset, int r, u_char type, const oid *objid, size_t objidlength)"
+.br
+.ti -1c
+.RI "int \fBasn_realloc_rbuild_null\fP (u_char **pkt, size_t *pkt_len, size_t *offset, int r, u_char type)"
+.br
+.ti -1c
+.RI "int \fBasn_realloc_rbuild_bitstring\fP (u_char **pkt, size_t *pkt_len, size_t *offset, int r, u_char type, const u_char *str, size_t strlength)"
+.br
+.ti -1c
+.RI "int \fBasn_realloc_rbuild_unsigned_int64\fP (u_char **pkt, size_t *pkt_len, size_t *offset, int r, u_char type, const struct \fBcounter64\fP *cp, size_t countersize)"
+.br
.in -1c
.SH "Detailed Description"
.PP
Note on.
-.PP
+
Re-allocating reverse ASN.1 encoder functions. Synopsis:
.PP
.PP
@@ -200,9 +231,7 @@
.SH "Define Documentation"
.PP
-.SS "#define CHECK_OVERFLOW_S(x, y)"
-.PP
-\fBValue:\fP
+.SS "#define CHECK_OVERFLOW_S(x, y)"\fBValue:\fP
.PP
.nf
do { int trunc = 0; \
@@ -219,11 +248,7 @@
.fi
.PP
Definition at line 214 of file asn1.c.
-.PP
-Referenced by asn_build_int(), and asn_parse_int().
-.SS "#define CHECK_OVERFLOW_U(x, y)"
-.PP
-\fBValue:\fP
+.SS "#define CHECK_OVERFLOW_U(x, y)"\fBValue:\fP
.PP
.nf
do { \
@@ -235,5 +260,6 @@
.fi
.PP
Definition at line 226 of file asn1.c.
-.PP
-Referenced by asn_build_objid(), asn_build_unsigned_int(), asn_build_unsigned_int64(), asn_parse_unsigned_int(), and asn_parse_unsigned_int64().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_baby_steps.3 b/man/netsnmp_baby_steps.3
index a1fec6a..7c60435 100644
--- a/man/netsnmp_baby_steps.3
+++ b/man/netsnmp_baby_steps.3
@@ -1,10 +1,11 @@
-.TH "baby_steps" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "baby_steps" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-baby_steps \- Calls your handler in baby_steps for set processing.
-
+baby_steps \-
.PP
+Calls your handler in baby_steps for set processing.
+
.SS "Modules"
.in +1c
@@ -27,7 +28,6 @@
.SH "Detailed Description"
.PP
Calls your handler in baby_steps for set processing.
-.PP
.SH "Function Documentation"
.PP
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_baby_steps_handler_get (u_long modes)"
@@ -35,14 +35,11 @@
returns a baby_steps handler that can be injected into a given handler chain.
.PP
Definition at line 58 of file baby_steps.c.
-.PP
-References netsnmp_mib_handler_s::myvoid, netsnmp_create_handler(), netsnmp_handler_free(), NULL, netsnmp_baby_steps_modes_s::registered, snmp_log(), and SNMP_MALLOC_TYPEDEF.
-.PP
-Referenced by netsnmp_baby_steps_handler_init().
.SS "void netsnmp_baby_steps_handler_init (void)"
.PP
initializes the baby_steps helper which then registers a baby_steps handler as a run-time injectable handler for configuration file use.
.PP
Definition at line 319 of file baby_steps.c.
-.PP
-References netsnmp_baby_steps_handler_get(), and netsnmp_register_handler_by_name().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_bulk_to_next.3 b/man/netsnmp_bulk_to_next.3
index faaf44b..466e5db 100644
--- a/man/netsnmp_bulk_to_next.3
+++ b/man/netsnmp_bulk_to_next.3
@@ -1,10 +1,11 @@
-.TH "bulk_to_next" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "bulk_to_next" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-bulk_to_next \- Convert GETBULK requests into GETNEXT requests for the handler.
-
+bulk_to_next \-
.PP
+Convert GETBULK requests into GETNEXT requests for the handler.
+
.SS "Functions"
.in +1c
@@ -27,7 +28,7 @@
.SH "Detailed Description"
.PP
Convert GETBULK requests into GETNEXT requests for the handler.
-.PP
+
The only purpose of this handler is to convert a GETBULK request to a GETNEXT request. It is inserted into handler chains where the handler has not set the HANDLER_CAN_GETBULK flag.
.SH "Function Documentation"
.PP
@@ -36,23 +37,16 @@
takes answered requests and decrements the repeat count and updates the requests to the next to-do varbind in the list
.PP
Definition at line 42 of file bulk_to_next.c.
-.PP
-References netsnmp_request_info_s::inclusive, variable_list::name, variable_list::name_length, netsnmp_request_info_s::next, variable_list::next_variable, netsnmp_request_info_s::range_end, netsnmp_request_info_s::range_end_len, netsnmp_request_info_s::repeat, netsnmp_request_info_s::requestvb, snmp_oid_compare(), snmp_set_var_objid(), and variable_list::type.
-.PP
-Referenced by netsnmp_bulk_to_next_helper().
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_bulk_to_next_handler (void)"
.PP
returns a bulk_to_next handler that can be injected into a given handler chain.
.PP
Definition at line 27 of file bulk_to_next.c.
-.PP
-References netsnmp_mib_handler_s::flags, MIB_HANDLER_AUTO_NEXT, netsnmp_bulk_to_next_helper(), netsnmp_create_handler(), and NULL.
-.PP
-Referenced by netsnmp_init_bulk_to_next_helper(), and netsnmp_register_handler().
.SS "void netsnmp_init_bulk_to_next_helper (void)"
.PP
initializes the bulk_to_next helper which then registers a bulk_to_next handler as a run-time injectable handler for configuration file use.
.PP
Definition at line 139 of file bulk_to_next.c.
-.PP
-References netsnmp_get_bulk_to_next_handler(), and netsnmp_register_handler_by_name().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_cache_handler.3 b/man/netsnmp_cache_handler.3
index 28bb424..283435d 100644
--- a/man/netsnmp_cache_handler.3
+++ b/man/netsnmp_cache_handler.3
@@ -1,10 +1,11 @@
-.TH "cache_handler" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "cache_handler" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-cache_handler \- Maintains a cache of data for use by lower level handlers.
-
+cache_handler \-
.PP
+Maintains a cache of data for use by lower level handlers.
+
.SS "Functions"
.in +1c
@@ -74,7 +75,7 @@
.ti -1c
.RI "int \fBnetsnmp_is_cache_valid\fP (\fBnetsnmp_agent_request_info\fP *reqinfo)"
.br
-.RI "\fIfor backwards compat \fP"
+.RI "\fIIs the cache valid for a given request? for backwards compatability. \fP"
.ti -1c
.RI "int \fBnetsnmp_cache_helper_handler\fP (\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *requests)"
.br
@@ -87,7 +88,7 @@
.SH "Detailed Description"
.PP
Maintains a cache of data for use by lower level handlers.
-.PP
+
This helper checks to see whether the data has been loaded 'recently' (according to the timeout for that particular cache) and calls the registered 'load_cache' routine if necessary. The lower handlers can then work with this local cached data.
.PP
A timeout value of -1 will cause \fBnetsnmp_cache_check_expired()\fP to always return true, and thus the cache will be reloaded for every request.
@@ -126,37 +127,21 @@
Reload the cache if required.
.PP
Definition at line 385 of file cache_handler.c.
-.PP
-References netsnmp_cache_check_expired(), and netsnmp_cache_s::valid.
-.PP
-Referenced by netsnmp_cache_helper_handler().
.SS "int netsnmp_cache_check_expired (\fBnetsnmp_cache\fP * cache)"
.PP
-Check if the cache timeout has passed.
-.PP
-Sets and return the expired flag.
+Check if the cache timeout has passed. Sets and return the expired flag.
.PP
Definition at line 370 of file cache_handler.c.
-.PP
-References atime_ready(), netsnmp_cache_s::expired, NULL, netsnmp_cache_s::timeout, netsnmp_cache_s::timestamp, and netsnmp_cache_s::valid.
-.PP
-Referenced by netsnmp_cache_check_and_reload(), and release_cached_resources().
.SS "\fBnetsnmp_cache\fP* netsnmp_cache_create (int timeout, NetsnmpCacheLoad * load_hook, NetsnmpCacheFree * free_hook, oid * rootoid, int rootoid_len)"
.PP
returns a cache
.PP
Definition at line 136 of file cache_handler.c.
-.PP
-References netsnmp_cache_s::enabled, netsnmp_cache_s::free_cache, netsnmp_cache_s::load_cache, netsnmp_ds_get_int(), netsnmp_cache_s::next, NULL, netsnmp_cache_s::prev, netsnmp_cache_s::rootoid, netsnmp_cache_s::rootoid_len, snmp_duplicate_objid(), snmp_log(), SNMP_MALLOC_TYPEDEF, and netsnmp_cache_s::timeout.
-.PP
-Referenced by netsnmp_get_cache_handler(), and netsnmp_get_timed_bare_stash_cache_handler().
.SS "\fBnetsnmp_cache\fP* netsnmp_cache_find_by_oid (oid * rootoid, int rootoid_len)"
.PP
find existing cache
.PP
Definition at line 120 of file cache_handler.c.
-.PP
-References netsnmp_oid_equals(), netsnmp_cache_s::next, NULL, netsnmp_cache_s::rootoid, and netsnmp_cache_s::rootoid_len.
.SS "\fBnetsnmp_cache\fP* netsnmp_cache_get_head (void)"
.PP
get cache head
@@ -167,17 +152,11 @@
returns a cache handler that can be injected into a given handler chain.
.PP
Definition at line 247 of file cache_handler.c.
-.PP
-References netsnmp_mib_handler_s::flags, netsnmp_cache_s::flags, MIB_HANDLER_AUTO_NEXT, netsnmp_mib_handler_s::myvoid, netsnmp_cache_helper_handler(), netsnmp_cache_timer_start(), netsnmp_create_handler(), NULL, and netsnmp_cache_s::valid.
-.PP
-Referenced by netsnmp_cache_handler_register(), netsnmp_get_cache_handler(), and netsnmp_get_timed_bare_stash_cache_handler().
.SS "int netsnmp_cache_handler_register (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_cache\fP * cache)"
.PP
functionally the same as calling \fBnetsnmp_register_handler()\fP but also injects a cache handler at the same time for you.
.PP
Definition at line 295 of file cache_handler.c.
-.PP
-References netsnmp_cache_handler_get(), netsnmp_inject_handler(), netsnmp_register_handler(), and NULL.
.SS "int netsnmp_cache_helper_handler (\fBnetsnmp_mib_handler\fP * handler, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests)"
.PP
Implements the cache handler.
@@ -189,91 +168,58 @@
next handler called automatically - 'AUTO_NEXT'
.PP
Definition at line 420 of file cache_handler.c.
-.PP
-References netsnmp_cache_s::cache_hint, netsnmp_cache_s::enabled, netsnmp_cache_s::flags, netsnmp_mib_handler_s::flags, netsnmp_cache_s::free_cache, netsnmp_handler_args_s::handler, netsnmp_handler_registration_s::handlerName, netsnmp_cache_s::load_cache, netsnmp_cache_s::magic, MIB_HANDLER_AUTO_NEXT, netsnmp_agent_request_info_s::mode, netsnmp_mib_handler_s::myvoid, netsnmp_cache_check_and_reload(), netsnmp_cache_is_valid(), netsnmp_cache_reqinfo_insert(), netsnmp_ds_get_boolean(), netsnmp_request_set_error_all(), NULL, netsnmp_handler_args_s::reginfo, netsnmp_handler_args_s::reqinfo, netsnmp_handler_args_s::requests, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, snmp_log(), and netsnmp_cache_s::valid.
-.PP
-Referenced by netsnmp_cache_handler_get().
.SS "int netsnmp_cache_is_valid (\fBnetsnmp_agent_request_info\fP * reqinfo, const char * name)"
.PP
Is the cache valid for a given request?
.PP
Definition at line 402 of file cache_handler.c.
-.PP
-References netsnmp_cache_reqinfo_extract(), and netsnmp_cache_s::valid.
-.PP
-Referenced by netsnmp_cache_helper_handler(), and netsnmp_is_cache_valid().
.SS "\fBnetsnmp_cache\fP* netsnmp_cache_reqinfo_extract (\fBnetsnmp_agent_request_info\fP * reqinfo, const char * name)"
.PP
Extract the cache information for a given request (PDU).
.PP
Definition at line 350 of file cache_handler.c.
-.PP
-References _build_cache_name(), netsnmp_agent_get_list_data(), and SNMP_FREE.
-.PP
-Referenced by netsnmp_cache_is_valid(), netsnmp_extract_cache_info(), and netsnmp_stash_cache_helper().
.SS "void netsnmp_cache_reqinfo_insert (\fBnetsnmp_cache\fP * cache, \fBnetsnmp_agent_request_info\fP * reqinfo, const char * name)"
.PP
Insert the cache information for a given request (PDU).
.PP
Definition at line 333 of file cache_handler.c.
-.PP
-References _build_cache_name(), netsnmp_agent_add_list_data(), netsnmp_agent_get_list_data(), netsnmp_create_data_list(), NULL, and SNMP_FREE.
-.PP
-Referenced by netsnmp_cache_helper_handler().
.SS "unsigned int netsnmp_cache_timer_start (\fBnetsnmp_cache\fP * cache)"
.PP
starts the recurring cache_load callback
.PP
Definition at line 191 of file cache_handler.c.
-.PP
-References netsnmp_cache_s::flags, NULL, netsnmp_cache_s::rootoid, netsnmp_cache_s::rootoid_len, snmp_alarm_register(), snmp_log(), netsnmp_cache_s::timeout, and netsnmp_cache_s::timer_id.
-.PP
-Referenced by netsnmp_cache_handler_get().
.SS "void netsnmp_cache_timer_stop (\fBnetsnmp_cache\fP * cache)"
.PP
stops the recurring cache_load callback
.PP
Definition at line 226 of file cache_handler.c.
-.PP
-References netsnmp_cache_s::flags, NULL, snmp_alarm_unregister(), snmp_log(), and netsnmp_cache_s::timer_id.
.SS "\fBnetsnmp_cache\fP* netsnmp_extract_cache_info (\fBnetsnmp_agent_request_info\fP * reqinfo)"
.PP
Extract the cache information for a given request (PDU).
.PP
Definition at line 362 of file cache_handler.c.
-.PP
-References netsnmp_cache_reqinfo_extract().
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_cache_handler (int timeout, NetsnmpCacheLoad * load_hook, NetsnmpCacheFree * free_hook, oid * rootoid, int rootoid_len)"
.PP
returns a cache handler that can be injected into a given handler chain.
.PP
Definition at line 276 of file cache_handler.c.
-.PP
-References netsnmp_mib_handler_s::myvoid, netsnmp_cache_create(), netsnmp_cache_handler_get(), and NULL.
-.PP
-Referenced by netsnmp_register_cache_handler().
.SS "int netsnmp_is_cache_valid (\fBnetsnmp_agent_request_info\fP * reqinfo)"
.PP
-for backwards compat
+Is the cache valid for a given request? for backwards compatability. for backwards compat
.PP
\fBnetsnmp_cache_is_valid()\fP is preferred.
.PP
Definition at line 413 of file cache_handler.c.
-.PP
-References netsnmp_cache_is_valid().
.SS "int netsnmp_register_cache_handler (\fBnetsnmp_handler_registration\fP * reginfo, int timeout, NetsnmpCacheLoad * load_hook, NetsnmpCacheFree * free_hook)"
.PP
functionally the same as calling \fBnetsnmp_register_handler()\fP but also injects a cache handler at the same time for you.
.PP
Definition at line 308 of file cache_handler.c.
-.PP
-References netsnmp_get_cache_handler(), netsnmp_inject_handler(), netsnmp_register_handler(), NULL, netsnmp_handler_registration_s::rootoid, and netsnmp_handler_registration_s::rootoid_len.
.SS "void release_cached_resources (unsigned int regNo, void * clientargs)"
.PP
-run regularly to automatically release cached resources.
-.PP
-xxx - method to prevent cache from expiring while a request is being processed (e.g. delegated request). proposal: set a flag, which would be cleared when request finished (which could be acomplished by a dummy data list item in agent req info & custom free function).
+run regularly to automatically release cached resources. xxx - method to prevent cache from expiring while a request is being processed (e.g. delegated request). proposal: set a flag, which would be cleared when request finished (which could be acomplished by a dummy data list item in agent req info & custom free function).
.PP
Definition at line 575 of file cache_handler.c.
-.PP
-References netsnmp_cache_s::flags, netsnmp_cache_check_expired(), netsnmp_cache_s::next, NULL, and netsnmp_cache_s::valid.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_callback.3 b/man/netsnmp_callback.3
index f6d8d14..a8d35cc 100644
--- a/man/netsnmp_callback.3
+++ b/man/netsnmp_callback.3
@@ -1,4 +1,4 @@
-.TH "A generic callback mechanism" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "A generic callback mechanism" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -63,16 +63,14 @@
.RI "void \fBclear_callback\fP (void)"
.br
.ti -1c
-.RI "\fBsnmp_gen_callback\fP * \fBsnmp_callback_list\fP (int major, int minor)"
+.RI "struct \fBsnmp_gen_callback\fP * \fBsnmp_callback_list\fP (int major, int minor)"
.br
.in -1c
.SH "Function Documentation"
.PP
.SS "int netsnmp_callback_clear_client_arg (void * ptr, int i, int j)"
.PP
-find and clear client args that match ptr
-.PP
-\fBParameters:\fP
+find and clear client args that match ptr \fBParameters:\fP
.RS 4
\fIptr\fP pointer to search for
.br
@@ -84,15 +82,9 @@
.PP
Definition at line 474 of file callback.c.
-.PP
-References snmp_gen_callback::next, NULL, snmp_gen_callback::sc_callback, and snmp_gen_callback::sc_client_arg.
-.PP
-Referenced by clear_callback().
.SS "int snmp_call_callbacks (int major, int minor, void * caller_arg)"
.PP
-This function calls the callback function for each registered callback of type major and minor.
-.PP
-\fBParameters:\fP
+This function calls the callback function for each registered callback of type major and minor. \fBParameters:\fP
.RS 4
\fImajor\fP is the SNMP callback major type used
.br
@@ -116,15 +108,9 @@
.PP
Definition at line 298 of file callback.c.
-.PP
-References _callback_lock(), _callback_unlock(), init_callbacks(), snmp_gen_callback::next, NULL, snmp_gen_callback::sc_callback, and snmp_gen_callback::sc_client_arg.
-.PP
-Referenced by add_trap_session(), check_access(), in_a_view(), log_handler_callback(), netsnmp_acm_check_subtree(), netsnmp_register_mib(), netsnmp_register_mib_table_row(), read_configs(), read_premib_configs(), snmp_shutdown(), snmp_store(), and unregister_mibs_by_session().
.SS "int snmp_register_callback (int major, int minor, SNMPCallback * new_callback, void * arg)"
.PP
-This function registers a generic callback function.
-.PP
-The major and minor values are used to set the new_callback function into a global static multi-dimensional array of type struct \fBsnmp_gen_callback\fP. The function makes sure to append this callback function at the end of the link list, snmp_gen_callback->next.
+This function registers a generic callback function. The major and minor values are used to set the new_callback function into a global static multi-dimensional array of type struct \fBsnmp_gen_callback\fP. The function makes sure to append this callback function at the end of the link list, snmp_gen_callback->next.
.PP
\fBParameters:\fP
.RS 4
@@ -180,15 +166,9 @@
.PP
Definition at line 230 of file callback.c.
-.PP
-References netsnmp_register_callback().
-.PP
-Referenced by init_snmp_alarm(), netsnmp_init_handler_conf(), and netsnmp_register_save_list().
.SS "int snmp_unregister_callback (int major, int minor, SNMPCallback * target, void * arg, int matchargs)"
.PP
-This function unregisters a specified callback function given a major and minor type.
-.PP
-Note: no bound checking on major and minor.
+This function unregisters a specified callback function given a major and minor type. Note: no bound checking on major and minor.
.PP
\fBParameters:\fP
.RS 4
@@ -198,9 +178,9 @@
.br
\fItarget\fP is the callback function that will be unregistered.
.br
-\fIarg\fP is a void pointer used for comparison against the registered callback's sc_client_arg variable.
+\fIarg\fP is a void pointer used for comparison against the registered callback's sc_client_arg \fBvariable\fP.
.br
-\fImatchargs\fP is an integer used to bypass the comparison of arg and the callback's sc_client_arg variable only when matchargs is set to 0.
+\fImatchargs\fP is an integer used to bypass the comparison of arg and the callback's sc_client_arg \fBvariable\fP only when matchargs is set to 0.
.RE
.PP
\fBReturns:\fP
@@ -220,5 +200,6 @@
set cleanup flag?
.PP
Definition at line 418 of file callback.c.
-.PP
-References _callback_lock(), _callback_unlock(), CALLBACK_LOCK_COUNT, init_callbacks(), snmp_gen_callback::next, NULL, snmp_gen_callback::sc_callback, snmp_gen_callback::sc_client_arg, and SNMP_FREE.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_container.3 b/man/netsnmp_container.3
index 4a9a6e8..20d44af 100644
--- a/man/netsnmp_container.3
+++ b/man/netsnmp_container.3
@@ -1,4 +1,4 @@
-.TH "container" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "container" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -9,7 +9,10 @@
.ti -1c
.RI "\fBnull_container\fP"
.br
-.RI "\fIHelps you implement specialized containers. \fP"
.PP
+.RI "\fIHelps you implement specialized containers. \fP"
.in -1c
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_data_list.3 b/man/netsnmp_data_list.3
index 44bd933..2cf8fff 100644
--- a/man/netsnmp_data_list.3
+++ b/man/netsnmp_data_list.3
@@ -1,4 +1,4 @@
-.TH "generic linked-list data handling with a string as a key." 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "generic linked-list data handling with a string as a key." 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -9,7 +9,7 @@
.ti -1c
.RI "NETSNMP_INLINE void \fBnetsnmp_free_list_data\fP (\fBnetsnmp_data_list\fP *\fBnode\fP)"
.br
-.RI "\fIfrees the data and a name at a given data_list node. \fP"
+.RI "\fIfrees the data and a name at a given data_list \fBnode\fP. \fP"
.ti -1c
.RI "NETSNMP_INLINE void \fBnetsnmp_free_all_list_data\fP (\fBnetsnmp_data_list\fP *head)"
.br
@@ -17,11 +17,11 @@
.ti -1c
.RI "NETSNMP_INLINE \fBnetsnmp_data_list\fP * \fBnetsnmp_create_data_list\fP (const char *name, void *data, Netsnmp_Free_List_Data *beer)"
.br
-.RI "\fIadds creates a data_list node given a name, data and a free function ptr. \fP"
+.RI "\fIadds creates a data_list \fBnode\fP given a name, data and a free function ptr. \fP"
.ti -1c
.RI "NETSNMP_INLINE void \fBnetsnmp_add_list_data\fP (\fBnetsnmp_data_list\fP **head, \fBnetsnmp_data_list\fP *\fBnode\fP)"
.br
-.RI "\fIdepreciated: use \fBnetsnmp_data_list_add_node()\fP \fP"
+.RI "\fIadds data to a datalist \fP"
.ti -1c
.RI "NETSNMP_INLINE void \fBnetsnmp_data_list_add_node\fP (\fBnetsnmp_data_list\fP **head, \fBnetsnmp_data_list\fP *\fBnode\fP)"
.br
@@ -37,11 +37,11 @@
.ti -1c
.RI "NETSNMP_INLINE \fBnetsnmp_data_list\fP * \fBnetsnmp_get_list_node\fP (\fBnetsnmp_data_list\fP *head, const char *name)"
.br
-.RI "\fIreturns a data_list node for a given name within a data_list \fP"
+.RI "\fIreturns a data_list \fBnode\fP for a given name within a data_list \fP"
.ti -1c
.RI "int \fBnetsnmp_remove_list_node\fP (\fBnetsnmp_data_list\fP **realhead, const char *name)"
.br
-.RI "\fIRemoves a named node from a data_list (and frees it). \fP"
+.RI "\fIRemoves a named \fBnode\fP from a data_list (and frees it). \fP"
.ti -1c
.RI "void \fBnetsnmp_register_save_list\fP (\fBnetsnmp_data_list\fP **datalist, const char *type, const char *token, Netsnmp_Save_List_Data *data_list_save_ptr, Netsnmp_Read_List_Data *data_list_read_ptr, Netsnmp_Free_List_Data *data_list_free_ptr)"
.br
@@ -63,20 +63,28 @@
.PP
.SS "NETSNMP_INLINE void netsnmp_add_list_data (\fBnetsnmp_data_list\fP ** head, \fBnetsnmp_data_list\fP * node)"
.PP
-depreciated: use \fBnetsnmp_data_list_add_node()\fP
+adds data to a datalist depreciated: use \fBnetsnmp_data_list_add_node()\fP
.PP
-Definition at line 83 of file data_list.c.
-.PP
-References netsnmp_data_list_add_node().
-.PP
-Referenced by netsnmp_agent_add_list_data(), netsnmp_data_list_add_data(), netsnmp_read_data_callback(), netsnmp_register_auto_data_table(), netsnmp_register_handler_by_name(), netsnmp_register_save_list(), and netsnmp_request_add_list_data().
-.SS "NETSNMP_INLINE \fBnetsnmp_data_list\fP* netsnmp_create_data_list (const char * name, void * data, Netsnmp_Free_List_Data * beer)"
-.PP
-adds creates a data_list node given a name, data and a free function ptr.
+\fBNote:\fP
+.RS 4
+netsnmp_data_list_add_node is preferred
+.RE
.PP
\fBParameters:\fP
.RS 4
-\fIname\fP the name of the node to cache the data.
+\fIhead\fP a pointer to the head \fBnode\fP of a data_list
+.br
+\fI\fBnode\fP\fP a \fBnode\fP to stash in the data_list
+.RE
+.PP
+
+.PP
+Definition at line 83 of file data_list.c.
+.SS "NETSNMP_INLINE \fBnetsnmp_data_list\fP* netsnmp_create_data_list (const char * name, void * data, Netsnmp_Free_List_Data * beer)"
+.PP
+adds creates a data_list \fBnode\fP given a name, data and a free function ptr. \fBParameters:\fP
+.RS 4
+\fIname\fP the name of the \fBnode\fP to cache the data.
.br
\fIdata\fP the data to be stored under that name
.br
@@ -85,7 +93,7 @@
.PP
\fBReturns:\fP
.RS 4
-a newly created data_list node which can be given to the netsnmp_add_list_data function.
+a newly created data_list \fBnode\fP which can be given to the netsnmp_add_list_data function.
.RE
.PP
@@ -95,19 +103,13 @@
\fBdelayed_instance.c\fP.
.PP
Definition at line 60 of file data_list.c.
-.PP
-References netsnmp_data_list_s::data, netsnmp_data_list_s::free_func, netsnmp_data_list_s::name, NULL, and SNMP_MALLOC_TYPEDEF.
-.PP
-Referenced by _netsnmp_stash_cache_load(), _netsnmp_tdata_helper_handler(), netsnmp_cache_reqinfo_insert(), netsnmp_container_table_row_insert(), netsnmp_data_list_add_data(), netsnmp_insert_iterator_context(), netsnmp_insert_table_row(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_num_file_handler(), netsnmp_instance_uint_handler(), netsnmp_instance_ulong_handler(), netsnmp_read_data_callback(), netsnmp_register_auto_data_table(), netsnmp_register_handler_by_name(), netsnmp_register_save_list(), netsnmp_row_merge_status_get(), netsnmp_table_data_helper_handler(), netsnmp_table_data_set_helper_handler(), netsnmp_table_iterator_helper_handler(), netsnmp_watcher_helper_handler(), and table_helper_handler().
.SS "NETSNMP_INLINE \fBnetsnmp_data_list\fP* netsnmp_data_list_add_data (\fBnetsnmp_data_list\fP ** head, const char * name, void * data, Netsnmp_Free_List_Data * beer)"
.PP
-adds data to a datalist
-.PP
-\fBParameters:\fP
+adds data to a datalist \fBParameters:\fP
.RS 4
-\fIhead\fP a pointer to the head node of a data_list
+\fIhead\fP a pointer to the head \fBnode\fP of a data_list
.br
-\fIname\fP the name of the node to cache the data.
+\fIname\fP the name of the \fBnode\fP to cache the data.
.br
\fIdata\fP the data to be stored under that name
.br
@@ -116,115 +118,83 @@
.PP
\fBReturns:\fP
.RS 4
-a newly created data_list node which was inserted in the list
+a newly created data_list \fBnode\fP which was inserted in the list
.RE
.PP
.PP
Definition at line 137 of file data_list.c.
-.PP
-References netsnmp_add_list_data(), netsnmp_create_data_list(), NULL, and snmp_log().
.SS "NETSNMP_INLINE void netsnmp_data_list_add_node (\fBnetsnmp_data_list\fP ** head, \fBnetsnmp_data_list\fP * node)"
.PP
-adds data to a datalist
-.PP
-\fBParameters:\fP
+adds data to a datalist \fBParameters:\fP
.RS 4
-\fIhead\fP a pointer to the head node of a data_list
+\fIhead\fP a pointer to the head \fBnode\fP of a data_list
.br
-\fInode\fP a node to stash in the data_list
+\fI\fBnode\fP\fP a \fBnode\fP to stash in the data_list
.RE
.PP
.PP
Definition at line 93 of file data_list.c.
-.PP
-References netsnmp_data_list_s::name, netsnmp_data_list_s::next, NULL, and snmp_log().
-.PP
-Referenced by netsnmp_add_list_data().
.SS "NETSNMP_INLINE void netsnmp_free_all_list_data (\fBnetsnmp_data_list\fP * head)"
.PP
-frees all data and nodes in a list.
-.PP
-\fBParameters:\fP
+frees all data and nodes in a list. \fBParameters:\fP
.RS 4
-\fIhead\fP the top node of the list to be freed.
+\fIhead\fP the top \fBnode\fP of the list to be freed.
.RE
.PP
.PP
Definition at line 42 of file data_list.c.
-.PP
-References netsnmp_free_list_data(), netsnmp_data_list_s::next, and SNMP_FREE.
-.PP
-Referenced by netsnmp_clear_handler_list(), netsnmp_free_agent_data_sets(), netsnmp_free_agent_request_info(), netsnmp_free_request_data_sets(), and netsnmp_stash_to_next_helper().
.SS "NETSNMP_INLINE void netsnmp_free_list_data (\fBnetsnmp_data_list\fP * node)"
.PP
-frees the data and a name at a given data_list node.
-.PP
-Note that this doesn't free the node itself.
+frees the data and a name at a given data_list \fBnode\fP. Note that this doesn't free the \fBnode\fP itself.
.PP
\fBParameters:\fP
.RS 4
-\fInode\fP the node for which the data should be freed
+\fI\fBnode\fP\fP the \fBnode\fP for which the data should be freed
.RE
.PP
.PP
Definition at line 26 of file data_list.c.
-.PP
-References netsnmp_data_list_s::data, netsnmp_data_list_s::free_func, netsnmp_data_list_s::name, and SNMP_FREE.
-.PP
-Referenced by netsnmp_free_agent_data_set(), netsnmp_free_all_list_data(), netsnmp_free_request_data_set(), and netsnmp_remove_list_node().
.SS "NETSNMP_INLINE void* netsnmp_get_list_data (\fBnetsnmp_data_list\fP * head, const char * name)"
.PP
-returns a data_list node's data for a given name within a data_list
-.PP
-\fBParameters:\fP
+returns a data_list node's data for a given name within a data_list \fBParameters:\fP
.RS 4
-\fIhead\fP the head node of a data_list
+\fIhead\fP the head \fBnode\fP of a data_list
.br
\fIname\fP the name to find
.RE
.PP
\fBReturns:\fP
.RS 4
-a pointer to the data cached at that node
+a pointer to the data cached at that \fBnode\fP
.RE
.PP
.PP
Definition at line 162 of file data_list.c.
-.PP
-References netsnmp_data_list_s::name, netsnmp_data_list_s::next, and NULL.
-.PP
-Referenced by netsnmp_agent_get_list_data(), netsnmp_config_parse_add_row(), netsnmp_config_parse_table_set(), netsnmp_read_data_callback(), netsnmp_request_get_list_data(), and parse_injectHandler_conf().
.SS "NETSNMP_INLINE \fBnetsnmp_data_list\fP* netsnmp_get_list_node (\fBnetsnmp_data_list\fP * head, const char * name)"
.PP
-returns a data_list node for a given name within a data_list
-.PP
-\fBParameters:\fP
+returns a data_list \fBnode\fP for a given name within a data_list \fBParameters:\fP
.RS 4
-\fIhead\fP the head node of a data_list
+\fIhead\fP the head \fBnode\fP of a data_list
.br
\fIname\fP the name to find
.RE
.PP
\fBReturns:\fP
.RS 4
-a pointer to the data_list node
+a pointer to the data_list \fBnode\fP
.RE
.PP
.PP
Definition at line 180 of file data_list.c.
-.PP
-References netsnmp_data_list_s::name, netsnmp_data_list_s::next, and NULL.
.SS "void netsnmp_read_data_callback (const char * token, char * line)"
.PP
-intended to be registerd as a .conf parser It should be registered using:
-.PP
-register_app_config_handler('token', netsnmp_read_data_callback, XXX)
+intended to be registerd as a .conf parser It should be registered using: register_app_config_handler('token', netsnmp_read_data_callback, XXX)
.PP
where INFO_POINTER is a pointer to a netsnmp_data_list_saveinfo object containing apporpriate registration information
.PP
@@ -236,15 +206,9 @@
.PP
Definition at line 333 of file data_list.c.
-.PP
-References netsnmp_data_list_saveinfo_s::data_list_free_ptr, netsnmp_data_list_saveinfo_s::data_list_read_ptr, netsnmp_data_list_saveinfo_s::datalist, netsnmp_add_list_data(), netsnmp_create_data_list(), netsnmp_get_list_data(), NULL, read_config_read_data(), and snmp_log().
-.PP
-Referenced by netsnmp_register_save_list().
.SS "void netsnmp_register_save_list (\fBnetsnmp_data_list\fP ** datalist, const char * type, const char * token, Netsnmp_Save_List_Data * data_list_save_ptr, Netsnmp_Read_List_Data * data_list_read_ptr, Netsnmp_Free_List_Data * data_list_free_ptr)"
.PP
-registers to store a data_list set of data at persistent storage time
-.PP
-\fBParameters:\fP
+registers to store a data_list set of data at persistent storage time \fBParameters:\fP
.RS 4
\fIdatalist\fP the data to be saved
.br
@@ -256,7 +220,7 @@
.br
\fIdata_list_read_ptr\fP a function pointer which can read the remainder of a saved line and return the application specific void * pointer.
.br
-\fIdata_list_free_ptr\fP a function pointer which will be passed to the data node for freeing it in the future when/if the list/node is cleaned up or destroyed.
+\fIdata_list_free_ptr\fP a function pointer which will be passed to the data \fBnode\fP for freeing it in the future when/if the list/node is cleaned up or destroyed.
.RE
.PP
@@ -269,15 +233,11 @@
.PP
Definition at line 231 of file data_list.c.
-.PP
-References netsnmp_data_list_saveinfo_s::data_list_free_ptr, netsnmp_data_list_saveinfo_s::data_list_read_ptr, netsnmp_data_list_saveinfo_s::data_list_save_ptr, netsnmp_data_list_saveinfo_s::datalist, netsnmp_add_list_data(), netsnmp_create_data_list(), netsnmp_ds_get_string(), netsnmp_read_data_callback(), netsnmp_save_all_data_callback(), NULL, register_config_handler(), snmp_log(), SNMP_MALLOC_TYPEDEF, snmp_register_callback(), netsnmp_data_list_saveinfo_s::token, and netsnmp_data_list_saveinfo_s::type.
.SS "int netsnmp_remove_list_node (\fBnetsnmp_data_list\fP ** realhead, const char * name)"
.PP
-Removes a named node from a data_list (and frees it).
-.PP
-\fBParameters:\fP
+Removes a named \fBnode\fP from a data_list (and frees it). \fBParameters:\fP
.RS 4
-\fIrealhead\fP a pointer to the head node of a data_list
+\fIrealhead\fP a pointer to the head \fBnode\fP of a data_list
.br
\fIname\fP the name to find and remove
.RE
@@ -290,33 +250,20 @@
.PP
Definition at line 198 of file data_list.c.
-.PP
-References netsnmp_free_list_data(), netsnmp_data_list_s::next, and NULL.
-.PP
-Referenced by netsnmp_agent_remove_list_data(), and netsnmp_request_remove_list_data().
.SS "int netsnmp_save_all_data (\fBnetsnmp_data_list\fP * head, const char * type, const char * token, Netsnmp_Save_List_Data * data_list_save_ptr)"
.PP
-intended to be called as a callback during persistent save operations.
-.PP
-See the netsnmp_save_all_data_callback for where this is typically used.
+intended to be called as a callback during persistent save operations. See the netsnmp_save_all_data_callback for where this is typically used.
.PP
Definition at line 297 of file data_list.c.
-.PP
-References netsnmp_data_list_s::data, netsnmp_data_list_s::name, netsnmp_data_list_s::next, read_config_save_octet_string(), read_config_store(), and SNMP_MAXBUF.
-.PP
-Referenced by netsnmp_save_all_data_callback().
.SS "int netsnmp_save_all_data_callback (int major, int minor, void * serverarg, void * clientarg)"
.PP
-intended to be registerd as a callback operation.
-.PP
-It should be registered using:
+intended to be registerd as a callback operation. It should be registered using:
.PP
snmp_register_callback(SNMP_CALLBACK_LIBRARY, SNMP_CALLBACK_STORE_DATA, netsnmp_save_all_data_callback, INFO_POINTER);
.PP
where INFO_POINTER is a pointer to a netsnmp_data_list_saveinfo object containing apporpriate registration information
.PP
Definition at line 280 of file data_list.c.
-.PP
-References netsnmp_data_list_saveinfo_s::data_list_save_ptr, netsnmp_data_list_saveinfo_s::datalist, netsnmp_save_all_data(), snmp_log(), netsnmp_data_list_saveinfo_s::token, and netsnmp_data_list_saveinfo_s::type.
-.PP
-Referenced by netsnmp_register_save_list().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_debug.3 b/man/netsnmp_debug.3
index a680833..421ac65 100644
--- a/man/netsnmp_debug.3
+++ b/man/netsnmp_debug.3
@@ -1,12 +1,31 @@
-.TH "debug" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "debug" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-debug \- Print out debugging information about the handler chain being called.
-
+debug \-
.PP
-.SS "handler"
+Print out debugging information about the handler chain being called.
+.SS "Functions"
+
+.in +1c
+.ti -1c
+.RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_get_debug_handler\fP (void)"
+.br
+.RI "\fIreturns a debug handler that can be injected into a given handler chain. \fP"
+.ti -1c
+.RI "void \fBdebug_print_requests\fP (\fBnetsnmp_request_info\fP *requests)"
+.br
+.ti -1c
+.RI "int \fBnetsnmp_debug_helper\fP (\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *requests)"
+.br
+.ti -1c
+.RI "void \fBnetsnmp_init_debug_helper\fP (void)"
+.br
+.RI "\fIinitializes the debug helper which then registers a debug handler as a run-time injectable handler for configuration file use. \fP"
+.in -1c
+.SS "handler"
+
.in +1c
.ti -1c
.RI "void \fBnetsnmp_init_serialize\fP (void)"
@@ -32,29 +51,11 @@
.br
.RI "\fIcall the initialization sequence for all handlers with init_ routines. \fP"
.in -1c
-.SS "Functions"
-
-.in +1c
-.ti -1c
-.RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_get_debug_handler\fP (void)"
-.br
-.RI "\fIreturns a debug handler that can be injected into a given handler chain. \fP"
-.ti -1c
-.RI "void \fBdebug_print_requests\fP (\fBnetsnmp_request_info\fP *requests)"
-.br
-.ti -1c
-.RI "int \fBnetsnmp_debug_helper\fP (\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *requests)"
-.br
-.ti -1c
-.RI "void \fBnetsnmp_init_debug_helper\fP (void)"
-.br
-.RI "\fIinitializes the debug helper which then registers a debug handler as a run-time injectable handler for configuration file use. \fP"
-.in -1c
.SH "Detailed Description"
.PP
Print out debugging information about the handler chain being called.
-.PP
-This is a useful module for run-time debugging of requests as the pass this handler in a calling chain. All debugging output is done via the standard debugging routines with a token name of 'helper:debug', so use the -Dhelper:debug command line flag to see the output when running the snmpd demon. It's not recommended you compile this into a handler chain during compile time, but instead use the 'injectHandler' token in the snmpd.conf file (or similar) to add it to the chain later:
+
+This is a useful \fBmodule\fP for run-time debugging of requests as the pass this handler in a calling chain. All debugging output is done via the standard debugging routines with a token name of 'helper:debug', so use the -Dhelper:debug command line flag to see the output when running the snmpd demon. It's not recommended you compile this into a handler chain during compile time, but instead use the 'injectHandler' token in the snmpd.conf file (or similar) to add it to the chain later:
.PP
injectHandler debug my_module_name
.PP
@@ -70,53 +71,36 @@
returns a debug handler that can be injected into a given handler chain.
.PP
Definition at line 51 of file debug_handler.c.
-.PP
-References netsnmp_create_handler(), and netsnmp_debug_helper().
-.PP
-Referenced by netsnmp_init_debug_helper().
.SS "void netsnmp_init_bulk_to_next_helper (void)"
.PP
initializes the bulk_to_next helper which then registers a bulk_to_next handler as a run-time injectable handler for configuration file use.
.PP
Definition at line 139 of file bulk_to_next.c.
-.PP
-Referenced by netsnmp_init_helpers().
.SS "void netsnmp_init_debug_helper (void)"
.PP
initializes the debug helper which then registers a debug handler as a run-time injectable handler for configuration file use.
.PP
Definition at line 155 of file debug_handler.c.
-.PP
-References netsnmp_get_debug_handler(), and netsnmp_register_handler_by_name().
.SS "void netsnmp_init_helpers (void)"
.PP
call the initialization sequence for all handlers with init_ routines.
.PP
Definition at line 36 of file all_helpers.c.
-.PP
-References netsnmp_init_bulk_to_next_helper(), netsnmp_init_debug_helper(), netsnmp_init_read_only_helper(), netsnmp_init_serialize(), netsnmp_init_stash_cache_helper(), and netsnmp_init_table_dataset().
-.PP
-Referenced by init_agent().
.SS "void netsnmp_init_read_only_helper (void)"
.PP
initializes the read_only helper which then registers a read_only handler as a run-time injectable handler for configuration file use.
.PP
Definition at line 81 of file read_only.c.
-.PP
-Referenced by netsnmp_init_helpers().
.SS "void netsnmp_init_serialize (void)"
.PP
initializes the serialize helper which then registers a serialize handler as a run-time injectable handler for configuration file use.
.PP
Definition at line 93 of file serialize.c.
-.PP
-Referenced by netsnmp_init_helpers().
.SS "void netsnmp_init_stash_cache_helper (void)"
.PP
initializes the stash_cache helper which then registers a stash_cache handler as a run-time injectable handler for configuration file use.
.PP
-Definition at line 237 of file stash_cache.c.
-.PP
-References netsnmp_get_stash_cache_handler(), and netsnmp_register_handler_by_name().
-.PP
-Referenced by netsnmp_init_helpers().
+Definition at line 238 of file stash_cache.c.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_default_store.3 b/man/netsnmp_default_store.3
index 5a8279e..8b2a73e 100644
--- a/man/netsnmp_default_store.3
+++ b/man/netsnmp_default_store.3
@@ -1,10 +1,11 @@
-.TH "storage space for defaults" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "storage space for defaults" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-storage space for defaults \- The purpose of the default storage is three-fold:.
-
+storage space for defaults \-
.PP
+The purpose of the default storage is three-fold:.
+
.SS "Data Structures"
.in +1c
@@ -16,7 +17,7 @@
.in +1c
.ti -1c
-.RI "typedef \fBnetsnmp_ds_read_config_s\fP \fBnetsnmp_ds_read_config\fP"
+.RI "typedef struct \fBnetsnmp_ds_read_config_s\fP \fBnetsnmp_ds_read_config\fP"
.br
.in -1c
.SS "Functions"
@@ -69,7 +70,7 @@
.SH "Detailed Description"
.PP
The purpose of the default storage is three-fold:.
-.PP
+
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.
.PP
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.
@@ -108,7 +109,7 @@
.IP "\(bu" 2
#define NETSNMP_DS_LIB_DONT_READ_CONFIGS 6
.IP "\(bu" 2
-#define NETSNMP_DS_LIB_MIB_REPLACE 7 replace objects from latest module
+#define NETSNMP_DS_LIB_MIB_REPLACE 7 replace objects from latest \fBmodule\fP
.IP "\(bu" 2
#define NETSNMP_DS_LIB_PRINT_NUMERIC_ENUM 8 print only numeric enum values
.IP "\(bu" 2
@@ -227,9 +228,7 @@
.PP
.SS "int netsnmp_ds_set_boolean (int storeid, int which, int value)"
.PP
-Stores 'true' or 'false' given an int value for value into netsnmp_ds_booleans[store][which] slot.
-.PP
-\fBParameters:\fP
+Stores 'true' or 'false' given an int value for value into netsnmp_ds_booleans[store][which] slot. \fBParameters:\fP
.RS 4
\fIstoreid\fP an index to the boolean storage container's first index(store)
.br
@@ -246,5 +245,6 @@
.PP
Definition at line 197 of file default_store.c.
-.PP
-Referenced by init_agent(), netsnmp_ds_handle_config(), read_configs(), read_premib_configs(), setup_tree(), and snmp_out_toggle_options().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_handler.3 b/man/netsnmp_handler.3
index 06bfb23..3cb2b59 100644
--- a/man/netsnmp_handler.3
+++ b/man/netsnmp_handler.3
@@ -1,55 +1,11 @@
-.TH "Net-SNMP Agent handler and extensibility API" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "Net-SNMP Agent handler and extensibility API" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-Net-SNMP Agent handler and extensibility API \- The basic theory goes something like this: In the past, with the original mib module api (which derived from the original CMU SNMP code) the underlying mib modules were passed very little information (only the truly most basic information about a request).
-
+Net-SNMP Agent handler and extensibility API \-
.PP
-.SS "Modules"
+The basic theory goes something like this: In the past, with the original mib \fBmodule\fP api (which derived from the original CMU SNMP code) the underlying mib modules were passed very little information (only the truly most basic information about a request).
-.in +1c
-.ti -1c
-.RI "\fButility_handlers\fP"
-.br
-.RI "\fISimplify request processing A group of handlers intended to simplify certain aspects of processing a request for a MIB object. \fP"
-.PP
-.in +1c
-
-.ti -1c
-.RI "\fBleaf_handlers\fP"
-.br
-.RI "\fIProcess individual leaf objects A group of handlers to implement individual leaf objects and instances (both scalar objects, and individual objects and instances within a table). \fP"
-.PP
-.in +1c
-
-.ti -1c
-.RI "\fBbaby_steps\fP"
-.br
-.RI "\fICalls your handler in baby_steps for set processing. \fP"
-.PP
-.in +1c
-
-.ti -1c
-.RI "\fBold_api\fP"
-.br
-.RI "\fICalls mib module code written in the old style of code. \fP"
-.PP
-.in +1c
-
-.ti -1c
-.RI "\fBstash_cache\fP"
-.br
-.RI "\fIAutomatically caches data for certain handlers. \fP"
-.PP
-.in +1c
-
-.ti -1c
-.RI "\fBtable\fP"
-.br
-.RI "\fIHelps you implement a table. \fP"
-.PP
-
-.in -1c
.SS "Data Structures"
.in +1c
@@ -67,14 +23,46 @@
.ti -1c
.RI "struct \fBnetsnmp_delegated_cache_s\fP"
.br
+.in -1c
+.SS "Modules"
+
+.in +1c
.ti -1c
-.RI "struct \fBnetsnmp_mib_handler_s\fP"
+.RI "\fButility_handlers\fP"
.br
-.RI "\fIthe mib handler structure to be registered \fP"
+.PP
+
+.RI "\fISimplify request processing A group of handlers intended to simplify certain aspects of processing a request for a MIB object. \fP"
.ti -1c
-.RI "struct \fBnetsnmp_handler_registration_s\fP"
+.RI "\fBleaf_handlers\fP"
.br
-.RI "\fIRoot registration info. \fP"
+.PP
+
+.RI "\fIProcess individual leaf objects A group of handlers to implement individual leaf objects and instances (both scalar objects, and individual objects and instances within a table). \fP"
+.ti -1c
+.RI "\fBbaby_steps\fP"
+.br
+.PP
+
+.RI "\fICalls your handler in baby_steps for set processing. \fP"
+.ti -1c
+.RI "\fBold_api\fP"
+.br
+.PP
+
+.RI "\fICalls mib \fBmodule\fP code written in the old style of code. \fP"
+.ti -1c
+.RI "\fBstash_cache\fP"
+.br
+.PP
+
+.RI "\fIAutomatically caches data for certain handlers. \fP"
+.ti -1c
+.RI "\fBtable\fP"
+.br
+.PP
+
+.RI "\fIHelps you implement a table. \fP"
.in -1c
.SS "Defines"
@@ -141,28 +129,28 @@
.in +1c
.ti -1c
-.RI "typedef \fBnetsnmp_mib_handler_s\fP \fBnetsnmp_mib_handler\fP"
+.RI "typedef struct \fBnetsnmp_mib_handler_s\fP \fBnetsnmp_mib_handler\fP"
.br
.RI "\fITypedefs the \fBnetsnmp_mib_handler_s\fP struct into netsnmp_mib_handler. \fP"
.ti -1c
-.RI "typedef \fBnetsnmp_handler_registration_s\fP \fBnetsnmp_handler_registration\fP"
+.RI "typedef struct \fBnetsnmp_handler_registration_s\fP \fBnetsnmp_handler_registration\fP"
.br
.RI "\fITypedefs the \fBnetsnmp_handler_registration_s\fP struct into netsnmp_handler_registration. \fP"
.ti -1c
.RI "typedef int( \fBNetsnmp_Node_Handler\fP )(\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *requests)"
.br
.ti -1c
-.RI "typedef \fBnetsnmp_handler_args_s\fP \fBnetsnmp_handler_args\fP"
+.RI "typedef struct \fBnetsnmp_handler_args_s\fP \fBnetsnmp_handler_args\fP"
.br
.ti -1c
-.RI "typedef \fBnetsnmp_delegated_cache_s\fP \fBnetsnmp_delegated_cache\fP"
+.RI "typedef struct \fBnetsnmp_delegated_cache_s\fP \fBnetsnmp_delegated_cache\fP"
.br
.in -1c
.SS "Functions"
.in +1c
.ti -1c
-.RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_create_handler\fP (const char *name, \fBNetsnmp_Node_Handler\fP *handler_access_method)"
+.RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_create_handler\fP (const char *name, Netsnmp_Node_Handler *handler_access_method)"
.br
.RI "\fIcreates a netsnmp_mib_handler structure given a name and a access method. \fP"
.ti -1c
@@ -170,7 +158,7 @@
.br
.RI "\fIcreates a handler registration structure given a name, a access_method function, a registration location oid and the modes the handler supports. \fP"
.ti -1c
-.RI "\fBnetsnmp_handler_registration\fP * \fBnetsnmp_create_handler_registration\fP (const char *name, \fBNetsnmp_Node_Handler\fP *handler_access_method, oid *reg_oid, size_t reg_oid_len, int modes)"
+.RI "\fBnetsnmp_handler_registration\fP * \fBnetsnmp_create_handler_registration\fP (const char *name, Netsnmp_Node_Handler *handler_access_method, oid *reg_oid, size_t reg_oid_len, int modes)"
.br
.ti -1c
.RI "int \fBnetsnmp_register_handler\fP (\fBnetsnmp_handler_registration\fP *reginfo)"
@@ -250,7 +238,7 @@
.ti -1c
.RI "NETSNMP_INLINE void * \fBnetsnmp_request_get_list_data\fP (\fBnetsnmp_request_info\fP *request, const char *name)"
.br
-.RI "\fIextract data from a request that was added previously by a parent module \fP"
+.RI "\fIextract data from a request that was added previously by a parent \fBmodule\fP \fP"
.ti -1c
.RI "NETSNMP_INLINE void \fBnetsnmp_free_request_data_set\fP (\fBnetsnmp_request_info\fP *request)"
.br
@@ -293,15 +281,15 @@
.in -1c
.SH "Detailed Description"
.PP
-The basic theory goes something like this: In the past, with the original mib module api (which derived from the original CMU SNMP code) the underlying mib modules were passed very little information (only the truly most basic information about a request).
-.PP
+The basic theory goes something like this: In the past, with the original mib \fBmodule\fP api (which derived from the original CMU SNMP code) the underlying mib modules were passed very little information (only the truly most basic information about a request).
+
This worked well at the time but in todays world of subagents, device instrumentation, low resource consumption, etc, it just isn't flexible enough. 'handlers' are here to fix all that.
.PP
With the rewrite of the agent internals for the net-snmp 5.0 release, we introduce a modular calling scheme that allows agent modules to be written in a very flexible manner, and more importantly allows reuse of code in a decent way (and without the memory and speed overheads of OO languages like C++).
.PP
-Functionally, the notion of what a handler does is the same as the older api: A handler is \fBcreated\fP and then \fBregistered\fP with the main agent at a given OID in the OID tree and gets called any time a request is made that it should respond to. You probably should use one of the convenience helpers instead of doing anything else yourself though:
+Functionally, the notion of what a handler does is the same as the older api: A handler is \fBcreated\fP and then \fBregistered\fP with the main agent at a given OID in the OID \fBtree\fP and gets called any time a request is made that it should respond to. You probably should use one of the convenience helpers instead of doing anything else yourself though:
.PP
-Most importantly, though, is that the handlers are built on the notion of modularity and reuse. Specifically, rather than do all the really hard work (like parsing table indexes out of an incoming oid request) in each module, the API is designed to make it easy to write 'helper' handlers that merely process some aspect of the request before passing it along to the final handler that returns the real answer. Most people will want to make use of the \fBinstance\fP, \fBtable\fP, \fBtable_iterator\fP, \fBtable_data\fP, or \fBtable_dataset\fP helpers to make their life easier. These 'helpers' interpert important aspects of the request and pass them on to you.
+Most importantly, though, is that the handlers are built on the notion of modularity and reuse. Specifically, rather than do all the really hard work (like parsing table indexes out of an incoming oid request) in each \fBmodule\fP, the API is designed to make it easy to write 'helper' handlers that merely process some aspect of the request before passing it along to the final handler that returns the real answer. Most people will want to make use of the \fBinstance\fP, \fBtable\fP, \fBtable_iterator\fP, \fBtable_data\fP, or \fBtable_dataset\fP helpers to make their life easier. These 'helpers' interpert important aspects of the request and pass them on to you.
.PP
For instance, the \fBtable\fP helper is designed to hand you a list of extracted index values from an incoming request. THe \fBtable_iterator\fP helper is built on top of the table helper, and is designed to help you iterate through data stored elsewhere (like in a kernel) that is not in OID lexographical order (ie, don't write your own index/oid sorting routine, use this helper instead). The beauty of the \fBtable_iterator helper\fP, as well as the \fBinstance\fP helper is that they take care of the complex GETNEXT processing entirely for you and hand you everything you need to merely return the data as if it was a GET request. Much less code and hair pulling. I've pulled all my hair out to help you so that only one of us has to be bald.
.SH "Typedef Documentation"
@@ -309,65 +297,33 @@
.SS "struct \fBnetsnmp_handler_registration_s\fP \fBnetsnmp_handler_registration\fP"
.PP
Typedefs the \fBnetsnmp_handler_registration_s\fP struct into netsnmp_handler_registration.
-.PP
.SS "struct \fBnetsnmp_mib_handler_s\fP \fBnetsnmp_mib_handler\fP"
.PP
Typedefs the \fBnetsnmp_mib_handler_s\fP struct into netsnmp_mib_handler.
-.PP
.SH "Function Documentation"
.PP
.SS "int netsnmp_call_handler (\fBnetsnmp_mib_handler\fP * next_handler, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests)"
.PP
calls a handler with with appropriate NULL checking of arguments, etc.
-.PP
-Definition at line 394 of file agent_handler.c.
-.PP
-References netsnmp_mib_handler_s::access_method, netsnmp_mib_handler_s::handler_name, MIB_HANDLER_AUTO_NEXT, MIB_HANDLER_AUTO_NEXT_OVERRIDE_ONCE, netsnmp_agent_request_info_s::mode, netsnmp_mib_handler_s::next, NULL, and snmp_log().
-.PP
-Referenced by netsnmp_call_handlers(), netsnmp_call_next_handler(), netsnmp_call_next_handler_one_request(), netsnmp_mode_end_call_helper(), and netsnmp_multiplexer_helper_handler().
.SS "int netsnmp_call_next_handler (\fBnetsnmp_mib_handler\fP * current, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests)"
.PP
calls the next handler in the chain after the current one with with appropriate NULL checking, etc.
-.PP
-Definition at line 524 of file agent_handler.c.
-.PP
-References netsnmp_call_handler(), netsnmp_mib_handler_s::next, NULL, and snmp_log().
-.PP
-Referenced by _netsnmp_stash_cache_load(), netsnmp_bulk_to_next_helper(), netsnmp_debug_helper(), netsnmp_instance_counter32_handler(), netsnmp_instance_helper_handler(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_num_file_handler(), netsnmp_instance_uint_handler(), netsnmp_instance_ulong_handler(), netsnmp_mode_end_call_helper(), netsnmp_row_merge_helper_handler(), netsnmp_scalar_group_helper_handler(), netsnmp_scalar_helper_handler(), netsnmp_serialize_helper_handler(), netsnmp_stash_to_next_helper(), and table_helper_handler().
.SS "int netsnmp_call_next_handler_one_request (\fBnetsnmp_mib_handler\fP * current, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests)"
.PP
calls the next handler in the chain after the current one with with appropriate NULL checking, etc.
-.PP
-Definition at line 546 of file agent_handler.c.
-.PP
-References netsnmp_call_handler(), netsnmp_mib_handler_s::next, netsnmp_request_info_s::next, NULL, and snmp_log().
.SS "void netsnmp_clear_handler_list (void)"
.PP
clears the entire handler-registration list
-.PP
-Definition at line 905 of file agent_handler.c.
-.PP
-References netsnmp_free_all_list_data(), and NULL.
-.PP
-Referenced by shutdown_agent().
.SS "NETSNMP_INLINE \fBnetsnmp_delegated_cache\fP * netsnmp_create_delegated_cache (\fBnetsnmp_mib_handler\fP * handler, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests, void * localinfo)"
.PP
-creates a cache of information which can be saved for future reference.
-.PP
-Use \fBnetsnmp_handler_check_cache()\fP later to make sure it's still valid before referencing it in the future.
+creates a cache of information which can be saved for future reference. Use \fBnetsnmp_handler_check_cache()\fP later to make sure it's still valid before referencing it in the future.
.PP
\fBExamples: \fP
.in +1c
\fBdelayed_instance.c\fP.
+.SS "\fBnetsnmp_mib_handler\fP * netsnmp_create_handler (const char * name, Netsnmp_Node_Handler * handler_access_method)"
.PP
-Definition at line 696 of file agent_handler.c.
-.PP
-References netsnmp_agent_request_info_s::asp, netsnmp_delegated_cache_s::handler, netsnmp_delegated_cache_s::localinfo, netsnmp_agent_session_s::pdu, netsnmp_delegated_cache_s::reginfo, netsnmp_delegated_cache_s::reqinfo, netsnmp_delegated_cache_s::requests, SNMP_MALLOC_TYPEDEF, netsnmp_delegated_cache_s::transaction_id, and snmp_pdu::transid.
-.SS "\fBnetsnmp_mib_handler\fP * netsnmp_create_handler (const char * name, \fBNetsnmp_Node_Handler\fP * handler_access_method)"
-.PP
-creates a netsnmp_mib_handler structure given a name and a access method.
-.PP
-The returned handler should then be \fBregistered.\fP
+creates a netsnmp_mib_handler structure given a name and a access method. The returned handler should then be \fBregistered.\fP
.PP
\fBParameters:\fP
.RS 4
@@ -383,38 +339,18 @@
.PP
\fBSee also:\fP
.RS 4
-\fBnetsnmp_create_handler_registration()\fP
+netsnmp_create_handler_registration()
.PP
\fBnetsnmp_register_handler()\fP
.RE
.PP
-.PP
-Definition at line 105 of file agent_handler.c.
-.PP
-References netsnmp_mib_handler_s::access_method, netsnmp_mib_handler_s::handler_name, NULL, SNMP_FREE, and SNMP_MALLOC_TYPEDEF.
-.PP
-Referenced by get_old_api_handler(), netsnmp_baby_steps_access_multiplexer_get(), netsnmp_baby_steps_handler_get(), netsnmp_cache_handler_get(), netsnmp_container_table_handler_get(), netsnmp_create_handler_registration(), netsnmp_get_bulk_to_next_handler(), netsnmp_get_debug_handler(), netsnmp_get_instance_handler(), netsnmp_get_mode_end_call_handler(), netsnmp_get_multiplexer_handler(), netsnmp_get_read_only_handler(), netsnmp_get_row_merge_handler(), netsnmp_get_scalar_group_handler(), netsnmp_get_scalar_handler(), netsnmp_get_serialize_handler(), netsnmp_get_stash_to_next_handler(), netsnmp_get_table_data_handler(), netsnmp_get_table_data_set_handler(), netsnmp_get_table_handler(), netsnmp_get_table_iterator_handler(), netsnmp_get_tdata_handler(), netsnmp_get_timed_bare_stash_cache_handler(), netsnmp_get_watched_spinlock_handler(), netsnmp_get_watched_timestamp_handler(), netsnmp_get_watcher_handler(), netsnmp_sparse_table_handler_get(), netsnmp_sparse_table_register(), netsnmp_table_array_register(), and netsnmp_table_row_handler_get().
.SS "\fBnetsnmp_mib_handler\fP * netsnmp_find_handler_by_name (\fBnetsnmp_handler_registration\fP * reginfo, const char * name)"
.PP
Returns a handler from a chain based on the name.
-.PP
-Definition at line 838 of file agent_handler.c.
-.PP
-References netsnmp_handler_registration_s::handler, netsnmp_mib_handler_s::handler_name, netsnmp_mib_handler_s::next, and NULL.
-.PP
-Referenced by netsnmp_find_handler_data_by_name().
.SS "void * netsnmp_find_handler_data_by_name (\fBnetsnmp_handler_registration\fP * reginfo, const char * name)"
.PP
-Returns a handler's void * pointer from a chain based on the name.
-.PP
-This probably shouldn't be used by the general public as the void * data may change as a handler evolves. Handlers should really advertise some function for you to use instead.
-.PP
-Definition at line 855 of file agent_handler.c.
-.PP
-References netsnmp_mib_handler_s::myvoid, netsnmp_find_handler_by_name(), and NULL.
-.PP
-Referenced by netsnmp_find_table_registration_info().
+Returns a handler's void * pointer from a chain based on the name. This probably shouldn't be used by the general public as the void * data may change as a handler evolves. Handlers should really advertise some function for you to use instead.
.SS "NETSNMP_INLINE void netsnmp_free_delegated_cache (\fBnetsnmp_delegated_cache\fP * dcache)"
.PP
frees a cache once you're finished using it
@@ -422,73 +358,35 @@
\fBExamples: \fP
.in +1c
\fBdelayed_instance.c\fP.
-.PP
-Definition at line 734 of file agent_handler.c.
-.PP
-References SNMP_FREE.
.SS "NETSNMP_INLINE void netsnmp_free_request_data_set (\fBnetsnmp_request_info\fP * request)"
.PP
Free the extra data stored in a request.
-.PP
-Definition at line 820 of file agent_handler.c.
-.PP
-References netsnmp_free_list_data(), and netsnmp_request_info_s::parent_data.
.SS "NETSNMP_INLINE void netsnmp_free_request_data_sets (\fBnetsnmp_request_info\fP * request)"
.PP
Free the extra data stored in a bunch of requests (all data in the chain).
-.PP
-Definition at line 828 of file agent_handler.c.
-.PP
-References netsnmp_free_all_list_data(), NULL, and netsnmp_request_info_s::parent_data.
-.PP
-Referenced by free_agent_snmp_session(), get_set_cache(), netsnmp_add_varbind_to_cache(), and netsnmp_delete_request_infos().
.SS "NETSNMP_INLINE \fBnetsnmp_delegated_cache\fP * netsnmp_handler_check_cache (\fBnetsnmp_delegated_cache\fP * dcache)"
.PP
-check's a given cache and returns it if it is still valid (ie, the agent still considers it to be an outstanding request.
-.PP
-Returns NULL if it's no longer valid.
+check's a given cache and returns it if it is still valid (ie, the agent still considers it to be an outstanding request. Returns NULL if it's no longer valid.
.PP
\fBExamples: \fP
.in +1c
\fBdelayed_instance.c\fP.
-.PP
-Definition at line 720 of file agent_handler.c.
-.PP
-References netsnmp_check_transaction_id(), NULL, and netsnmp_delegated_cache_s::transaction_id.
.SS "\fBnetsnmp_mib_handler\fP * netsnmp_handler_dup (\fBnetsnmp_mib_handler\fP * handler)"
.PP
dulpicates a handler and all subsequent handlers see also _clone_handler
-.PP
-Definition at line 591 of file agent_handler.c.
-.PP
-References netsnmp_mib_handler_s::myvoid, netsnmp_handler_free(), netsnmp_mib_handler_s::next, NULL, and netsnmp_mib_handler_s::prev.
-.PP
-Referenced by netsnmp_handler_registration_dup().
.SS "void netsnmp_handler_free (\fBnetsnmp_mib_handler\fP * handler)"
.PP
free's the resourceses associated with a given handler
.PP
make sure we aren't pointing to ourselves.
.PP
-XXX : segv here at shutdown if SHUTDOWN_AGENT_CLEANLY defined. About 30 functions down the stack, starting in \fBclear_context()\fP -> \fBclear_subtree()\fP
-.PP
-Definition at line 569 of file agent_handler.c.
-.PP
-References netsnmp_mib_handler_s::handler_name, netsnmp_mib_handler_s::next, NULL, and SNMP_FREE.
-.PP
-Referenced by handler_free_callback(), netsnmp_baby_steps_handler_get(), netsnmp_get_scalar_group_handler(), netsnmp_get_timed_bare_stash_cache_handler(), netsnmp_handler_dup(), and netsnmp_handler_registration_free().
+XXX : segv here at shutdown if SHUTDOWN_AGENT_CLEANLY defined. About 30 functions down the stack, starting in clear_context() -> clear_subtree()
.SS "void netsnmp_handler_mark_requests_as_delegated (\fBnetsnmp_request_info\fP * requests, int isdelegated)"
.PP
marks a list of requests as delegated (or not if isdelegaded = 0)
-.PP
-Definition at line 748 of file agent_handler.c.
-.PP
-References netsnmp_request_info_s::delegated, and netsnmp_request_info_s::next.
.SS "\fBnetsnmp_handler_registration\fP * netsnmp_handler_registration_create (const char * name, \fBnetsnmp_mib_handler\fP * handler, oid * reg_oid, size_t reg_oid_len, int modes)"
.PP
-creates a handler registration structure given a name, a access_method function, a registration location oid and the modes the handler supports.
-.PP
-If modes == 0, then modes will automatically be set to the default value of only HANDLER_CAN_DEFAULT, which is by default read-only GET and GETNEXT requests. A hander which supports sets but not row creation should set us a mode of HANDLER_CAN_SET_ONLY.
+creates a handler registration structure given a name, a access_method function, a registration location oid and the modes the handler supports. If modes == 0, then modes will automatically be set to the default value of only HANDLER_CAN_DEFAULT, which is by default read-only GET and GETNEXT requests. A hander which supports sets but not row creation should set us a mode of HANDLER_CAN_SET_ONLY.
.PP
\fBNote:\fP
.RS 4
@@ -537,88 +435,34 @@
.RE
.PP
-.PP
-Definition at line 163 of file agent_handler.c.
-.PP
-References netsnmp_handler_registration_s::handler, HANDLER_CAN_DEFAULT, netsnmp_handler_registration_s::handlerName, memdup(), netsnmp_handler_registration_s::modes, NULL, netsnmp_handler_registration_s::priority, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, and SNMP_MALLOC_TYPEDEF.
-.PP
-Referenced by netsnmp_create_handler_registration().
.SS "\fBnetsnmp_handler_registration\fP * netsnmp_handler_registration_dup (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
duplicates the handler registration object
-.PP
-Definition at line 634 of file agent_handler.c.
-.PP
-References netsnmp_handler_registration_s::contextName, netsnmp_handler_registration_s::handler, netsnmp_handler_registration_s::handlerName, memdup(), netsnmp_handler_registration_s::modes, netsnmp_handler_dup(), netsnmp_handler_registration_free(), NULL, netsnmp_handler_registration_s::priority, netsnmp_handler_registration_s::range_subid, netsnmp_handler_registration_s::range_ubound, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, and netsnmp_handler_registration_s::timeout.
-.PP
-Referenced by netsnmp_subtree_deepcopy().
.SS "void netsnmp_handler_registration_free (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
free the resources associated with a handler registration object
-.PP
-Definition at line 620 of file agent_handler.c.
-.PP
-References netsnmp_handler_registration_s::contextName, netsnmp_handler_registration_s::handler, netsnmp_handler_registration_s::handlerName, netsnmp_handler_free(), NULL, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, and SNMP_FREE.
-.PP
-Referenced by netsnmp_handler_registration_dup(), netsnmp_register_mib(), netsnmp_register_mib_table_row(), netsnmp_subtree_free(), and unregister_mibs_by_session().
.SS "int netsnmp_inject_handler (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_mib_handler\fP * handler)"
.PP
-inject a new handler into the calling chain of the handlers definedy by the netsnmp_handler_registration pointer.
-.PP
-The new handler is injected at the top of the list and hence will be the new handler to be called first.
-.PP
-Definition at line 386 of file agent_handler.c.
-.PP
-References netsnmp_inject_handler_before(), and NULL.
-.PP
-Referenced by netsnmp_cache_handler_register(), netsnmp_container_table_register(), netsnmp_register_cache_handler(), netsnmp_register_handler(), netsnmp_register_instance(), netsnmp_register_read_only_instance(), netsnmp_register_read_only_scalar(), netsnmp_register_read_only_table_data(), netsnmp_register_row_merge(), netsnmp_register_scalar(), netsnmp_register_scalar_group(), netsnmp_register_serialize(), netsnmp_register_table(), netsnmp_register_table_data(), netsnmp_register_table_data_set(), netsnmp_register_table_iterator(), netsnmp_register_watched_instance(), netsnmp_register_watched_scalar(), netsnmp_register_watched_spinlock(), netsnmp_sparse_table_register(), netsnmp_table_array_register(), netsnmp_table_row_register(), netsnmp_tdata_register(), and netsnmp_watched_timestamp_register().
+inject a new handler into the calling chain of the handlers definedy by the netsnmp_handler_registration pointer. The new handler is injected at the top of the list and hence will be the new handler to be called first.
.SS "int netsnmp_inject_handler_before (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_mib_handler\fP * handler, const char * before_what)"
.PP
-inject a new handler into the calling chain of the handlers definedy by the netsnmp_handler_registration pointer.
-.PP
-The new handler is injected after the before_what handler, or if NULL at the top of the list and hence will be the new handler to be called first.
-.PP
-Definition at line 329 of file agent_handler.c.
-.PP
-References netsnmp_handler_registration_s::handler, netsnmp_mib_handler_s::handler_name, netsnmp_mib_handler_s::next, NULL, netsnmp_mib_handler_s::prev, and snmp_log().
-.PP
-Referenced by netsnmp_inject_handler(), and netsnmp_inject_handler_into_subtree().
+inject a new handler into the calling chain of the handlers definedy by the netsnmp_handler_registration pointer. The new handler is injected after the before_what handler, or if NULL at the top of the list and hence will be the new handler to be called first.
.SS "int netsnmp_register_handler (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
register a handler, as defined by the netsnmp_handler_registration pointer.
-.PP
-Definition at line 202 of file agent_handler.c.
-.PP
-References netsnmp_handler_registration_s::contextName, netsnmp_mib_handler_s::flags, netsnmp_handler_registration_s::handler, HANDLER_CAN_DEFAULT, HANDLER_CAN_GETBULK, netsnmp_mib_handler_s::handler_name, netsnmp_handler_registration_s::handlerName, MIB_HANDLER_INSTANCE, netsnmp_handler_registration_s::modes, netsnmp_get_bulk_to_next_handler(), netsnmp_inject_handler(), netsnmp_register_mib(), netsnmp_mib_handler_s::next, NULL, netsnmp_handler_registration_s::priority, netsnmp_handler_registration_s::range_subid, netsnmp_handler_registration_s::range_ubound, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, snmp_log(), and netsnmp_handler_registration_s::timeout.
-.PP
-Referenced by netsnmp_cache_handler_register(), netsnmp_register_cache_handler(), netsnmp_register_old_api(), netsnmp_register_row_merge(), netsnmp_register_serialize(), netsnmp_register_table(), netsnmp_sparse_table_register(), and netsnmp_table_row_register().
.SS "void netsnmp_register_handler_by_name (const char * name, \fBnetsnmp_mib_handler\fP * handler)"
.PP
registers a given handler by name so that it can be found easily later.
-.PP
-Definition at line 893 of file agent_handler.c.
-.PP
-References handler_free_callback(), netsnmp_add_list_data(), and netsnmp_create_data_list().
-.PP
-Referenced by netsnmp_baby_steps_handler_init(), netsnmp_init_bulk_to_next_helper(), netsnmp_init_debug_helper(), netsnmp_init_read_only_helper(), netsnmp_init_row_merge(), netsnmp_init_serialize(), and netsnmp_init_stash_cache_helper().
.SS "int netsnmp_register_handler_nocallback (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
register a handler, as defined by the netsnmp_handler_registration pointer.
-.PP
-Definition at line 277 of file agent_handler.c.
-.PP
-References netsnmp_handler_registration_s::contextName, netsnmp_handler_registration_s::handler, HANDLER_CAN_DEFAULT, netsnmp_mib_handler_s::handler_name, netsnmp_handler_registration_s::modes, netsnmp_register_mib(), netsnmp_mib_handler_s::next, NULL, netsnmp_handler_registration_s::priority, netsnmp_handler_registration_s::range_subid, netsnmp_handler_registration_s::range_ubound, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, snmp_log(), and netsnmp_handler_registration_s::timeout.
-.PP
-Referenced by netsnmp_register_mib_table_row().
.SS "NETSNMP_INLINE void netsnmp_request_add_list_data (\fBnetsnmp_request_info\fP * request, \fBnetsnmp_data_list\fP * node)"
.PP
-add data to a request that can be extracted later by submodules
-.PP
-\fBParameters:\fP
+add data to a request that can be extracted later by submodules \fBParameters:\fP
.RS 4
\fIrequest\fP the netsnmp request info structure
.br
-\fInode\fP this is the data to be added to the linked list request->parent_data
+\fI\fBnode\fP\fP this is the data to be added to the linked list request->parent_data
.RE
.PP
\fBReturns:\fP
@@ -631,17 +475,9 @@
\fBExamples: \fP
.in +1c
\fBdelayed_instance.c\fP.
-.PP
-Definition at line 768 of file agent_handler.c.
-.PP
-References netsnmp_add_list_data(), and netsnmp_request_info_s::parent_data.
-.PP
-Referenced by _netsnmp_tdata_helper_handler(), netsnmp_container_table_row_insert(), netsnmp_insert_iterator_context(), netsnmp_insert_table_row(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_num_file_handler(), netsnmp_instance_uint_handler(), netsnmp_instance_ulong_handler(), netsnmp_table_data_helper_handler(), netsnmp_table_data_set_helper_handler(), netsnmp_table_iterator_helper_handler(), netsnmp_watcher_helper_handler(), and table_helper_handler().
.SS "NETSNMP_INLINE void * netsnmp_request_get_list_data (\fBnetsnmp_request_info\fP * request, const char * name)"
.PP
-extract data from a request that was added previously by a parent module
-.PP
-\fBParameters:\fP
+extract data from a request that was added previously by a parent \fBmodule\fP \fBParameters:\fP
.RS 4
\fIrequest\fP the netsnmp request info function
.br
@@ -658,17 +494,9 @@
\fBExamples: \fP
.in +1c
\fBdelayed_instance.c\fP.
-.PP
-Definition at line 810 of file agent_handler.c.
-.PP
-References netsnmp_get_list_data(), NULL, and netsnmp_request_info_s::parent_data.
-.PP
-Referenced by netsnmp_container_table_container_extract(), netsnmp_container_table_extract_context(), netsnmp_container_table_row_extract(), netsnmp_extract_array_context(), netsnmp_extract_iterator_context(), netsnmp_extract_table(), netsnmp_extract_table_data_set(), netsnmp_extract_table_info(), netsnmp_extract_table_row(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_num_file_handler(), netsnmp_instance_uint_handler(), netsnmp_instance_ulong_handler(), netsnmp_table_iterator_helper_handler(), netsnmp_table_row_extract(), netsnmp_tdata_extract_container(), netsnmp_tdata_extract_table(), and netsnmp_watcher_helper_handler().
.SS "NETSNMP_INLINE int netsnmp_request_remove_list_data (\fBnetsnmp_request_info\fP * request, const char * name)"
.PP
-remove data from a request
-.PP
-\fBParameters:\fP
+remove data from a request \fBParameters:\fP
.RS 4
\fIrequest\fP the netsnmp request info structure
.br
@@ -681,16 +509,9 @@
.RE
.PP
-.PP
-Definition at line 789 of file agent_handler.c.
-.PP
-References netsnmp_remove_list_node(), NULL, and netsnmp_request_info_s::parent_data.
-.PP
-Referenced by netsnmp_table_data_set_helper_handler().
.SS "int netsnmp_unregister_handler (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
unregister a handler, as defined by the netsnmp_handler_registration pointer.
-.PP
-Definition at line 267 of file agent_handler.c.
-.PP
-References netsnmp_handler_registration_s::contextName, netsnmp_handler_registration_s::priority, netsnmp_handler_registration_s::range_subid, netsnmp_handler_registration_s::range_ubound, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, and unregister_mib_context().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_instance.3 b/man/netsnmp_instance.3
index 63c117f..9e8fe7a 100644
--- a/man/netsnmp_instance.3
+++ b/man/netsnmp_instance.3
@@ -1,10 +1,11 @@
-.TH "instance" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "instance" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-instance \- Process individual MIB instances easily.
-
+instance \-
.PP
+Process individual MIB instances easily.
+
.SS "Functions"
.in +1c
@@ -21,61 +22,61 @@
.br
.RI "\fIThis function injects a 'read only' handler into the handler chain prior to serializing/registering the handler. \fP"
.ti -1c
-.RI "int \fBnetsnmp_register_read_only_ulong_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_read_only_ulong_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, Netsnmp_Node_Handler *subhandler)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_ulong_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_ulong_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, Netsnmp_Node_Handler *subhandler)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_read_only_counter32_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_read_only_counter32_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, Netsnmp_Node_Handler *subhandler)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_read_only_long_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, long *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_read_only_long_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, long *it, Netsnmp_Node_Handler *subhandler)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_long_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, long *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_long_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, long *it, Netsnmp_Node_Handler *subhandler)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_read_only_uint_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, unsigned int *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_read_only_uint_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, unsigned int *it, Netsnmp_Node_Handler *subhandler)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_uint_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, unsigned int *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_uint_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, unsigned int *it, Netsnmp_Node_Handler *subhandler)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_read_only_int_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_read_only_int_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, Netsnmp_Node_Handler *subhandler)"
.br
.ti -1c
-.RI "int \fBregister_read_only_int_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBregister_read_only_int_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, Netsnmp_Node_Handler *subhandler)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_read_only_ulong_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, \fBNetsnmp_Node_Handler\fP *subhandler, const char *contextName)"
+.RI "int \fBnetsnmp_register_read_only_ulong_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, Netsnmp_Node_Handler *subhandler, const char *contextName)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_ulong_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, \fBNetsnmp_Node_Handler\fP *subhandler, const char *contextName)"
+.RI "int \fBnetsnmp_register_ulong_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, Netsnmp_Node_Handler *subhandler, const char *contextName)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_read_only_counter32_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, \fBNetsnmp_Node_Handler\fP *subhandler, const char *contextName)"
+.RI "int \fBnetsnmp_register_read_only_counter32_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, Netsnmp_Node_Handler *subhandler, const char *contextName)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_read_only_long_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, long *it, \fBNetsnmp_Node_Handler\fP *subhandler, const char *contextName)"
+.RI "int \fBnetsnmp_register_read_only_long_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, long *it, Netsnmp_Node_Handler *subhandler, const char *contextName)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_long_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, long *it, \fBNetsnmp_Node_Handler\fP *subhandler, const char *contextName)"
+.RI "int \fBnetsnmp_register_long_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, long *it, Netsnmp_Node_Handler *subhandler, const char *contextName)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_int_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, \fBNetsnmp_Node_Handler\fP *subhandler, const char *contextName)"
+.RI "int \fBnetsnmp_register_int_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, Netsnmp_Node_Handler *subhandler, const char *contextName)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_read_only_int_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, \fBNetsnmp_Node_Handler\fP *subhandler, const char *contextName)"
+.RI "int \fBnetsnmp_register_read_only_int_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, Netsnmp_Node_Handler *subhandler, const char *contextName)"
.br
.ti -1c
-.RI "int \fBregister_read_only_int_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, \fBNetsnmp_Node_Handler\fP *subhandler, const char *contextName)"
+.RI "int \fBregister_read_only_int_instance_context\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, Netsnmp_Node_Handler *subhandler, const char *contextName)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_num_file_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, char *file_name, int asn_type, int mode, \fBNetsnmp_Node_Handler\fP *subhandler, const char *contextName)"
+.RI "int \fBnetsnmp_register_num_file_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, char *file_name, int asn_type, int mode, Netsnmp_Node_Handler *subhandler, const char *contextName)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_int_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_int_instance\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, Netsnmp_Node_Handler *subhandler)"
.br
.RI "\fIThis function registers an int helper handler to a specified OID. \fP"
.ti -1c
@@ -103,14 +104,11 @@
.SH "Detailed Description"
.PP
Process individual MIB instances easily.
-.PP
.SH "Function Documentation"
.PP
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_instance_handler (void)"
.PP
-Creates an instance helper handler, calls netsnmp_create_handler, which then could be registered, using \fBnetsnmp_register_handler()\fP.
-.PP
-\fBReturns:\fP
+Creates an instance helper handler, calls netsnmp_create_handler, which then could be registered, using \fBnetsnmp_register_handler()\fP. \fBReturns:\fP
.RS 4
Returns a pointer to a netsnmp_mib_handler struct which contains the handler's name and the access method
.RE
@@ -118,22 +116,14 @@
.PP
Definition at line 48 of file instance.c.
-.PP
-References netsnmp_create_handler(), and netsnmp_instance_helper_handler().
-.PP
-Referenced by netsnmp_register_instance(), netsnmp_register_read_only_instance(), netsnmp_register_read_only_scalar(), netsnmp_register_scalar(), and netsnmp_register_scalar_group().
.SS "int netsnmp_instance_num_file_handler (\fBnetsnmp_mib_handler\fP * handler, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests)"
.PP
+fall through
+.PP
Definition at line 741 of file instance.c.
-.PP
-References netsnmp_mib_handler_s::access_method, netsnmp_num_file_instance_s::file_name, netsnmp_num_file_instance_s::filep, netsnmp_vardata::integer, memdup(), netsnmp_agent_request_info_s::mode, netsnmp_mib_handler_s::myvoid, netsnmp_call_next_handler(), netsnmp_create_data_list(), netsnmp_request_add_list_data(), netsnmp_request_get_list_data(), netsnmp_set_request_error(), netsnmp_mib_handler_s::next, NULL, netsnmp_request_info_s::requestvb, snmp_set_var_typed_value(), variable_list::type, netsnmp_num_file_instance_s::type, and variable_list::val.
-.PP
-Referenced by netsnmp_register_num_file_instance().
.SS "int netsnmp_register_instance (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
-This function registers an instance helper handler, which is a way of registering an exact OID such that GENEXT requests are handled entirely by the helper.
-.PP
-First need to inject it into the calling chain of the handler defined by the netsnmp_handler_registration struct, reginfo. The new handler is injected at the top of the list and will be the new handler to be called first. This function also injects a serialize handler before actually calling netsnmp_register_handle, registering reginfo.
+This function registers an instance helper handler, which is a way of registering an exact OID such that GENEXT requests are handled entirely by the helper. First need to inject it into the calling chain of the handler defined by the netsnmp_handler_registration struct, reginfo. The new handler is injected at the top of the list and will be the new handler to be called first. This function also injects a serialize handler before actually calling netsnmp_register_handle, registering reginfo.
.PP
\fBParameters:\fP
.RS 4
@@ -152,15 +142,9 @@
\fBdelayed_instance.c\fP.
.PP
Definition at line 73 of file instance.c.
+.SS "int netsnmp_register_int_instance (const char * name, oid * reg_oid, size_t reg_oid_len, int * it, Netsnmp_Node_Handler * subhandler)"
.PP
-References netsnmp_mib_handler_s::flags, MIB_HANDLER_INSTANCE, netsnmp_get_instance_handler(), netsnmp_inject_handler(), and netsnmp_register_serialize().
-.PP
-Referenced by netsnmp_register_int_instance(), netsnmp_register_int_instance_context(), netsnmp_register_long_instance(), netsnmp_register_long_instance_context(), netsnmp_register_num_file_instance(), netsnmp_register_uint_instance(), netsnmp_register_ulong_instance(), netsnmp_register_ulong_instance_context(), and netsnmp_register_watched_instance().
-.SS "int netsnmp_register_int_instance (const char * name, oid * reg_oid, size_t reg_oid_len, int * it, \fBNetsnmp_Node_Handler\fP * subhandler)"
-.PP
-This function registers an int helper handler to a specified OID.
-.PP
-\fBParameters:\fP
+This function registers an int helper handler to a specified OID. \fBParameters:\fP
.RS 4
\fIname\fP the name used for registration pruposes.
.br
@@ -185,13 +169,9 @@
\fBscalar_int.c\fP.
.PP
Definition at line 460 of file instance.c.
-.PP
-References HANDLER_CAN_RWRITE, netsnmp_instance_int_handler(), netsnmp_register_instance(), and NULL.
.SS "int netsnmp_register_read_only_instance (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
-This function injects a 'read only' handler into the handler chain prior to serializing/registering the handler.
-.PP
-The only purpose of this 'read only' handler is to return an appropriate error for any requests passed to it in a SET mode. Inserting it into your handler chain will ensure you're never asked to perform a SET request so you can ignore those error conditions.
+This function injects a 'read only' handler into the handler chain prior to serializing/registering the handler. The only purpose of this 'read only' handler is to return an appropriate error for any requests passed to it in a SET mode. Inserting it into your handler chain will ensure you're never asked to perform a SET request so you can ignore those error conditions.
.PP
\fBParameters:\fP
.RS 4
@@ -206,7 +186,6 @@
.PP
Definition at line 100 of file instance.c.
-.PP
-References netsnmp_get_instance_handler(), netsnmp_get_read_only_handler(), netsnmp_inject_handler(), and netsnmp_register_serialize().
-.PP
-Referenced by netsnmp_register_num_file_instance(), netsnmp_register_read_only_counter32_instance(), netsnmp_register_read_only_counter32_instance_context(), netsnmp_register_read_only_int_instance(), netsnmp_register_read_only_int_instance_context(), netsnmp_register_read_only_long_instance(), netsnmp_register_read_only_long_instance_context(), netsnmp_register_read_only_uint_instance(), netsnmp_register_read_only_ulong_instance(), and netsnmp_register_read_only_ulong_instance_context().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_iterator_info_s.3 b/man/netsnmp_iterator_info_s.3
index 57d83d4..a160ca4 100644
--- a/man/netsnmp_iterator_info_s.3
+++ b/man/netsnmp_iterator_info_s.3
@@ -1,10 +1,11 @@
-.TH "iterator_info_s" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "iterator_info_s" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-iterator_info_s \- Holds iterator information containing functions which should be called by the iterator_handler to loop over your data set and sort it in a SNMP specific manner.
-
+iterator_info_s \-
.PP
+Holds iterator information containing functions which should be called by the iterator_handler to loop over your data set and sort it in a SNMP specific manner.
+
.SH SYNOPSIS
.br
.PP
@@ -15,37 +16,37 @@
.RI "\fBnetsnmp_container\fP \fBc\fP"
.br
.ti -1c
-.RI "\fBNetsnmp_Iterator_Loop_Key\fP * \fBget_first\fP"
+.RI "Netsnmp_Iterator_Loop_Key * \fBget_first\fP"
.br
.ti -1c
-.RI "\fBNetsnmp_Iterator_Loop_Key\fP * \fBget_next\fP"
+.RI "Netsnmp_Iterator_Loop_Key * \fBget_next\fP"
.br
.ti -1c
-.RI "\fBNetsnmp_Iterator_Loop_Data\fP * \fBget_data\fP"
+.RI "Netsnmp_Iterator_Loop_Data * \fBget_data\fP"
.br
.ti -1c
-.RI "\fBNetsnmp_Iterator_Data\fP * \fBfree_user_ctx\fP"
+.RI "Netsnmp_Iterator_Data * \fBfree_user_ctx\fP"
.br
.ti -1c
-.RI "\fBNetsnmp_Iterator_Ctx\fP * \fBinit_loop_ctx\fP"
+.RI "Netsnmp_Iterator_Ctx * \fBinit_loop_ctx\fP"
.br
.ti -1c
-.RI "\fBNetsnmp_Iterator_Ctx\fP * \fBcleanup_loop_ctx\fP"
+.RI "Netsnmp_Iterator_Ctx * \fBcleanup_loop_ctx\fP"
.br
.ti -1c
-.RI "\fBNetsnmp_Iterator_Ctx_Dup\fP * \fBsave_pos\fP"
+.RI "Netsnmp_Iterator_Ctx_Dup * \fBsave_pos\fP"
.br
.ti -1c
-.RI "\fBNetsnmp_Iterator_Data\fP * \fBrelease_data\fP"
+.RI "Netsnmp_Iterator_Data * \fBrelease_data\fP"
.br
.ti -1c
-.RI "\fBNetsnmp_Iterator_Data\fP * \fBinsert_data\fP"
+.RI "Netsnmp_Iterator_Data * \fBinsert_data\fP"
.br
.ti -1c
-.RI "\fBNetsnmp_Iterator_Data\fP * \fBremove_data\fP"
+.RI "Netsnmp_Iterator_Data * \fBremove_data\fP"
.br
.ti -1c
-.RI "\fBNetsnmp_Iterator_Op\fP * \fBget_size\fP"
+.RI "Netsnmp_Iterator_Op * \fBget_size\fP"
.br
.ti -1c
.RI "int \fBsorted\fP"
@@ -69,8 +70,6 @@
This can be used by client handlers to store any information they need.
.PP
Definition at line 69 of file container_iterator.c.
-.PP
-Referenced by netsnmp_container_iterator_get().
.SH "Author"
.PP
diff --git a/man/netsnmp_leaf.3 b/man/netsnmp_leaf.3
index 87b77c4..60ea331 100644
--- a/man/netsnmp_leaf.3
+++ b/man/netsnmp_leaf.3
@@ -1,43 +1,44 @@
-.TH "leaf_handlers" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "leaf_handlers" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-leaf_handlers \- Process individual leaf objects A group of handlers to implement individual leaf objects and instances (both scalar objects, and individual objects and instances within a table).
-
+leaf_handlers \-
.PP
+Process individual leaf objects A group of handlers to implement individual leaf objects and instances (both scalar objects, and individual objects and instances within a table).
+
.SS "Modules"
.in +1c
.ti -1c
.RI "\fBinstance\fP"
.br
-.RI "\fIProcess individual MIB instances easily. \fP"
.PP
-.in +1c
+.RI "\fIProcess individual MIB instances easily. \fP"
.ti -1c
.RI "\fBscalar\fP"
.br
-.RI "\fIProcess scalars easily. \fP"
.PP
-.in +1c
+.RI "\fIProcess scalars easily. \fP"
.ti -1c
.RI "\fBscalar_group\fP"
.br
-.RI "\fIProcess groups of scalars. \fP"
.PP
-.in +1c
+.RI "\fIProcess groups of scalars. \fP"
.ti -1c
.RI "\fBwatcher\fP"
.br
-.RI "\fIWatch a specified variable and process it as an instance or scalar object. \fP"
.PP
+.RI "\fIWatch a specified \fBvariable\fP and process it as an instance or scalar object. \fP"
.in -1c
.SH "Detailed Description"
.PP
Process individual leaf objects A group of handlers to implement individual leaf objects and instances (both scalar objects, and individual objects and instances within a table).
-.PP
+
These handlers will typically allow control to be passed down to a lower level, user-provided handler, but this is (usually) optional.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_library.3 b/man/netsnmp_library.3
index 4441549..378bfaa 100644
--- a/man/netsnmp_library.3
+++ b/man/netsnmp_library.3
@@ -1,18 +1,27 @@
-.TH "The Net-SNMP library" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "The Net-SNMP library" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
The Net-SNMP library \-
+.SS "Data Structures"
+
+.in +1c
+.ti -1c
+.RI "struct \fBsnmp_internal_session\fP"
+.br
+.ti -1c
+.RI "struct \fBsession_list\fP"
+.br
+.in -1c
.SS "Modules"
.in +1c
.ti -1c
.RI "\fBasn1 parsing and datatype manipulation routines.\fP"
.br
-.RI "\fINote on. \fP"
.PP
-.in +1c
+.RI "\fINote on. \fP"
.ti -1c
.RI "\fBA generic callback mechanism\fP"
.br
@@ -22,27 +31,24 @@
.ti -1c
.RI "\fBstorage space for defaults\fP"
.br
-.RI "\fIThe purpose of the default storage is three-fold:. \fP"
.PP
-.in +1c
+.RI "\fIThe purpose of the default storage is three-fold:. \fP"
.ti -1c
.RI "\fBmib parsing and datatype manipulation routines.\fP"
.br
.ti -1c
.RI "\fBStore and retrieve data referenced by an OID.\fP"
.br
-.RI "\fIThis is essentially a way of storing data associated with a given OID. \fP"
.PP
-.in +1c
+.RI "\fIThis is essentially a way of storing data associated with a given OID. \fP"
.ti -1c
.RI "\fBparsing various configuration files at run time\fP"
.br
-.RI "\fIThe read_config related functions are a fairly extensible system of parsing various configuration files at the run time. \fP"
.PP
-.in +1c
+.RI "\fIThe read_config related functions are a fairly extensible system of parsing various configuration files at the run time. \fP"
.ti -1c
.RI "\fBgeneric library based alarm timers for various parts of an application\fP"
.br
@@ -56,16 +62,6 @@
.RI "\fBMemory Utility Routines\fP"
.br
.in -1c
-.SS "Data Structures"
-
-.in +1c
-.ti -1c
-.RI "struct \fBsnmp_internal_session\fP"
-.br
-.ti -1c
-.RI "struct \fBsession_list\fP"
-.br
-.in -1c
.SS "Defines"
.in +1c
@@ -97,21 +93,6 @@
.RI "#define \fBBSD4_2\fP"
.br
.ti -1c
-.RI "#define \fBNFDBITS\fP (sizeof(\fBfd_mask\fP) * NBBY)"
-.br
-.ti -1c
-.RI "#define \fBFD_SET\fP(n, p) ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))"
-.br
-.ti -1c
-.RI "#define \fBFD_CLR\fP(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))"
-.br
-.ti -1c
-.RI "#define \fBFD_ISSET\fP(n, p) ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))"
-.br
-.ti -1c
-.RI "#define \fBFD_ZERO\fP(p) memset((p), 0, sizeof(*(p)))"
-.br
-.ti -1c
.RI "#define \fBDEFAULT_COMMUNITY\fP 'public'"
.br
.ti -1c
@@ -139,13 +120,6 @@
.RI "#define \fBERROR_STAT_LENGTH\fP 11"
.br
.in -1c
-.SS "Typedefs"
-
-.in +1c
-.ti -1c
-.RI "typedef long \fBfd_mask\fP"
-.br
-.in -1c
.SS "Functions"
.in +1c
@@ -219,7 +193,7 @@
.ti -1c
.RI "void \fBinit_snmp\fP (const char *type)"
.br
-.RI "\fICalls the functions to do config file loading and mib module parsing in the correct order. \fP"
+.RI "\fICalls the functions to do config file loading and mib \fBmodule\fP parsing in the correct order. \fP"
.ti -1c
.RI "void \fBsnmp_store\fP (const char *type)"
.br
@@ -265,12 +239,24 @@
.RI "int \fBsnmp_close_sessions\fP (void)"
.br
.ti -1c
+.RI "int \fBsnmpv3_header_realloc_rbuild\fP (u_char **pkt, size_t *pkt_len, size_t *offset, \fBnetsnmp_session\fP *session, \fBnetsnmp_pdu\fP *pdu)"
+.br
+.ti -1c
+.RI "int \fBsnmpv3_scopedPDU_header_realloc_rbuild\fP (u_char **pkt, size_t *pkt_len, size_t *offset, \fBnetsnmp_pdu\fP *pdu, size_t body_len)"
+.br
+.ti -1c
+.RI "int \fBsnmpv3_packet_realloc_rbuild\fP (u_char **pkt, size_t *pkt_len, size_t *offset, \fBnetsnmp_session\fP *session, \fBnetsnmp_pdu\fP *pdu, u_char *pdu_data, size_t pdu_data_len)"
+.br
+.ti -1c
.RI "int \fBsnmpv3_packet_build\fP (\fBnetsnmp_session\fP *session, \fBnetsnmp_pdu\fP *pdu, u_char *packet, size_t *out_length, u_char *pdu_data, size_t pdu_data_len)"
.br
.ti -1c
.RI "u_char * \fBsnmp_pdu_build\fP (\fBnetsnmp_pdu\fP *pdu, u_char *cp, size_t *out_length)"
.br
.ti -1c
+.RI "int \fBsnmp_pdu_realloc_rbuild\fP (u_char **pkt, size_t *pkt_len, size_t *offset, \fBnetsnmp_pdu\fP *pdu)"
+.br
+.ti -1c
.RI "int \fBsnmpv3_parse\fP (\fBnetsnmp_pdu\fP *pdu, u_char *data, size_t *length, u_char **after_header, \fBnetsnmp_session\fP *sess)"
.br
.ti -1c
@@ -401,10 +387,10 @@
.in +1c
.ti -1c
-.RI "\fBmodule_init_list\fP * \fBinitlist\fP = NULL"
+.RI "struct \fBmodule_init_list\fP * \fBinitlist\fP = NULL"
.br
.ti -1c
-.RI "\fBmodule_init_list\fP * \fBnoinitlist\fP = NULL"
+.RI "struct \fBmodule_init_list\fP * \fBnoinitlist\fP = NULL"
.br
.ti -1c
.RI "\fBnetsnmp_subtree\fP * \fBsubtrees\fP"
@@ -416,7 +402,7 @@
.RI "u_char \fBreturn_buf\fP [258]"
.br
.ti -1c
-.RI "timeval \fBstarttime\fP"
+.RI "struct timeval \fBstarttime\fP"
.br
.ti -1c
.RI "int \fBcallback_master_num\fP = -1"
@@ -425,10 +411,10 @@
.RI "oid \fBnullOid\fP [] = { 0, 0 }"
.br
.ti -1c
-.RI "int \fBnullOidLen\fP = sizeof(\fBnullOid\fP)"
+.RI "int \fBnullOidLen\fP = sizeof(nullOid)"
.br
.ti -1c
-.RI "\fBsession_list\fP * \fBSessions\fP = NULL"
+.RI "struct \fBsession_list\fP * \fBSessions\fP = NULL"
.br
.ti -1c
.RI "int \fBsnmp_errno\fP = 0"
@@ -436,9 +422,7 @@
.in -1c
.SH "Define Documentation"
.PP
-.SS "#define timercmp(tvp, uvp, cmp)"
-.PP
-\fBValue:\fP
+.SS "#define timercmp(tvp, uvp, cmp)"\fBValue:\fP
.PP
.nf
/* CSTYLED */ \
@@ -449,22 +433,18 @@
.fi
.PP
Definition at line 148 of file snmp_api.c.
-.PP
-Referenced by netsnmp_addrcache_add(), and snmp_sess_timeout().
.SH "Function Documentation"
.PP
.SS "int _sess_read (void * sessp, fd_set * fdset)"
.PP
-Definition at line 5390 of file snmp_api.c.
+XXX-rks: why no SNMP_FREE(isp->packet); ??
.PP
-References asn_check_packet(), snmp_session::callback, snmp_session::callback_magic, snmp_internal_session::check_packet, netsnmp_transport_s::f_accept, netsnmp_transport_s::f_close, netsnmp_transport_s::f_recv, FD_ISSET, netsnmp_transport_s::flags, snmp_internal_session::hook_build, snmp_internal_session::hook_create_pdu, snmp_internal_session::hook_parse, snmp_internal_session::hook_post, snmp_internal_session::hook_pre, snmp_internal_session::hook_realloc_build, session_list::internal, MAX_PACKET_LENGTH, MAXIMUM_PACKET_SIZE, session_list::next, NULL, snmp_internal_session::packet, snmp_internal_session::packet_len, snmp_internal_session::packet_size, snmp_session::s_errno, snmp_session::s_snmp_errno, session_list::session, Sessions, SNMP_FREE, snmp_log(), snmp_sess_add_ex(), snmp_set_detail(), netsnmp_transport_s::sock, strerror(), and session_list::transport.
+XXX-rks: why no SNMP_FREE(isp->packet); ??
.PP
-Referenced by snmp_sess_read().
+Definition at line 5412 of file snmp_api.c.
.SS "int init_agent (const char * app)"
.PP
-Initialize the agent.
-.PP
-Calls into init_agent_read_config to set tha app's configuration file in the appropriate default storage space, NETSNMP_DS_LIB_APPTYPE. Need to call init_agent before calling init_snmp.
+Initialize the agent. Calls into init_agent_read_config to set tha app's configuration file in the appropriate default storage space, NETSNMP_DS_LIB_APPTYPE. Need to call init_agent before calling init_snmp.
.PP
\fBParameters:\fP
.RS 4
@@ -484,13 +464,9 @@
.PP
Definition at line 270 of file snmp_vars.c.
-.PP
-References _init_agent_callback_transport, init_traps(), netsnmp_ds_get_boolean(), netsnmp_ds_set_boolean(), netsnmp_init_helpers(), NULL, setup_tree(), snmp_log(), and starttime.
.SS "void init_snmp (const char * type)"
.PP
-Calls the functions to do config file loading and mib module parsing in the correct order.
-.PP
-\fBParameters:\fP
+Calls the functions to do config file loading and mib \fBmodule\fP parsing in the correct order. \fBParameters:\fP
.RS 4
\fItype\fP label for the config file 'type'
.RE
@@ -507,14 +483,10 @@
.PP
.PP
-Definition at line 766 of file snmp_api.c.
-.PP
-References init_callbacks(), init_snmp_alarm(), init_snmp_logging(), netsnmp_ds_get_string(), netsnmp_ds_set_string(), netsnmp_init_mib(), read_configs(), read_premib_configs(), register_mib_handlers(), and snmp_init_statistics().
+Definition at line 787 of file snmp_api.c.
.SS "int netsnmp_oid_compare_ll (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2, size_t * offpt)"
.PP
-lexicographical compare two object identifiers and return the point where they differ
-.PP
-Caution: this method is called often by command responder applications (ie, agent).
+lexicographical compare two object identifiers and return the point where they differ Caution: this method is called often by command responder applications (ie, agent).
.PP
\fBReturns:\fP
.RS 4
@@ -523,14 +495,10 @@
.PP
.PP
-Definition at line 6328 of file snmp_api.c.
-.PP
-Referenced by netsnmp_subtree_change_next(), netsnmp_subtree_change_prev(), and netsnmp_subtree_find_prev().
+Definition at line 6350 of file snmp_api.c.
.SS "int netsnmp_oid_equals (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2)"
.PP
-Compares 2 OIDs to determine if they are exactly equal.
-.PP
-This should be faster than doing a snmp_oid_compare for different length OIDs, since the length is checked first and if != returns immediately. Might be very slighly faster if lengths are ==.
+Compares 2 OIDs to determine if they are exactly equal. This should be faster than doing a snmp_oid_compare for different length OIDs, since the length is checked first and if != returns immediately. Might be very slighly faster if lengths are ==.
.PP
\fBParameters:\fP
.RS 4
@@ -550,14 +518,10 @@
.PP
.PP
-Definition at line 6409 of file snmp_api.c.
-.PP
-Referenced by netsnmp_cache_find_by_oid(), netsnmp_subtree_free(), netsnmp_subtree_load(), netsnmp_unregister_mib_table_row(), and unregister_mib_context().
+Definition at line 6431 of file snmp_api.c.
.SS "int netsnmp_oid_find_prefix (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2)"
.PP
-Given two OIDs, determine the common prefix to them both.
-.PP
-\fBParameters:\fP
+Given two OIDs, determine the common prefix to them both. \fBParameters:\fP
.RS 4
\fIin_name1\fP A pointer to the first oid.
.br
@@ -575,16 +539,10 @@
.PP
.PP
-Definition at line 6465 of file snmp_api.c.
-.PP
-References SNMP_MIN.
-.PP
-Referenced by netsnmp_add_varbind_to_cache().
+Definition at line 6487 of file snmp_api.c.
.SS "int netsnmp_oid_is_subtree (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2)"
.PP
-Identical to netsnmp_oid_equals, except only the length up to len1 is compared.
-.PP
-Functionally, this determines if in_name2 is equal or a subtree of in_name1
+Identical to netsnmp_oid_equals, except only the length up to len1 is compared. Functionally, this determines if in_name2 is equal or a subtree of in_name1
.PP
\fBParameters:\fP
.RS 4
@@ -604,12 +562,10 @@
.PP
.PP
-Definition at line 6445 of file snmp_api.c.
+Definition at line 6467 of file snmp_api.c.
.SS "int snmp_oid_compare (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2)"
.PP
-lexicographical compare two object identifiers.
-.PP
-Caution: this method is called often by command responder applications (ie, agent).
+lexicographical compare two object identifiers. Caution: this method is called often by command responder applications (ie, agent).
.PP
\fBReturns:\fP
.RS 4
@@ -618,14 +574,10 @@
.PP
.PP
-Definition at line 6279 of file snmp_api.c.
-.PP
-Referenced by check_getnext_results(), convert_v2pdu_to_v1(), find_varbind_in_list(), lookup_cache_find(), netsnmp_bulk_to_next_fix_requests(), netsnmp_check_getnext_reply(), netsnmp_container_table_row_insert(), netsnmp_insert_iterator_context(), netsnmp_insert_table_row(), netsnmp_instance_helper_handler(), netsnmp_iterator_row_get_byoid(), netsnmp_iterator_row_next_byoid(), netsnmp_scalar_group_helper_handler(), netsnmp_scalar_helper_handler(), netsnmp_send_traps(), netsnmp_stash_to_next_helper(), netsnmp_subtree_compare(), netsnmp_subtree_find(), netsnmp_subtree_find_next(), netsnmp_subtree_find_prev(), netsnmp_subtree_load(), netsnmp_subtree_split(), netsnmp_table_data_add_row(), netsnmp_table_data_get_from_oid(), netsnmp_table_data_helper_handler(), netsnmp_table_data_row_next_byoid(), netsnmp_tdata_compare_oid(), netsnmp_watched_spinlock_handler(), netsnmp_watched_timestamp_handler(), netsnmp_watcher_helper_handler(), snmp_oidsubtree_compare(), snmp_oidtree_compare(), and table_helper_handler().
+Definition at line 6301 of file snmp_api.c.
.SS "int snmp_oidtree_compare (const oid * in_name1, size_t len1, const oid * in_name2, size_t len2)"
.PP
-Compares 2 OIDs to determine if they are equal up until the shortest length.
-.PP
-\fBParameters:\fP
+Compares 2 OIDs to determine if they are equal up until the shortest length. \fBParameters:\fP
.RS 4
\fIin_name1\fP A pointer to the first oid.
.br
@@ -643,16 +595,10 @@
.PP
.PP
-Definition at line 6381 of file snmp_api.c.
-.PP
-References snmp_oid_compare().
-.PP
-Referenced by netsnmp_query_walk(), and netsnmp_tdata_compare_subtree_oid().
+Definition at line 6403 of file snmp_api.c.
.SS "void snmp_shutdown (const char * type)"
.PP
-Shuts down the application, saving any needed persistent storage, and appropriate clean up.
-.PP
-\fBParameters:\fP
+Shuts down the application, saving any needed persistent storage, and appropriate clean up. \fBParameters:\fP
.RS 4
\fItype\fP Label for the config file 'type' used
.RE
@@ -664,14 +610,10 @@
.PP
.PP
-Definition at line 834 of file snmp_api.c.
-.PP
-References clear_callback(), netsnmp_ds_shutdown(), NULL, shutdown_mib(), shutdown_snmp_logging(), snmp_alarm_unregister_all(), snmp_call_callbacks(), snmp_close_sessions(), snmp_store(), and unregister_all_config_handlers().
+Definition at line 853 of file snmp_api.c.
.SS "int snmpv3_engineID_probe (struct \fBsession_list\fP * slp, \fBnetsnmp_session\fP * in_session)"
.PP
-probe for peer engineID
-.PP
-\fBParameters:\fP
+probe for peer engineID \fBParameters:\fP
.RS 4
\fIslp\fP session list pointer.
.br
@@ -681,7 +623,7 @@
\fBNote:\fP
.RS 4
.IP "\(bu" 2
-called by _sess_open(), \fBsnmp_sess_add_ex()\fP
+called by _sess_open(), snmp_sess_add_ex()
.IP "\(bu" 2
in_session is the user supplied session provided to those functions.
.IP "\(bu" 2
@@ -698,8 +640,7 @@
.PP
.PP
-Definition at line 1254 of file snmp_api.c.
-.PP
-References create_user_from_session(), snmp_session::engineBoots, snmp_session::engineTime, snmp_session::flags, NULL, snmp_session::s_snmp_errno, snmp_session::securityEngineID, snmp_session::securityEngineIDLen, session_list::session, snmp_api_errstring(), snmp_errstring(), snmp_sess_synch_response(), TRUE, and snmp_session::version.
-.PP
-Referenced by snmp_sess_add_ex().
+Definition at line 1276 of file snmp_api.c.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_mib_maintenance.3 b/man/netsnmp_mib_maintenance.3
index b6318e3..54a15a8 100644
--- a/man/netsnmp_mib_maintenance.3
+++ b/man/netsnmp_mib_maintenance.3
@@ -1,10 +1,11 @@
-.TH "mib_maintenance" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "mib_maintenance" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-mib_maintenance \- Routines for maintaining a MIB table.
-
+mib_maintenance \-
.PP
+Routines for maintaining a MIB table.
+
.SS "Functions"
.in +1c
@@ -40,7 +41,6 @@
.SH "Detailed Description"
.PP
Routines for maintaining a MIB table.
-.PP
.SH "Function Documentation"
.PP
.SS "void netsnmp_generic_extract_row (\fBnetsnmp_request_info\fP * request)"
@@ -55,25 +55,19 @@
Definition at line 189 of file table_generic.c.
.SS "netsnmp_generic_free_handler (\fBnetsnmp_mib_handler\fP * handler)"
.PP
-Free a MIB handler structure, releasing any related resources.
-.PP
-Possibly called automatically by 'netsnmp_unregister_handler' ?
+Free a MIB handler structure, releasing any related resources. Possibly called automatically by 'netsnmp_unregister_handler' ?
.PP
Definition at line 165 of file table_generic.c.
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_generic_get_handler (void)"
.PP
-Create a MIB handler structure.
-.PP
-This will typically be invoked within the corresponding 'netsnmp_generic_register' routine (or the registration code of a sub-helper based on this helper).
+Create a MIB handler structure. This will typically be invoked within the corresponding 'netsnmp_generic_register' routine (or the registration code of a sub-helper based on this helper).
.PP
Alternatively, it might be called from the initialisation code of a particular MIB table implementation.
.PP
Definition at line 158 of file table_generic.c.
.SS "void netsnmp_generic_insert_row (\fBnetsnmp_request_info\fP * request, void * row)"
.PP
-Associate a (new) row with the requested varbind.
-.PP
-The row should also be associated with any other varbinds that refer to the same index values.
+Associate a (new) row with the requested varbind. The row should also be associated with any other varbinds that refer to the same index values.
.PP
Definition at line 203 of file table_generic.c.
.SS "int netsnmp_generic_register (\fBnetsnmp_handler_registration\fP * reginfo, void * table, \fBnetsnmp_table_registration_info\fP * table_info)"
@@ -83,8 +77,9 @@
Definition at line 172 of file table_generic.c.
.SS "int netsnmp_generic_unregister (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
-Unregister a MIB table from the SNMP agent.
-.PP
-This should also release the internal representation of the table. ?? Is a table-specific version of this needed, or would 'netsnmp_unregister_handler' + 'netsnmp_generic_free_handler' do?
+Unregister a MIB table from the SNMP agent. This should also release the internal representation of the table. ?? Is a table-specific version of this needed, or would 'netsnmp_unregister_handler' + 'netsnmp_generic_free_handler' do?
.PP
Definition at line 183 of file table_generic.c.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_mib_utilities.3 b/man/netsnmp_mib_utilities.3
index bd1ddc2..b1df171 100644
--- a/man/netsnmp_mib_utilities.3
+++ b/man/netsnmp_mib_utilities.3
@@ -1,4 +1,4 @@
-.TH "mib parsing and datatype manipulation routines." 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "mib parsing and datatype manipulation routines." 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -17,10 +17,10 @@
.in +1c
.ti -1c
-.RI "typedef \fB_PrefixList\fP * \fBPrefixListPtr\fP"
+.RI "typedef struct \fB_PrefixList\fP * \fBPrefixListPtr\fP"
.br
.ti -1c
-.RI "typedef \fB_PrefixList\fP \fBPrefixList\fP"
+.RI "typedef struct \fB_PrefixList\fP \fBPrefixList\fP"
.br
.in -1c
.SS "Enumerations"
@@ -63,7 +63,7 @@
.ti -1c
.RI "int \fBsprint_realloc_timeticks\fP (u_char **buf, size_t *buf_len, size_t *out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP *var, const struct \fBenum_list\fP *enums, const char *hint, const char *units)"
.br
-.RI "\fIPrints a timetick variable into a buffer. \fP"
+.RI "\fIPrints a timetick \fBvariable\fP into a buffer. \fP"
.ti -1c
.RI "int \fBsprint_realloc_hinted_integer\fP (u_char **buf, size_t *buf_len, size_t *out_len, int allow_realloc, long val, const char decimaltype, const char *hint, const char *units)"
.br
@@ -110,11 +110,11 @@
.ti -1c
.RI "int \fBsprint_realloc_by_type\fP (u_char **buf, size_t *buf_len, size_t *out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP *var, const struct \fBenum_list\fP *enums, const char *hint, const char *units)"
.br
-.RI "\fIUniversal print routine, prints a variable into a buffer according to the variable type. \fP"
+.RI "\fIUniversal print routine, prints a \fBvariable\fP into a buffer according to the \fBvariable\fP type. \fP"
.ti -1c
-.RI "\fBtree\fP * \fBget_tree_head\fP (void)"
+.RI "struct \fBtree\fP * \fBget_tree_head\fP (void)"
.br
-.RI "\fIRetrieves the tree head. \fP"
+.RI "\fIRetrieves the \fBtree\fP head. \fP"
.ti -1c
.RI "char * \fBsnmp_out_toggle_options\fP (char *options)"
.br
@@ -173,7 +173,7 @@
.RI "void \fBnetsnmp_sprint_realloc_objid\fP (u_char **buf, size_t *buf_len, size_t *out_len, int allow_realloc, int *buf_overflow, const oid *objid, size_t objidlen)"
.br
.ti -1c
-.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 "struct \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)"
.br
.ti -1c
.RI "int \fBsprint_realloc_objid\fP (u_char **buf, size_t *buf_len, size_t *out_len, int allow_realloc, const oid *objid, size_t objidlen)"
@@ -198,11 +198,11 @@
.ti -1c
.RI "void \fBprint_variable\fP (const oid *objid, size_t objidlen, const \fBnetsnmp_variable_list\fP *\fBvariable\fP)"
.br
-.RI "\fIPrints a variable to stdout. \fP"
+.RI "\fIPrints a \fBvariable\fP to stdout. \fP"
.ti -1c
.RI "void \fBfprint_variable\fP (FILE *f, const oid *objid, size_t objidlen, const \fBnetsnmp_variable_list\fP *\fBvariable\fP)"
.br
-.RI "\fIPrints a variable to a file descriptor. \fP"
+.RI "\fIPrints a \fBvariable\fP to a file descriptor. \fP"
.ti -1c
.RI "int \fBsprint_realloc_value\fP (u_char **buf, size_t *buf_len, size_t *out_len, int allow_realloc, const oid *objid, size_t objidlen, const \fBnetsnmp_variable_list\fP *\fBvariable\fP)"
.br
@@ -238,7 +238,7 @@
.RI "int \fBdump_realloc_oid_to_string\fP (const oid *objid, size_t objidlen, u_char **buf, size_t *buf_len, size_t *out_len, int allow_realloc, char quotechar)"
.br
.ti -1c
-.RI "\fBtree\fP * \fBget_tree\fP (const oid *objid, size_t objidlen, struct \fBtree\fP *subtree)"
+.RI "struct \fBtree\fP * \fBget_tree\fP (const oid *objid, size_t objidlen, struct \fBtree\fP *subtree)"
.br
.ti -1c
.RI "void \fBprint_description\fP (oid *objid, size_t objidlen, int width)"
@@ -260,12 +260,6 @@
.ti -1c
.RI "int \fBget_wild_node\fP (const char *name, oid *objid, size_t *objidlen)"
.br
-.RI "\fI\fBSee also:\fP
-.RS 4
-comments on find_best_tree_node for usage after first time.
-.RE
-.PP
-\fP"
.ti -1c
.RI "int \fBget_node\fP (const char *name, oid *objid, size_t *objidlen)"
.br
@@ -381,10 +375,10 @@
.in +1c
.ti -1c
-.RI "\fBtree\fP * \fBtree_head\fP"
+.RI "struct \fBtree\fP * \fBtree_head\fP"
.br
.ti -1c
-.RI "\fBtree\fP * \fBMib\fP"
+.RI "struct \fBtree\fP * \fBMib\fP"
.br
.ti -1c
.RI "oid \fBRFC1213_MIB\fP [] = { 1, 3, 6, 1, 2, 1 }"
@@ -397,9 +391,7 @@
.PP
.SS "int _sprint_hexstring_line (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const u_char * cp, size_t line_len)"
.PP
-Prints a hexadecimal string into a buffer.
-.PP
-The characters pointed by *cp are encoded as hexadecimal string.
+Prints a hexadecimal string into a buffer. The characters pointed by *cp are encoded as hexadecimal string.
.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.)
.PP
@@ -426,24 +418,16 @@
.PP
Definition at line 271 of file mib.c.
-.PP
-References netsnmp_ds_get_boolean(), and snmp_realloc().
-.PP
-Referenced by sprint_realloc_hexstring().
.SS "int build_oid (oid ** out, size_t * out_len, oid * prefix, size_t prefix_len, \fBnetsnmp_variable_list\fP * indexes)"
.PP
-Definition at line 3578 of file mib.c.
+xxx-rks: should free previous value?
.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().
+Definition at line 3581 of file mib.c.
.SS "int build_oid_segment (\fBnetsnmp_variable_list\fP * var)"
.PP
-Takes the value in VAR and turns it into an OID segment in var->name.
-.PP
-\fBParameters:\fP
+Takes the value in VAR and turns it into an OID segment in var->name. \fBParameters:\fP
.RS 4
-\fIvar\fP The variable.
+\fIvar\fP The \fBvariable\fP.
.RE
.PP
\fBReturns:\fP
@@ -453,16 +437,10 @@
.PP
.PP
-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().
+Definition at line 3445 of file mib.c.
.SS "void fprint_description (FILE * f, oid * objid, size_t objidlen, int width)"
.PP
-Prints on oid description into a file descriptor.
-.PP
-\fBParameters:\fP
+Prints on oid description into a file descriptor. \fBParameters:\fP
.RS 4
\fIf\fP The file descriptor to print to.
.br
@@ -475,16 +453,10 @@
.PP
.PP
-Definition at line 4437 of file mib.c.
-.PP
-References NULL, SNMP_FREE, and sprint_realloc_description().
-.PP
-Referenced by print_description().
+Definition at line 4451 of file mib.c.
.SS "void fprint_objid (FILE * f, const oid * objid, size_t objidlen)"
.PP
-Prints an oid to a file descriptor.
-.PP
-\fBParameters:\fP
+Prints an oid to a file descriptor. \fBParameters:\fP
.RS 4
\fIf\fP The file descriptor to print to.
.br
@@ -495,16 +467,10 @@
.PP
.PP
-Definition at line 3163 of file mib.c.
-.PP
-References netsnmp_sprint_realloc_objid_tree(), NULL, and SNMP_FREE.
-.PP
-Referenced by print_objid().
+Definition at line 3164 of file mib.c.
.SS "void fprint_variable (FILE * f, const oid * objid, size_t objidlen, const \fBnetsnmp_variable_list\fP * variable)"
.PP
-Prints a variable to a file descriptor.
-.PP
-\fBParameters:\fP
+Prints a \fBvariable\fP to a file descriptor. \fBParameters:\fP
.RS 4
\fIf\fP The file descriptor to print to.
.br
@@ -512,76 +478,50 @@
.br
\fIobjidlen\fP The length of teh object id.
.br
-\fIvariable\fP The variable to print.
+\fI\fBvariable\fP\fP The \fBvariable\fP to print.
.RE
.PP
.PP
-Definition at line 3317 of file mib.c.
+Definition at line 3318 of file mib.c.
+.SS "struct \fBtree\fP* get_tree_head (void)\fC [read]\fP"
.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
+Retrieves the \fBtree\fP head. \fBReturns:\fP
.RS 4
-the tree head.
+the \fBtree\fP head.
.RE
.PP
.PP
Definition at line 2017 of file mib.c.
-.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
+.SS "int get_wild_node (const char * name, oid * objid, size_t * objidlen)"\fBSee also:\fP
.RS 4
comments on find_best_tree_node for usage after first time.
.RE
.PP
.PP
-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 5490 of file mib.c.
.SS "void netsnmp_fixup_mib_directory (void)"
.PP
-Definition at line 2479 of file mib.c.
+swap in the new value and repeat
.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 2480 of file mib.c.
.SS "char* netsnmp_get_mib_directory (void)"
.PP
-Definition at line 2432 of file mib.c.
+Check if the environment \fBvariable\fP is set
.PP
-References netsnmp_ds_get_string(), netsnmp_getenv(), netsnmp_set_mib_directory(), and NULL.
+Not set use hard coded path
.PP
-Referenced by netsnmp_fixup_mib_directory(), and netsnmp_init_mib().
+Definition at line 2433 of file mib.c.
.SS "void netsnmp_init_mib (void)"
.PP
-Initialises the mib reader.
+Initialises the mib reader. Reads in all settings from the environment.
.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().
+Definition at line 2527 of file mib.c.
.SS "int netsnmp_oid2chars (char * C, int L, const oid * O)"
.PP
-Converts an OID to its character form.
-.PP
-in example 5 . 1 . 2 . 3 . 4 . 5 = 12345
+Converts an OID to its character form. in example 5 . 1 . 2 . 3 . 4 . 5 = 12345
.PP
\fBParameters:\fP
.RS 4
@@ -601,14 +541,10 @@
.PP
length
.PP
-Definition at line 6244 of file mib.c.
-.PP
-Referenced by netsnmp_oid2str().
+Definition at line 6277 of file mib.c.
.SS "int netsnmp_oid2str (char * S, int L, oid * O)"
.PP
-Converts an OID to its string form.
-.PP
-in example 5 . 'h' . 'e' . 'l' . 'l' . 'o' = 'hello\\0' (null terminated)
+Converts an OID to its string form. in example 5 . 'h' . 'e' . 'l' . 'l' . 'o' = 'hello\\0' (null terminated)
.PP
\fBParameters:\fP
.RS 4
@@ -626,21 +562,19 @@
.PP
.PP
-Definition at line 6272 of file mib.c.
-.PP
-References netsnmp_oid2chars().
+Definition at line 6305 of file mib.c.
.SS "void netsnmp_set_mib_directory (const char * dir)"
.PP
-Definition at line 2377 of file mib.c.
+New dir starts with '+', thus we add it.
.PP
-References netsnmp_ds_get_string(), netsnmp_ds_set_string(), NULL, and SNMP_FREE.
+If dir starts with '+' skip '+' it.
.PP
-Referenced by netsnmp_fixup_mib_directory(), and netsnmp_get_mib_directory().
+set_string calls strdup, so if we allocated memory, free it
+.PP
+Definition at line 2378 of file mib.c.
.SS "int netsnmp_str2oid (const char * S, oid * O, int L)"
.PP
-Converts a string to its OID form.
-.PP
-in example 'hello' = 5 . 'h' . 'e' . 'l' . 'l' . 'o'
+Converts a string to its OID form. in example 'hello' = 5 . 'h' . 'e' . 'l' . 'l' . 'o'
.PP
\fBParameters:\fP
.RS 4
@@ -658,40 +592,30 @@
.PP
.PP
-Definition at line 6209 of file mib.c.
+Definition at line 6242 of file mib.c.
.SS "void print_description (oid * objid, size_t objidlen, int width)"
.PP
-Prints on oid description on stdout.
-.PP
-\fBSee also:\fP
+Prints on oid description on stdout. \fBSee also:\fP
.RS 4
\fBfprint_description\fP
.RE
.PP
.PP
-Definition at line 4421 of file mib.c.
-.PP
-References fprint_description().
+Definition at line 4435 of file mib.c.
.SS "void print_mib (FILE * fp)"
.PP
-Prints the MIBs to the file fp.
-.PP
-\fBParameters:\fP
+Prints the MIBs to the file fp. \fBParameters:\fP
.RS 4
\fIfp\fP The file descriptor to print to.
.RE
.PP
.PP
-Definition at line 2741 of file mib.c.
-.PP
-References tree_head.
+Definition at line 2742 of file mib.c.
.SS "void print_objid (const oid * objid, size_t objidlen)"
.PP
-Prints an oid to stdout.
-.PP
-\fBParameters:\fP
+Prints an oid to stdout. \fBParameters:\fP
.RS 4
\fIobjid\fP The oid to print
.br
@@ -700,32 +624,24 @@
.PP
.PP
-Definition at line 3149 of file mib.c.
-.PP
-References fprint_objid().
+Definition at line 3150 of file mib.c.
.SS "void print_variable (const oid * objid, size_t objidlen, const \fBnetsnmp_variable_list\fP * variable)"
.PP
-Prints a variable to stdout.
-.PP
-\fBParameters:\fP
+Prints a \fBvariable\fP to stdout. \fBParameters:\fP
.RS 4
\fIobjid\fP The object id.
.br
\fIobjidlen\fP The length of teh object id.
.br
-\fIvariable\fP The variable to print.
+\fI\fBvariable\fP\fP The \fBvariable\fP to print.
.RE
.PP
.PP
-Definition at line 3301 of file mib.c.
-.PP
-References fprint_variable().
+Definition at line 3302 of file mib.c.
.SS "int read_objid (const char * input, oid * output, size_t * out_len)"
.PP
-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.
+Reads an object identifier from an input string into internal OID form. When called, out_len must hold the maximum length of the output array.
.PP
\fBParameters:\fP
.RS 4
@@ -743,39 +659,25 @@
.PP
If an error occurs, this function returns 0 and MAY set snmp_errno. snmp_errno is NOT set if SET_SNMP_ERROR evaluates to nothing. This can make multi-threaded use a tiny bit more robust.
.PP
-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().
+Definition at line 2840 of file mib.c.
.SS "void set_function (struct \fBtree\fP * subtree)"
.PP
-Set's the printing function printomat in a subtree according it's type.
-.PP
-\fBParameters:\fP
+Set's the printing function printomat in a subtree according it's type. \fBParameters:\fP
.RS 4
\fIsubtree\fP The subtree to set.
.RE
.PP
.PP
-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 2763 of file mib.c.
.SS "void shutdown_mib (void)"
.PP
Unloads all mibs.
.PP
-Definition at line 2716 of file mib.c.
-.PP
-References tree::label, Mib, NULL, SNMP_FREE, and tree_head.
-.PP
-Referenced by snmp_shutdown().
+Definition at line 2717 of file mib.c.
.SS "void snmp_in_toggle_options_usage (const char * lead, FILE * outf)"
.PP
-Prints out a help usage for the in* toggle options.
-.PP
-\fBParameters:\fP
+Prints out a help usage for the in* toggle options. \fBParameters:\fP
.RS 4
\fIlead\fP The lead to print for every line.
.br
@@ -784,12 +686,10 @@
.PP
.PP
-Definition at line 2289 of file mib.c.
+Definition at line 2290 of file mib.c.
.SS "oid* snmp_parse_oid (const char * argv, oid * root, size_t * rootlen)"
.PP
-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.
+Given a string, parses an oid out of it (if possible). 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.
.PP
\fBParameters:\fP
.RS 4
@@ -807,16 +707,10 @@
.PP
.PP
-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().
+Definition at line 5848 of file mib.c.
.SS "int sprint_realloc_asciistring (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const u_char * cp, size_t len)"
.PP
-Prints an ascii string into a buffer.
-.PP
-The characters pointed by *cp are encoded as an ascii string.
+Prints an ascii string into a buffer. The characters pointed by *cp are encoded as an ascii string.
.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.)
.PP
@@ -843,15 +737,9 @@
.PP
Definition at line 367 of file mib.c.
-.PP
-References snmp_realloc().
-.PP
-Referenced by asn_build_string(), asn_parse_string(), snprint_asciistring(), and sprint_realloc_octet_string().
.SS "int sprint_realloc_badtype (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP * var, const struct \fBenum_list\fP * enums, const char * hint, const char * units)"
.PP
-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.)
+Fallback routine for a bad type, prints 'Variable has bad type' into a buffer. If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)
.PP
\fBParameters:\fP
.RS 4
@@ -863,9 +751,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIvar\fP The variable to encode.
+\fIvar\fP The \fBvariable\fP to encode.
.br
-\fIenums\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIenums\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may be NULL.
.br
@@ -880,15 +768,9 @@
.PP
Definition at line 1902 of file mib.c.
-.PP
-References snmp_strcat().
-.PP
-Referenced by snprint_badtype(), and sprint_realloc_by_type().
.SS "int sprint_realloc_bitstring (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP * var, const struct \fBenum_list\fP * enums, const char * hint, const char * units)"
.PP
-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.)
+Prints a bit string into a buffer. If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)
.PP
\fBParameters:\fP
.RS 4
@@ -900,9 +782,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIvar\fP The variable to encode.
+\fIvar\fP The \fBvariable\fP to encode.
.br
-\fIenums\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIenums\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may be NULL.
.br
@@ -917,15 +799,9 @@
.PP
Definition at line 1763 of file mib.c.
-.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().
.SS "int sprint_realloc_by_type (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP * var, const struct \fBenum_list\fP * enums, const char * hint, const char * units)"
.PP
-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.)
+Universal print routine, prints a \fBvariable\fP into a buffer according to the \fBvariable\fP type. If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)
.PP
\fBParameters:\fP
.RS 4
@@ -937,9 +813,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIvar\fP The variable to encode.
+\fIvar\fP The \fBvariable\fP to encode.
.br
-\fIenums\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIenums\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may be NULL.
.br
@@ -954,15 +830,9 @@
.PP
Definition at line 1937 of file mib.c.
-.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().
.SS "int sprint_realloc_counter (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP * var, const struct \fBenum_list\fP * enums, const char * hint, const char * units)"
.PP
-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.)
+Prints a counter value into a buffer. If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)
.PP
\fBParameters:\fP
.RS 4
@@ -974,9 +844,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIvar\fP The variable to encode.
+\fIvar\fP The \fBvariable\fP to encode.
.br
-\fIenums\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIenums\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may be NULL.
.br
@@ -991,15 +861,9 @@
.PP
Definition at line 1530 of file mib.c.
-.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().
.SS "int sprint_realloc_counter64 (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP * var, const struct \fBenum_list\fP * enums, const char * hint, const char * units)"
.PP
-Prints a counter into a buffer.
-.PP
-The variable var is encoded as a counter value.
+Prints a counter into a buffer. The \fBvariable\fP var is encoded as a counter value.
.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.)
.PP
@@ -1013,9 +877,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIvar\fP The variable to encode.
+\fIvar\fP The \fBvariable\fP to encode.
.br
-\fIenums\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIenums\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may be NULL.
.br
@@ -1030,15 +894,9 @@
.PP
Definition at line 846 of file mib.c.
-.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().
.SS "int sprint_realloc_gauge (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP * var, const struct \fBenum_list\fP * enums, const char * hint, const char * units)"
.PP
-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.)
+Prints a gauge value into a buffer. If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)
.PP
\fBParameters:\fP
.RS 4
@@ -1050,9 +908,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIvar\fP The variable to encode.
+\fIvar\fP The \fBvariable\fP to encode.
.br
-\fIenums\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIenums\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may be NULL.
.br
@@ -1067,15 +925,9 @@
.PP
Definition at line 1457 of file mib.c.
-.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().
.SS "int sprint_realloc_hinted_integer (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, long val, const char decimaltype, const char * hint, const char * units)"
.PP
-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.)
+Prints an integer according to the hint into a buffer. If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)
.PP
\fBParameters:\fP
.RS 4
@@ -1087,9 +939,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIval\fP The variable to encode.
+\fIval\fP The \fBvariable\fP to encode.
.br
-\fIdecimaltype\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIdecimaltype\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may _NOT_ be NULL.
.br
@@ -1104,15 +956,9 @@
.PP
Definition at line 1183 of file mib.c.
-.PP
-References snmp_strcat().
-.PP
-Referenced by snprint_hinted_integer(), and sprint_realloc_gauge().
.SS "int sprint_realloc_integer (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP * var, const struct \fBenum_list\fP * enums, const char * hint, const char * units)"
.PP
-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.)
+Prints an integer into a buffer. If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)
.PP
\fBParameters:\fP
.RS 4
@@ -1124,9 +970,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIvar\fP The variable to encode.
+\fIvar\fP The \fBvariable\fP to encode.
.br
-\fIenums\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIenums\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may be NULL.
.br
@@ -1141,15 +987,9 @@
.PP
Definition at line 1257 of file mib.c.
-.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().
.SS "int sprint_realloc_ipaddress (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP * var, const struct \fBenum_list\fP * enums, const char * hint, const char * units)"
.PP
-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.)
+Prints an ip-address into a buffer. If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)
.PP
\fBParameters:\fP
.RS 4
@@ -1161,9 +1001,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIvar\fP The variable to encode.
+\fIvar\fP The \fBvariable\fP to encode.
.br
-\fIenums\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIenums\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may be NULL.
.br
@@ -1178,15 +1018,9 @@
.PP
Definition at line 1659 of file mib.c.
-.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().
.SS "int sprint_realloc_networkaddress (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP * var, const struct \fBenum_list\fP * enums, const char * hint, const char * units)"
.PP
-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.)
+Prints a network address into a buffer. If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)
.PP
\fBParameters:\fP
.RS 4
@@ -1198,9 +1032,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIvar\fP The variable to encode.
+\fIvar\fP The \fBvariable\fP to encode.
.br
-\fIenums\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIenums\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may be NULL.
.br
@@ -1215,15 +1049,9 @@
.PP
Definition at line 1593 of file mib.c.
-.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().
.SS "int sprint_realloc_null (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP * var, const struct \fBenum_list\fP * enums, const char * hint, const char * units)"
.PP
-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.)
+Prints a null value into a buffer. If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)
.PP
\fBParameters:\fP
.RS 4
@@ -1235,9 +1063,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIvar\fP The variable to encode.
+\fIvar\fP The \fBvariable\fP to encode.
.br
-\fIenums\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIenums\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may be NULL.
.br
@@ -1252,15 +1080,9 @@
.PP
Definition at line 1719 of file mib.c.
-.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().
.SS "int sprint_realloc_object_identifier (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP * var, const struct \fBenum_list\fP * enums, const char * hint, const char * units)"
.PP
-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.)
+Prints an object identifier into a buffer. If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)
.PP
\fBParameters:\fP
.RS 4
@@ -1272,9 +1094,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIvar\fP The variable to encode.
+\fIvar\fP The \fBvariable\fP to encode.
.br
-\fIenums\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIenums\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may be NULL.
.br
@@ -1289,15 +1111,9 @@
.PP
Definition at line 1039 of file mib.c.
-.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().
.SS "int sprint_realloc_octet_string (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP * var, const struct \fBenum_list\fP * enums, const char * hint, const char * units)"
.PP
-Prints an octet string into a buffer.
-.PP
-The variable var is encoded as octet string.
+Prints an octet string into a buffer. The \fBvariable\fP var is encoded as octet string.
.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.)
.PP
@@ -1311,9 +1127,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIvar\fP The variable to encode.
+\fIvar\fP The \fBvariable\fP to encode.
.br
-\fIenums\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIenums\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may be NULL.
.br
@@ -1328,15 +1144,9 @@
.PP
Definition at line 427 of file mib.c.
-.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().
.SS "int sprint_realloc_opaque (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP * var, const struct \fBenum_list\fP * enums, const char * hint, const char * units)"
.PP
-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.)
+Prints an object identifier into a buffer. If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)
.PP
\fBParameters:\fP
.RS 4
@@ -1348,9 +1158,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIvar\fP The variable to encode.
+\fIvar\fP The \fBvariable\fP to encode.
.br
-\fIenums\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIenums\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may be NULL.
.br
@@ -1365,15 +1175,9 @@
.PP
Definition at line 949 of file mib.c.
-.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().
.SS "int sprint_realloc_timeticks (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP * var, const struct \fBenum_list\fP * enums, const char * hint, const char * units)"
.PP
-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.)
+Prints a timetick \fBvariable\fP into a buffer. If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)
.PP
\fBParameters:\fP
.RS 4
@@ -1385,9 +1189,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIvar\fP The variable to encode.
+\fIvar\fP The \fBvariable\fP to encode.
.br
-\fIenums\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIenums\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may be NULL.
.br
@@ -1402,15 +1206,9 @@
.PP
Definition at line 1109 of file mib.c.
-.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().
.SS "int sprint_realloc_uinteger (u_char ** buf, size_t * buf_len, size_t * out_len, int allow_realloc, const \fBnetsnmp_variable_list\fP * var, const struct \fBenum_list\fP * enums, const char * hint, const char * units)"
.PP
-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.)
+Prints an unsigned integer into a buffer. If allow_realloc is true the buffer will be (re)allocated to fit in the needed size. (Note: *buf may change due to this.)
.PP
\fBParameters:\fP
.RS 4
@@ -1422,9 +1220,9 @@
.br
\fIallow_realloc\fP if not zero reallocate the buffer to fit the needed size.
.br
-\fIvar\fP The variable to encode.
+\fIvar\fP The \fBvariable\fP to encode.
.br
-\fIenums\fP The enumeration ff this variable is enumerated. may be NULL.
+\fIenums\fP The enumeration ff this \fBvariable\fP is enumerated. may be NULL.
.br
\fIhint\fP Contents of the DISPLAY-HINT clause of the MIB. See RFC 1903 Section 3.1 for details. may be NULL.
.br
@@ -1439,15 +1237,9 @@
.PP
Definition at line 1360 of file mib.c.
-.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().
.SS "char* uptime_string (u_long timeticks, char * buf)"
.PP
-Converts timeticks to hours, minutes, seconds string.
-.PP
-CMU compatible does not show centiseconds.
+Converts timeticks to hours, minutes, seconds string. CMU compatible does not show centiseconds.
.PP
\fBParameters:\fP
.RS 4
@@ -1468,14 +1260,10 @@
.PP
.PP
-Definition at line 5780 of file mib.c.
-.PP
-References uptime_string_n().
+Definition at line 5813 of file mib.c.
.SH "Variable Documentation"
.PP
-.SS "\fBPrefixList\fP \fBmib_prefixes\fP[]"
-.PP
-\fBInitial value:\fP
+.SS "\fBPrefixList\fP mib_prefixes[]"\fBInitial value:\fP
.PP
.nf
{
@@ -1490,5 +1278,6 @@
.fi
.PP
Definition at line 160 of file mib.c.
-.PP
-Referenced by netsnmp_init_mib(), and netsnmp_sprint_realloc_objid_tree().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_mode_end_call.3 b/man/netsnmp_mode_end_call.3
index ebfd017..d1c6697 100644
--- a/man/netsnmp_mode_end_call.3
+++ b/man/netsnmp_mode_end_call.3
@@ -1,10 +1,11 @@
-.TH "mode_end_call" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "mode_end_call" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-mode_end_call \- At the end of a series of requests, call another handler hook.
-
+mode_end_call \-
.PP
+At the end of a series of requests, call another handler hook.
+
.SS "Functions"
.in +1c
@@ -23,7 +24,7 @@
.SH "Detailed Description"
.PP
At the end of a series of requests, call another handler hook.
-.PP
+
Handlers that want to loop through a series of requests and then receive a callback at the end of a particular MODE can use this helper to make this possible. For most modules, this is not needed as the handler itself could perform a for() loop around the request list and then perform its actions afterwards. However, if something like the serialize helper is in use this isn't possible because not all the requests for a given handler are being passed downward in a single group. Thus, this helper *must* be added above other helpers like the serialize helper to be useful.
.PP
Multiple mode specific handlers can be registered and will be called in the order they were regestered in. Callbacks regesterd with a mode of NETSNMP_MODE_END_ALL_MODES will be called for all modes.
@@ -31,9 +32,7 @@
.PP
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_mode_end_call_handler (\fBnetsnmp_mode_handler_list\fP * endlist)"
.PP
-returns a mode_end_call handler that can be injected into a given handler chain.
-.PP
-\fBParameters:\fP
+returns a mode_end_call handler that can be injected into a given handler chain. \fBParameters:\fP
.RS 4
\fIendlist\fP The callback list for the handler to make use of.
.RE
@@ -46,13 +45,9 @@
.PP
Definition at line 45 of file mode_end_call.c.
-.PP
-References netsnmp_mib_handler_s::myvoid, netsnmp_create_handler(), netsnmp_mode_end_call_helper(), and NULL.
.SS "\fBnetsnmp_mode_handler_list\fP* netsnmp_mode_end_call_add_mode_callback (\fBnetsnmp_mode_handler_list\fP * endlist, int mode, \fBnetsnmp_mib_handler\fP * callbackh)"
.PP
-adds a mode specific callback to the callback list.
-.PP
-\fBParameters:\fP
+adds a mode specific callback to the callback list. \fBParameters:\fP
.RS 4
\fIendlist\fP the information structure for the mode_end_call helper. Can be NULL to create a new list.
.br
@@ -69,5 +64,6 @@
.PP
Definition at line 65 of file mode_end_call.c.
-.PP
-References netsnmp_mode_handler_list_s::callback_handler, netsnmp_mode_handler_list_s::mode, netsnmp_mode_handler_list_s::next, NULL, and SNMP_MALLOC_TYPEDEF.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_multiplexer.3 b/man/netsnmp_multiplexer.3
index 9c19db5..8f6f01a 100644
--- a/man/netsnmp_multiplexer.3
+++ b/man/netsnmp_multiplexer.3
@@ -1,10 +1,11 @@
-.TH "multiplexer" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "multiplexer" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-multiplexer \- Splits mode requests into calls to different handlers.
-
+multiplexer \-
.PP
+Splits mode requests into calls to different handlers.
+
.SS "Functions"
.in +1c
@@ -20,7 +21,7 @@
.SH "Detailed Description"
.PP
Splits mode requests into calls to different handlers.
-.PP
+
The multiplexer helper lets you split the calling chain depending on the calling mode (get vs getnext vs set). Useful if you want different routines to handle different aspects of SNMP requests, which is very common for GET vs SET type actions.
.PP
Functionally:
@@ -42,14 +43,11 @@
returns a multiplixer handler given a \fBnetsnmp_mib_handler_methods\fP structure of subhandlers.
.PP
Definition at line 33 of file multiplexer.c.
-.PP
-References netsnmp_mib_handler_s::myvoid, netsnmp_create_handler(), netsnmp_multiplexer_helper_handler(), NULL, and snmp_log().
.SS "int netsnmp_multiplexer_helper_handler (\fBnetsnmp_mib_handler\fP * handler, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests)"
.PP
implements the multiplexer helper
.PP
Definition at line 54 of file multiplexer.c.
-.PP
-References netsnmp_agent_request_info_s::mode, netsnmp_mib_handler_s::myvoid, netsnmp_call_handler(), netsnmp_request_set_error_all(), and snmp_log().
-.PP
-Referenced by netsnmp_get_multiplexer_handler().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_netsnmp_agent_request_info_s.3 b/man/netsnmp_netsnmp_agent_request_info_s.3
index 60ce141..67833e8 100644
--- a/man/netsnmp_netsnmp_agent_request_info_s.3
+++ b/man/netsnmp_netsnmp_agent_request_info_s.3
@@ -1,15 +1,16 @@
-.TH "netsnmp_agent_request_info_s" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "netsnmp_agent_request_info_s" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-netsnmp_agent_request_info_s \- The agent transaction request structure.
-
+netsnmp_agent_request_info_s \-
.PP
+The agent transaction request structure.
+
.SH SYNOPSIS
.br
.PP
-\fC#include <snmp_agent.h>\fP
.PP
+\fC#include <snmp_agent.h>\fP
.SS "Data Fields"
.in +1c
@@ -17,7 +18,7 @@
.RI "int \fBmode\fP"
.br
.ti -1c
-.RI "\fBnetsnmp_agent_session_s\fP * \fBasp\fP"
+.RI "struct \fBnetsnmp_agent_session_s\fP * \fBasp\fP"
.br
.RI "\fIpdu contains authinfo, eg \fP"
.ti -1c
@@ -36,13 +37,11 @@
Definition at line 158 of file snmp_agent.h.
.SH "Field Documentation"
.PP
-.SS "struct \fBnetsnmp_agent_session_s\fP* \fBnetsnmp_agent_request_info_s::asp\fP"
+.SS "struct \fBnetsnmp_agent_session_s\fP* \fBnetsnmp_agent_request_info_s::asp\fP\fC [read]\fP"
.PP
pdu contains authinfo, eg
.PP
Definition at line 162 of file snmp_agent.h.
-.PP
-Referenced by get_set_cache(), handle_var_requests(), and netsnmp_create_delegated_cache().
.SH "Author"
.PP
diff --git a/man/netsnmp_netsnmp_column_info_t.3 b/man/netsnmp_netsnmp_column_info_t.3
index ab0b7a8..d04386e 100644
--- a/man/netsnmp_netsnmp_column_info_t.3
+++ b/man/netsnmp_netsnmp_column_info_t.3
@@ -1,15 +1,16 @@
-.TH "netsnmp_column_info_t" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "netsnmp_column_info_t" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-netsnmp_column_info_t \- column info struct.
-
+netsnmp_column_info_t \-
.PP
+column info struct.
+
.SH SYNOPSIS
.br
.PP
-\fC#include <table.h>\fP
.PP
+\fC#include <table.h>\fP
.SS "Data Fields"
.in +1c
@@ -33,7 +34,7 @@
.RI "} \fBdetails\fP"
.br
.ti -1c
-.RI "\fBnetsnmp_column_info_t\fP * \fBnext\fP"
+.RI "struct \fBnetsnmp_column_info_t\fP * \fBnext\fP"
.br
.in -1c
.SH "Detailed Description"
diff --git a/man/netsnmp_netsnmp_data_list_s.3 b/man/netsnmp_netsnmp_data_list_s.3
index 03476c0..39f924a 100644
--- a/man/netsnmp_netsnmp_data_list_s.3
+++ b/man/netsnmp_netsnmp_data_list_s.3
@@ -1,20 +1,21 @@
-.TH "netsnmp_data_list_s" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "netsnmp_data_list_s" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-netsnmp_data_list_s \- used to iterate through lists of data
-
+netsnmp_data_list_s \-
.PP
+used to iterate through lists of data
+
.SH SYNOPSIS
.br
.PP
-\fC#include <data_list.h>\fP
.PP
+\fC#include <data_list.h>\fP
.SS "Data Fields"
.in +1c
.ti -1c
-.RI "\fBnetsnmp_data_list_s\fP * \fBnext\fP"
+.RI "struct \fBnetsnmp_data_list_s\fP * \fBnext\fP"
.br
.ti -1c
.RI "char * \fBname\fP"
@@ -40,15 +41,11 @@
The pointer to the data passed on.
.PP
Definition at line 45 of file data_list.h.
-.PP
-Referenced by netsnmp_create_data_list(), netsnmp_free_list_data(), and netsnmp_save_all_data().
.SS "Netsnmp_Free_List_Data* \fBnetsnmp_data_list_s::free_func\fP"
.PP
must know how to free netsnmp_data_list->data
.PP
Definition at line 47 of file data_list.h.
-.PP
-Referenced by netsnmp_create_data_list(), and netsnmp_free_list_data().
.SH "Author"
.PP
diff --git a/man/netsnmp_netsnmp_handler_registration_s.3 b/man/netsnmp_netsnmp_handler_registration_s.3
index 77a80a1..d298b44 100644
--- a/man/netsnmp_netsnmp_handler_registration_s.3
+++ b/man/netsnmp_netsnmp_handler_registration_s.3
@@ -1,15 +1,16 @@
-.TH "netsnmp_handler_registration_s" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "netsnmp_handler_registration_s" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-netsnmp_handler_registration_s \- Root registration info.
-
+netsnmp_handler_registration_s \-
.PP
+Root registration info.
+
.SH SYNOPSIS
.br
.PP
-\fC#include <agent_handler.h>\fP
.PP
+\fC#include <agent_handler.h>\fP
.SS "Data Fields"
.in +1c
@@ -67,49 +68,39 @@
.PP
\fBdelayed_instance.c\fP, and \fBwatched.c\fP.
.PP
-Definition at line 94 of file agent_handler.h.
+Definition at line 95 of file agent_handler.h.
.SH "Field Documentation"
.PP
-.SS "char* \fBnetsnmp_handler_registration_s::handlerName\fP"
-.PP
-for mrTable listings, and other uses
-.PP
-Definition at line 97 of file agent_handler.h.
-.PP
-Referenced by netsnmp_cache_helper_handler(), netsnmp_container_table_register(), netsnmp_debug_helper(), netsnmp_handler_registration_create(), netsnmp_handler_registration_dup(), netsnmp_handler_registration_free(), netsnmp_inject_handler_into_subtree(), netsnmp_register_handler(), netsnmp_register_mib_table_row(), netsnmp_register_old_api(), netsnmp_stash_cache_helper(), netsnmp_table_array_register(), and netsnmp_table_row_register().
.SS "char* \fBnetsnmp_handler_registration_s::contextName\fP"
.PP
NULL = default context.
.PP
-Definition at line 99 of file agent_handler.h.
-.PP
-Referenced by netsnmp_debug_helper(), netsnmp_handler_registration_dup(), netsnmp_handler_registration_free(), netsnmp_register_handler(), netsnmp_register_handler_nocallback(), netsnmp_register_mib(), netsnmp_register_mib_table_row(), netsnmp_register_old_api(), netsnmp_unregister_handler(), and unregister_mibs_by_session().
-.SS "oid* \fBnetsnmp_handler_registration_s::rootoid\fP"
-.PP
-where are we registered at?
-.PP
-Definition at line 104 of file agent_handler.h.
-.PP
-Referenced by netsnmp_cache_helper_handler(), netsnmp_debug_helper(), netsnmp_handler_registration_create(), netsnmp_handler_registration_dup(), netsnmp_handler_registration_free(), netsnmp_instance_helper_handler(), netsnmp_old_api_helper(), netsnmp_register_cache_handler(), netsnmp_register_handler(), netsnmp_register_handler_nocallback(), netsnmp_register_mib(), netsnmp_register_mib_table_row(), netsnmp_register_old_api(), netsnmp_register_read_only_scalar(), netsnmp_register_scalar(), netsnmp_row_merge_helper_handler(), netsnmp_scalar_group_helper_handler(), netsnmp_scalar_helper_handler(), netsnmp_stash_to_next_helper(), netsnmp_table_build_oid(), netsnmp_table_build_oid_from_index(), netsnmp_table_data_build_result(), netsnmp_table_data_helper_handler(), netsnmp_table_iterator_helper_handler(), netsnmp_table_row_register(), netsnmp_unregister_handler(), netsnmp_watched_spinlock_handler(), netsnmp_watched_timestamp_handler(), netsnmp_watcher_helper_handler(), and table_helper_handler().
+Definition at line 100 of file agent_handler.h.
.SS "\fBnetsnmp_mib_handler\fP* \fBnetsnmp_handler_registration_s::handler\fP"
.PP
handler details
.PP
-Definition at line 110 of file agent_handler.h.
+Definition at line 111 of file agent_handler.h.
+.SS "char* \fBnetsnmp_handler_registration_s::handlerName\fP"
.PP
-Referenced by netsnmp_call_handlers(), netsnmp_container_table_register(), netsnmp_debug_helper(), netsnmp_find_handler_by_name(), netsnmp_find_table_array_handler(), netsnmp_handler_registration_create(), netsnmp_handler_registration_dup(), netsnmp_handler_registration_free(), netsnmp_inject_handler_before(), netsnmp_register_handler(), netsnmp_register_handler_nocallback(), netsnmp_register_mib_table_row(), netsnmp_register_old_api(), netsnmp_table_container_register(), netsnmp_table_row_register(), and unregister_mibs_by_session().
-.SS "int \fBnetsnmp_handler_registration_s::priority\fP"
+for mrTable listings, and other uses
.PP
-more optional stuff
-.PP
-Definition at line 116 of file agent_handler.h.
-.PP
-Referenced by netsnmp_debug_helper(), netsnmp_handler_registration_create(), netsnmp_handler_registration_dup(), netsnmp_register_handler(), netsnmp_register_handler_nocallback(), netsnmp_register_mib_table_row(), netsnmp_register_old_api(), and netsnmp_unregister_handler().
+Definition at line 98 of file agent_handler.h.
.SS "void* \fBnetsnmp_handler_registration_s::my_reg_void\fP"
.PP
void ptr for registeree
.PP
-Definition at line 125 of file agent_handler.h.
+Definition at line 126 of file agent_handler.h.
+.SS "int \fBnetsnmp_handler_registration_s::priority\fP"
+.PP
+more optional stuff
+.PP
+Definition at line 117 of file agent_handler.h.
+.SS "oid* \fBnetsnmp_handler_registration_s::rootoid\fP"
+.PP
+where are we registered at?
+.PP
+Definition at line 105 of file agent_handler.h.
.SH "Author"
.PP
diff --git a/man/netsnmp_netsnmp_iterator_info_s.3 b/man/netsnmp_netsnmp_iterator_info_s.3
index 27ca9b4..3f7bad8 100644
--- a/man/netsnmp_netsnmp_iterator_info_s.3
+++ b/man/netsnmp_netsnmp_iterator_info_s.3
@@ -1,40 +1,41 @@
-.TH "netsnmp_iterator_info_s" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "netsnmp_iterator_info_s" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-netsnmp_iterator_info_s \- Holds iterator information containing functions which should be called by the iterator_handler to loop over your data set and sort it in a SNMP specific manner.
-
+netsnmp_iterator_info_s \-
.PP
+Holds iterator information containing functions which should be called by the iterator_handler to loop over your data set and sort it in a SNMP specific manner.
+
.SH SYNOPSIS
.br
.PP
-\fC#include <table_iterator.h>\fP
.PP
+\fC#include <table_iterator.h>\fP
.SS "Data Fields"
.in +1c
.ti -1c
-.RI "\fBNetsnmp_First_Data_Point\fP * \fBget_first_data_point\fP"
+.RI "Netsnmp_First_Data_Point * \fBget_first_data_point\fP"
.br
.RI "\fIResponsible for: returning the first set of 'index' data, a loop-context pointer, and optionally a data context pointer. \fP"
.ti -1c
-.RI "\fBNetsnmp_Next_Data_Point\fP * \fBget_next_data_point\fP"
+.RI "Netsnmp_Next_Data_Point * \fBget_next_data_point\fP"
.br
.RI "\fIGiven the previous loop context, this should return the next loop context, associated index set and optionally a data context. \fP"
.ti -1c
-.RI "\fBNetsnmp_Make_Data_Context\fP * \fBmake_data_context\fP"
+.RI "Netsnmp_Make_Data_Context * \fBmake_data_context\fP"
.br
.RI "\fIIf a data context wasn't supplied by the get_first_data_point or get_next_data_point functions and the make_data_context pointer is defined, it will be called to convert a loop context into a data context. \fP"
.ti -1c
-.RI "\fBNetsnmp_Free_Loop_Context\fP * \fBfree_loop_context\fP"
+.RI "Netsnmp_Free_Loop_Context * \fBfree_loop_context\fP"
.br
.RI "\fIA function which should free the loop context. \fP"
.ti -1c
-.RI "\fBNetsnmp_Free_Data_Context\fP * \fBfree_data_context\fP"
+.RI "Netsnmp_Free_Data_Context * \fBfree_data_context\fP"
.br
.RI "\fIFrees a data context. \fP"
.ti -1c
-.RI "\fBNetsnmp_Free_Loop_Context\fP * \fBfree_loop_context_at_end\fP"
+.RI "Netsnmp_Free_Loop_Context * \fBfree_loop_context_at_end\fP"
.br
.RI "\fIFrees a loop context at the end of the entire iteration sequence. \fP"
.ti -1c
@@ -49,7 +50,7 @@
.br
.RI "\fIA pointer to the netsnmp_table_registration_info object this iterator is registered along with. \fP"
.ti -1c
-.RI "\fBNetsnmp_First_Data_Point\fP * \fBget_row_indexes\fP"
+.RI "Netsnmp_First_Data_Point * \fBget_row_indexes\fP"
.br
.ti -1c
.RI "\fBnetsnmp_variable_list\fP * \fBindexes\fP"
@@ -64,46 +65,36 @@
Definition at line 53 of file table_iterator.h.
.SH "Field Documentation"
.PP
-.SS "\fBNetsnmp_First_Data_Point\fP* \fBnetsnmp_iterator_info_s::get_first_data_point\fP"
+.SS "Netsnmp_Free_Data_Context* \fBnetsnmp_iterator_info_s::free_data_context\fP"
+.PP
+Frees a data context. This will be called at any time a data context needs to be freed. This may be at the same time as a correspondng loop context is freed, or much much later. Multiple data contexts may be kept in existence at any time.
+.PP
+Definition at line 82 of file table_iterator.h.
+.SS "Netsnmp_Free_Loop_Context* \fBnetsnmp_iterator_info_s::free_loop_context\fP"
+.PP
+A function which should free the loop context. This function is called at *each* iteration step, which is not-optimal for speed purposes. The use of free_loop_context_at_end instead is strongly encouraged. This can be set to NULL to avoid its usage.
+.PP
+Definition at line 75 of file table_iterator.h.
+.SS "Netsnmp_Free_Loop_Context* \fBnetsnmp_iterator_info_s::free_loop_context_at_end\fP"
+.PP
+Frees a loop context at the end of the entire iteration sequence. Generally, this would free the loop context allocated by the get_first_data_point function (which would then be updated by each call to the get_next_data_point function). It is not called until the get_next_data_point function returns a NULL
+.PP
+Definition at line 90 of file table_iterator.h.
+.SS "Netsnmp_First_Data_Point* \fBnetsnmp_iterator_info_s::get_first_data_point\fP"
.PP
Responsible for: returning the first set of 'index' data, a loop-context pointer, and optionally a data context pointer.
.PP
Definition at line 57 of file table_iterator.h.
-.PP
-Referenced by netsnmp_iterator_create_table(), netsnmp_iterator_row_count(), netsnmp_iterator_row_first(), netsnmp_iterator_row_get_byoid(), netsnmp_iterator_row_next_byoid(), and netsnmp_table_iterator_helper_handler().
-.SS "\fBNetsnmp_Next_Data_Point\fP* \fBnetsnmp_iterator_info_s::get_next_data_point\fP"
+.SS "Netsnmp_Next_Data_Point* \fBnetsnmp_iterator_info_s::get_next_data_point\fP"
.PP
Given the previous loop context, this should return the next loop context, associated index set and optionally a data context.
.PP
Definition at line 62 of file table_iterator.h.
-.PP
-Referenced by netsnmp_iterator_create_table(), netsnmp_iterator_row_count(), netsnmp_iterator_row_get_byoid(), netsnmp_iterator_row_next_byoid(), and netsnmp_table_iterator_helper_handler().
-.SS "\fBNetsnmp_Make_Data_Context\fP* \fBnetsnmp_iterator_info_s::make_data_context\fP"
+.SS "Netsnmp_Make_Data_Context* \fBnetsnmp_iterator_info_s::make_data_context\fP"
.PP
If a data context wasn't supplied by the get_first_data_point or get_next_data_point functions and the make_data_context pointer is defined, it will be called to convert a loop context into a data context.
.PP
Definition at line 68 of file table_iterator.h.
-.SS "\fBNetsnmp_Free_Loop_Context\fP* \fBnetsnmp_iterator_info_s::free_loop_context\fP"
-.PP
-A function which should free the loop context.
-.PP
-This function is called at *each* iteration step, which is not-optimal for speed purposes. The use of free_loop_context_at_end instead is strongly encouraged. This can be set to NULL to avoid its usage.
-.PP
-Definition at line 75 of file table_iterator.h.
-.SS "\fBNetsnmp_Free_Data_Context\fP* \fBnetsnmp_iterator_info_s::free_data_context\fP"
-.PP
-Frees a data context.
-.PP
-This will be called at any time a data context needs to be freed. This may be at the same time as a correspondng loop context is freed, or much much later. Multiple data contexts may be kept in existence at any time.
-.PP
-Definition at line 82 of file table_iterator.h.
-.SS "\fBNetsnmp_Free_Loop_Context\fP* \fBnetsnmp_iterator_info_s::free_loop_context_at_end\fP"
-.PP
-Frees a loop context at the end of the entire iteration sequence.
-.PP
-Generally, this would free the loop context allocated by the get_first_data_point function (which would then be updated by each call to the get_next_data_point function). It is not called until the get_next_data_point function returns a NULL
-.PP
-Definition at line 90 of file table_iterator.h.
.SS "void* \fBnetsnmp_iterator_info_s::myvoid\fP"
.PP
This can be used by client handlers to store any information they need.
@@ -114,8 +105,6 @@
A pointer to the netsnmp_table_registration_info object this iterator is registered along with.
.PP
Definition at line 100 of file table_iterator.h.
-.PP
-Referenced by netsnmp_register_table_iterator(), and netsnmp_table_iterator_helper_handler().
.SH "Author"
.PP
diff --git a/man/netsnmp_netsnmp_mib_handler_access_methods.3 b/man/netsnmp_netsnmp_mib_handler_access_methods.3
index b7c7fe5..b179929 100644
--- a/man/netsnmp_netsnmp_mib_handler_access_methods.3
+++ b/man/netsnmp_netsnmp_mib_handler_access_methods.3
@@ -1,20 +1,19 @@
-.TH "netsnmp_mib_handler_access_methods" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "netsnmp_mib_handler_access_methods" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-netsnmp_mib_handler_access_methods \- Defines the access methods to be called by the access_multiplexer helper.
-
+netsnmp_mib_handler_access_methods \-
.PP
+Defines the access methods to be called by the access_multiplexer helper.
+
.SH SYNOPSIS
.br
.PP
-\fC#include <baby_steps.h>\fP
.PP
+\fC#include <baby_steps.h>\fP
.SH "Detailed Description"
.PP
Defines the access methods to be called by the access_multiplexer helper.
-.PP
-
.SH "Author"
.PP
diff --git a/man/netsnmp_netsnmp_mib_handler_methods.3 b/man/netsnmp_netsnmp_mib_handler_methods.3
index b8ff7c4..cdca0fb 100644
--- a/man/netsnmp_netsnmp_mib_handler_methods.3
+++ b/man/netsnmp_netsnmp_mib_handler_methods.3
@@ -1,20 +1,19 @@
-.TH "netsnmp_mib_handler_methods" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "netsnmp_mib_handler_methods" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-netsnmp_mib_handler_methods \- Defines the subhandlers to be called by the multiplexer helper.
-
+netsnmp_mib_handler_methods \-
.PP
+Defines the subhandlers to be called by the multiplexer helper.
+
.SH SYNOPSIS
.br
.PP
-\fC#include <multiplexer.h>\fP
.PP
+\fC#include <multiplexer.h>\fP
.SH "Detailed Description"
.PP
Defines the subhandlers to be called by the multiplexer helper.
-.PP
-
.SH "Author"
.PP
diff --git a/man/netsnmp_netsnmp_mib_handler_s.3 b/man/netsnmp_netsnmp_mib_handler_s.3
index 5ecca52..6b5ea25 100644
--- a/man/netsnmp_netsnmp_mib_handler_s.3
+++ b/man/netsnmp_netsnmp_mib_handler_s.3
@@ -1,15 +1,16 @@
-.TH "netsnmp_mib_handler_s" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "netsnmp_mib_handler_s" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-netsnmp_mib_handler_s \- the mib handler structure to be registered
-
+netsnmp_mib_handler_s \-
.PP
+the mib handler structure to be registered
+
.SH SYNOPSIS
.br
.PP
-\fC#include <agent_handler.h>\fP
.PP
+\fC#include <agent_handler.h>\fP
.SS "Data Fields"
.in +1c
@@ -27,12 +28,16 @@
.ti -1c
.RI "int(* \fBaccess_method\fP )(struct \fBnetsnmp_mib_handler_s\fP *, struct \fBnetsnmp_handler_registration_s\fP *, struct \fBnetsnmp_agent_request_info_s\fP *, struct \fBnetsnmp_request_info_s\fP *)"
.br
-.RI "\fI_clone_handler in \fBagent_handler.c\fP. \fP"
+.RI "\fIif you add more members, you probably also want to update \fP"
.ti -1c
-.RI "\fBnetsnmp_mib_handler_s\fP * \fBnext\fP"
+.RI "void(* \fBdata_free\fP )(void *\fBmyvoid\fP)"
+.br
+.RI "\fIdata free hook for myvoid \fP"
+.ti -1c
+.RI "struct \fBnetsnmp_mib_handler_s\fP * \fBnext\fP"
.br
.ti -1c
-.RI "\fBnetsnmp_mib_handler_s\fP * \fBprev\fP"
+.RI "struct \fBnetsnmp_mib_handler_s\fP * \fBprev\fP"
.br
.in -1c
.SH "Detailed Description"
@@ -47,25 +52,22 @@
Definition at line 48 of file agent_handler.h.
.SH "Field Documentation"
.PP
-.SS "void* \fBnetsnmp_mib_handler_s::myvoid\fP"
+.SS "int(* \fBnetsnmp_mib_handler_s::access_method\fP)(struct \fBnetsnmp_mib_handler_s\fP *, struct \fBnetsnmp_handler_registration_s\fP *, struct \fBnetsnmp_agent_request_info_s\fP *, struct \fBnetsnmp_request_info_s\fP *)"
.PP
-for handler's internal use
+if you add more members, you probably also want to update _clone_handler in \fBagent_handler.c\fP.
+.SS "void(* \fBnetsnmp_mib_handler_s::data_free\fP)(void *\fBmyvoid\fP)"
.PP
-Definition at line 51 of file agent_handler.h.
-.PP
-Referenced by _netsnmp_tdata_helper_handler(), netsnmp_baby_steps_access_multiplexer_get(), netsnmp_baby_steps_handler_get(), netsnmp_cache_handler_get(), netsnmp_cache_helper_handler(), netsnmp_container_table_handler_get(), netsnmp_debug_helper(), netsnmp_find_handler_data_by_name(), netsnmp_get_cache_handler(), netsnmp_get_mode_end_call_handler(), netsnmp_get_multiplexer_handler(), netsnmp_get_row_merge_handler(), netsnmp_get_scalar_group_handler(), netsnmp_get_table_data_handler(), netsnmp_get_table_data_set_handler(), netsnmp_get_table_handler(), netsnmp_get_table_iterator_handler(), netsnmp_get_tdata_handler(), netsnmp_get_timed_bare_stash_cache_handler(), netsnmp_handler_dup(), netsnmp_instance_counter32_handler(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_num_file_handler(), netsnmp_instance_uint_handler(), netsnmp_instance_ulong_handler(), netsnmp_mode_end_call_helper(), netsnmp_multiplexer_helper_handler(), netsnmp_old_api_helper(), netsnmp_register_mib_table_row(), netsnmp_register_old_api(), netsnmp_register_watched_instance(), netsnmp_register_watched_scalar(), netsnmp_register_watched_spinlock(), netsnmp_row_merge_helper_handler(), netsnmp_scalar_group_helper_handler(), netsnmp_table_container_register(), netsnmp_table_data_helper_handler(), netsnmp_table_data_set_helper_handler(), netsnmp_table_iterator_helper_handler(), netsnmp_table_row_handler_get(), netsnmp_watched_spinlock_handler(), netsnmp_watched_timestamp_handler(), netsnmp_watched_timestamp_register(), netsnmp_watcher_helper_handler(), table_helper_handler(), and unregister_mibs_by_session().
+data free hook for myvoid
.SS "int \fBnetsnmp_mib_handler_s::flags\fP"
.PP
for agent_handler's internal use
.PP
Definition at line 53 of file agent_handler.h.
+.SS "void* \fBnetsnmp_mib_handler_s::myvoid\fP"
.PP
-Referenced by netsnmp_baby_steps_access_multiplexer_get(), netsnmp_bulk_to_next_helper(), netsnmp_cache_handler_get(), netsnmp_cache_helper_handler(), netsnmp_container_table_handler_get(), netsnmp_get_bulk_to_next_handler(), netsnmp_get_read_only_handler(), netsnmp_get_stash_to_next_handler(), netsnmp_get_table_data_handler(), netsnmp_get_table_data_set_handler(), netsnmp_get_tdata_handler(), netsnmp_get_watched_spinlock_handler(), netsnmp_get_watched_timestamp_handler(), netsnmp_get_watcher_handler(), netsnmp_register_handler(), netsnmp_register_instance(), netsnmp_stash_to_next_helper(), netsnmp_table_row_handler_get(), netsnmp_watched_spinlock_handler(), netsnmp_watched_timestamp_handler(), and netsnmp_watcher_helper_handler().
-.SS "int(* \fBnetsnmp_mib_handler_s::access_method\fP)(struct \fBnetsnmp_mib_handler_s\fP *, struct \fBnetsnmp_handler_registration_s\fP *, struct \fBnetsnmp_agent_request_info_s\fP *, struct \fBnetsnmp_request_info_s\fP *)"
+for handler's internal use
.PP
-_clone_handler in \fBagent_handler.c\fP.
-.PP
-Referenced by netsnmp_call_handler(), netsnmp_create_handler(), netsnmp_find_table_array_handler(), netsnmp_instance_counter32_handler(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_num_file_handler(), netsnmp_instance_uint_handler(), and netsnmp_instance_ulong_handler().
+Definition at line 51 of file agent_handler.h.
.SH "Author"
.PP
diff --git a/man/netsnmp_netsnmp_request_info_s.3 b/man/netsnmp_netsnmp_request_info_s.3
index 3281c15..bb1d0fc 100644
--- a/man/netsnmp_netsnmp_request_info_s.3
+++ b/man/netsnmp_netsnmp_request_info_s.3
@@ -1,33 +1,34 @@
-.TH "netsnmp_request_info_s" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "netsnmp_request_info_s" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-netsnmp_request_info_s \- The netsnmp request info structure.
-
+netsnmp_request_info_s \-
.PP
+The netsnmp request info structure.
+
.SH SYNOPSIS
.br
.PP
-\fC#include <snmp_agent.h>\fP
.PP
+\fC#include <snmp_agent.h>\fP
.SS "Data Fields"
.in +1c
.ti -1c
.RI "\fBnetsnmp_variable_list\fP * \fBrequestvb\fP"
.br
-.RI "\fIvariable bindings \fP"
+.RI "\fI\fBvariable\fP bindings \fP"
.ti -1c
.RI "\fBnetsnmp_data_list\fP * \fBparent_data\fP"
.br
.RI "\fIcan be used to pass information on a per-request basis from a helper to the later handlers \fP"
.ti -1c
-.RI "\fBnetsnmp_agent_request_info_s\fP * \fBagent_req_info\fP"
+.RI "struct \fBnetsnmp_agent_request_info_s\fP * \fBagent_req_info\fP"
.br
.ti -1c
.RI "oid * \fBrange_end\fP"
.br
-.RI "\fIdon't free, reference to (struct tree)->end \fP"
+.RI "\fIdon't free, reference to (struct \fBtree\fP)->end \fP"
.ti -1c
.RI "size_t \fBrange_end_len\fP"
.br
@@ -58,13 +59,13 @@
.RI "\fBnetsnmp_variable_list\fP * \fBrequestvb_start\fP"
.br
.ti -1c
-.RI "\fBnetsnmp_request_info_s\fP * \fBnext\fP"
+.RI "struct \fBnetsnmp_request_info_s\fP * \fBnext\fP"
.br
.ti -1c
-.RI "\fBnetsnmp_request_info_s\fP * \fBprev\fP"
+.RI "struct \fBnetsnmp_request_info_s\fP * \fBprev\fP"
.br
.ti -1c
-.RI "\fBnetsnmp_subtree_s\fP * \fBsubtree\fP"
+.RI "struct \fBnetsnmp_subtree_s\fP * \fBsubtree\fP"
.br
.in -1c
.SH "Detailed Description"
@@ -79,45 +80,35 @@
Definition at line 54 of file snmp_agent.h.
.SH "Field Documentation"
.PP
+.SS "int \fBnetsnmp_request_info_s::index\fP"
+.PP
+index in original pdu
+.PP
+Definition at line 84 of file snmp_agent.h.
+.SS "\fBnetsnmp_data_list\fP* \fBnetsnmp_request_info_s::parent_data\fP"
+.PP
+can be used to pass information on a per-request basis from a helper to the later handlers
+.PP
+Definition at line 64 of file snmp_agent.h.
+.SS "oid* \fBnetsnmp_request_info_s::range_end\fP"
+.PP
+don't free, reference to (struct \fBtree\fP)->end
+.PP
+Definition at line 72 of file snmp_agent.h.
+.SS "int \fBnetsnmp_request_info_s::repeat\fP"
+.PP
+get-bulk
+.PP
+Definition at line 87 of file snmp_agent.h.
.SS "\fBnetsnmp_variable_list\fP* \fBnetsnmp_request_info_s::requestvb\fP"
.PP
-variable bindings
+\fBvariable\fP bindings
.PP
\fBExamples: \fP
.in +1c
\fBdelayed_instance.c\fP.
.PP
Definition at line 58 of file snmp_agent.h.
-.PP
-Referenced by _request_set_error(), check_acm(), check_getnext_results(), debug_print_requests(), netsnmp_add_varbind_to_cache(), netsnmp_bulk_to_next_fix_requests(), netsnmp_bulk_to_next_helper(), netsnmp_check_getnext_reply(), netsnmp_instance_counter32_handler(), netsnmp_instance_helper_handler(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_num_file_handler(), netsnmp_instance_uint_handler(), netsnmp_instance_ulong_handler(), netsnmp_old_api_helper(), netsnmp_reassign_requests(), netsnmp_row_merge_helper_handler(), netsnmp_scalar_group_helper_handler(), netsnmp_scalar_helper_handler(), netsnmp_stash_cache_helper(), netsnmp_stash_to_next_helper(), netsnmp_table_build_oid(), netsnmp_table_build_oid_from_index(), netsnmp_table_build_result(), netsnmp_table_data_build_result(), netsnmp_table_data_set_helper_handler(), netsnmp_watched_spinlock_handler(), netsnmp_watched_timestamp_handler(), netsnmp_watcher_helper_handler(), and table_helper_handler().
-.SS "\fBnetsnmp_data_list\fP* \fBnetsnmp_request_info_s::parent_data\fP"
-.PP
-can be used to pass information on a per-request basis from a helper to the later handlers
-.PP
-Definition at line 64 of file snmp_agent.h.
-.PP
-Referenced by debug_print_requests(), netsnmp_add_varbind_to_cache(), netsnmp_free_request_data_set(), netsnmp_free_request_data_sets(), netsnmp_request_add_list_data(), netsnmp_request_get_list_data(), netsnmp_request_remove_list_data(), and netsnmp_stash_to_next_helper().
-.SS "oid* \fBnetsnmp_request_info_s::range_end\fP"
-.PP
-don't free, reference to (struct tree)->end
-.PP
-Definition at line 72 of file snmp_agent.h.
-.PP
-Referenced by check_getnext_results(), netsnmp_add_varbind_to_cache(), and netsnmp_bulk_to_next_fix_requests().
-.SS "int \fBnetsnmp_request_info_s::index\fP"
-.PP
-index in original pdu
-.PP
-Definition at line 84 of file snmp_agent.h.
-.PP
-Referenced by check_getnext_results(), debug_print_requests(), netsnmp_add_varbind_to_cache(), netsnmp_check_requests_status(), and netsnmp_reassign_requests().
-.SS "int \fBnetsnmp_request_info_s::repeat\fP"
-.PP
-get-bulk
-.PP
-Definition at line 87 of file snmp_agent.h.
-.PP
-Referenced by check_acm(), netsnmp_bulk_to_next_fix_requests(), and netsnmp_create_subtree_cache().
.SH "Author"
.PP
diff --git a/man/netsnmp_netsnmp_table_registration_info_s.3 b/man/netsnmp_netsnmp_table_registration_info_s.3
index 1b3d000..584f6ca 100644
--- a/man/netsnmp_netsnmp_table_registration_info_s.3
+++ b/man/netsnmp_netsnmp_table_registration_info_s.3
@@ -1,15 +1,16 @@
-.TH "netsnmp_table_registration_info_s" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "netsnmp_table_registration_info_s" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-netsnmp_table_registration_info_s \- Table registration structure.
-
+netsnmp_table_registration_info_s \-
.PP
+Table registration structure.
+
.SH SYNOPSIS
.br
.PP
-\fC#include <table.h>\fP
.PP
+\fC#include <table.h>\fP
.SS "Data Fields"
.in +1c
@@ -46,38 +47,26 @@
list of varbinds with only 'type' set
.PP
Definition at line 76 of file table.h.
-.PP
-Referenced by netsnmp_get_table_handler(), netsnmp_register_table_data_set(), netsnmp_register_table_iterator(), and table_helper_handler().
-.SS "unsigned int \fBnetsnmp_table_registration_info_s::number_indexes\fP"
-.PP
-calculated automatically
-.PP
-Definition at line 78 of file table.h.
-.PP
-Referenced by netsnmp_get_table_handler(), and table_helper_handler().
-.SS "unsigned int \fBnetsnmp_table_registration_info_s::min_column\fP"
-.PP
-the minimum columns number.
-.PP
-If there are columns in-between which are not valid, use valid_columns to get automatic column range checking.
-.PP
-Definition at line 85 of file table.h.
-.PP
-Referenced by netsnmp_register_table_data_set(), netsnmp_table_iterator_helper_handler(), netsnmp_table_row_register(), and table_helper_handler().
.SS "unsigned int \fBnetsnmp_table_registration_info_s::max_column\fP"
.PP
the maximum columns number
.PP
Definition at line 87 of file table.h.
+.SS "unsigned int \fBnetsnmp_table_registration_info_s::min_column\fP"
.PP
-Referenced by netsnmp_register_table_data_set(), netsnmp_table_iterator_helper_handler(), netsnmp_table_row_register(), and table_helper_handler().
+the minimum columns number. If there are columns in-between which are not valid, use valid_columns to get automatic column range checking.
+.PP
+Definition at line 85 of file table.h.
+.SS "unsigned int \fBnetsnmp_table_registration_info_s::number_indexes\fP"
+.PP
+calculated automatically
+.PP
+Definition at line 78 of file table.h.
.SS "\fBnetsnmp_column_info\fP* \fBnetsnmp_table_registration_info_s::valid_columns\fP"
.PP
more details on columns
.PP
Definition at line 90 of file table.h.
-.PP
-Referenced by table_helper_handler().
.SH "Author"
.PP
diff --git a/man/netsnmp_netsnmp_table_request_info_s.3 b/man/netsnmp_netsnmp_table_request_info_s.3
index 6818825..2936d95 100644
--- a/man/netsnmp_netsnmp_table_request_info_s.3
+++ b/man/netsnmp_netsnmp_table_request_info_s.3
@@ -1,15 +1,16 @@
-.TH "netsnmp_table_request_info_s" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "netsnmp_table_request_info_s" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-netsnmp_table_request_info_s \- The table request info structure.
-
+netsnmp_table_request_info_s \-
.PP
+The table request info structure.
+
.SH SYNOPSIS
.br
.PP
-\fC#include <table.h>\fP
.PP
+\fC#include <table.h>\fP
.SS "Data Fields"
.in +1c
@@ -47,22 +48,16 @@
0 if OID not long enough
.PP
Definition at line 104 of file table.h.
-.PP
-Referenced by netsnmp_table_build_oid(), netsnmp_table_build_oid_from_index(), netsnmp_table_data_set_helper_handler(), netsnmp_table_iterator_helper_handler(), and table_helper_handler().
-.SS "unsigned int \fBnetsnmp_table_request_info_s::number_indexes\fP"
-.PP
-0 if failure to parse any
-.PP
-Definition at line 106 of file table.h.
-.PP
-Referenced by table_helper_handler().
.SS "\fBnetsnmp_variable_list\fP* \fBnetsnmp_table_request_info_s::indexes\fP"
.PP
contents freed by helper upon exit
.PP
Definition at line 108 of file table.h.
+.SS "unsigned int \fBnetsnmp_table_request_info_s::number_indexes\fP"
.PP
-Referenced by netsnmp_container_table_row_insert(), netsnmp_insert_iterator_context(), netsnmp_insert_table_row(), netsnmp_table_build_oid(), netsnmp_table_data_set_create_newrowstash(), netsnmp_update_indexes_from_variable_list(), netsnmp_update_variable_list_from_index(), and table_helper_handler().
+0 if failure to parse any
+.PP
+Definition at line 106 of file table.h.
.SH "Author"
.PP
diff --git a/man/netsnmp_oid_stash.3 b/man/netsnmp_oid_stash.3
index 37f5421..fd1c05c 100644
--- a/man/netsnmp_oid_stash.3
+++ b/man/netsnmp_oid_stash.3
@@ -1,17 +1,18 @@
-.TH "Store and retrieve data referenced by an OID." 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "Store and retrieve data referenced by an OID." 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-Store and retrieve data referenced by an OID. \- This is essentially a way of storing data associated with a given OID.
-
+Store and retrieve data referenced by an OID. \-
.PP
+This is essentially a way of storing data associated with a given OID.
+
.SS "Functions"
.in +1c
.ti -1c
.RI "\fBnetsnmp_oid_stash_node\fP * \fBnetsnmp_oid_stash_create_sized_node\fP (size_t mysize)"
.br
-.RI "\fICreate an netsnmp_oid_stash node. \fP"
+.RI "\fICreate an netsnmp_oid_stash \fBnode\fP. \fP"
.ti -1c
.RI "NETSNMP_INLINE \fBnetsnmp_oid_stash_node\fP * \fBnetsnmp_oid_stash_create_node\fP (void)"
.br
@@ -23,11 +24,11 @@
.ti -1c
.RI "\fBnetsnmp_oid_stash_node\fP * \fBnetsnmp_oid_stash_get_node\fP (\fBnetsnmp_oid_stash_node\fP *root, oid *lookup, size_t lookup_len)"
.br
-.RI "\fIreturns a node associated with a given OID. \fP"
+.RI "\fIreturns a \fBnode\fP associated with a given OID. \fP"
.ti -1c
.RI "\fBnetsnmp_oid_stash_node\fP * \fBnetsnmp_oid_stash_getnext_node\fP (\fBnetsnmp_oid_stash_node\fP *root, oid *lookup, size_t lookup_len)"
.br
-.RI "\fIreturns the next node associated with a given OID. \fP"
+.RI "\fIreturns the next \fBnode\fP associated with a given OID. \fP"
.ti -1c
.RI "void * \fBnetsnmp_oid_stash_get_data\fP (\fBnetsnmp_oid_stash_node\fP *root, oid *lookup, size_t lookup_len)"
.br
@@ -39,15 +40,15 @@
.ti -1c
.RI "void \fBnetsnmp_oid_stash_store\fP (\fBnetsnmp_oid_stash_node\fP *root, const char *tokenname, NetSNMPStashDump *dumpfn, oid *curoid, size_t curoid_len)"
.br
-.RI "\fIstores data in a starsh tree to peristent storage. \fP"
+.RI "\fIstores data in a starsh \fBtree\fP to peristent storage. \fP"
.ti -1c
.RI "void \fBoid_stash_dump\fP (\fBnetsnmp_oid_stash_node\fP *root, char *prefix)"
.br
-.RI "\fIFor debugging: dump the netsnmp_oid_stash tree to stdout. \fP"
+.RI "\fIFor debugging: dump the netsnmp_oid_stash \fBtree\fP to stdout. \fP"
.ti -1c
.RI "void \fBnetsnmp_oid_stash_free\fP (\fBnetsnmp_oid_stash_node\fP **root, NetSNMPStashFreeNode *freefn)"
.br
-.RI "\fIFrees the contents of a netsnmp_oid_stash tree. \fP"
+.RI "\fIFrees the contents of a netsnmp_oid_stash \fBtree\fP. \fP"
.ti -1c
.RI "void \fBnetsnmp_oid_stash_no_free\fP (void *bogus)"
.br
@@ -55,17 +56,15 @@
.SH "Detailed Description"
.PP
This is essentially a way of storing data associated with a given OID.
-.PP
-It stores a bunch of data pointers within a memory tree that allows fairly efficient lookups with a heavily populated tree.
+
+It stores a bunch of data pointers within a memory \fBtree\fP that allows fairly efficient lookups with a heavily populated \fBtree\fP.
.SH "Function Documentation"
.PP
.SS "int netsnmp_oid_stash_add_data (\fBnetsnmp_oid_stash_node\fP ** root, oid * lookup, size_t lookup_len, void * mydata)"
.PP
-adds data to the stash at a given oid.
-.PP
-\fBParameters:\fP
+adds data to the stash at a given oid. \fBParameters:\fP
.RS 4
-\fIroot\fP the top of the stash tree
+\fIroot\fP the top of the stash \fBtree\fP
.br
\fIlookup\fP the oid index to store the data at.
.br
@@ -82,56 +81,38 @@
.PP
Definition at line 83 of file oid_stash.c.
-.PP
-References netsnmp_oid_stash_node_s::children, netsnmp_oid_stash_node_s::children_size, netsnmp_oid_stash_create_node(), netsnmp_oid_stash_node_s::next_sibling, NULL, netsnmp_oid_stash_node_s::parent, netsnmp_oid_stash_node_s::prev_sibling, netsnmp_oid_stash_node_s::thedata, and netsnmp_oid_stash_node_s::value.
-.PP
-Referenced by netsnmp_stash_to_next_helper(), and netsnmp_table_data_set_helper_handler().
.SS "NETSNMP_INLINE \fBnetsnmp_oid_stash_node\fP* netsnmp_oid_stash_create_node (void)"
.PP
-Creates a netsnmp_oid_stash_node.
-.PP
-Assumes you want the default OID_STASH_CHILDREN_SIZE hash size for the node.
+Creates a netsnmp_oid_stash_node. Assumes you want the default OID_STASH_CHILDREN_SIZE hash size for the \fBnode\fP.
.PP
\fBReturns:\fP
.RS 4
-NULL on error, otherwise the newly allocated node
+NULL on error, otherwise the newly allocated \fBnode\fP
.RE
.PP
.PP
Definition at line 66 of file oid_stash.c.
-.PP
-References netsnmp_oid_stash_create_sized_node().
-.PP
-Referenced by netsnmp_oid_stash_add_data().
.SS "\fBnetsnmp_oid_stash_node\fP* netsnmp_oid_stash_create_sized_node (size_t mysize)"
.PP
-Create an netsnmp_oid_stash node.
-.PP
-\fBParameters:\fP
+Create an netsnmp_oid_stash \fBnode\fP. \fBParameters:\fP
.RS 4
\fImysize\fP the size of the child pointer array
.RE
.PP
\fBReturns:\fP
.RS 4
-NULL on error, otherwise the newly allocated node
+NULL on error, otherwise the newly allocated \fBnode\fP
.RE
.PP
.PP
Definition at line 46 of file oid_stash.c.
-.PP
-References netsnmp_oid_stash_node_s::children, netsnmp_oid_stash_node_s::children_size, NULL, and SNMP_MALLOC_TYPEDEF.
-.PP
-Referenced by netsnmp_oid_stash_create_node().
.SS "void netsnmp_oid_stash_free (\fBnetsnmp_oid_stash_node\fP ** root, NetSNMPStashFreeNode * freefn)"
.PP
-Frees the contents of a netsnmp_oid_stash tree.
-.PP
-\fBParameters:\fP
+Frees the contents of a netsnmp_oid_stash \fBtree\fP. \fBParameters:\fP
.RS 4
-\fIroot\fP the top of the tree (or branch to be freed)
+\fIroot\fP the top of the \fBtree\fP (or branch to be freed)
.br
\fIfreefn\fP The function to be called on each data (void *) pointer. If left NULL the system free() function will be called
.RE
@@ -139,15 +120,9 @@
.PP
Definition at line 401 of file oid_stash.c.
-.PP
-References netsnmp_oid_stash_node_s::children, netsnmp_oid_stash_free(), netsnmp_oid_stash_node_s::next_sibling, and netsnmp_oid_stash_node_s::thedata.
-.PP
-Referenced by _netsnmp_stash_cache_free(), and netsnmp_oid_stash_free().
.SS "void* netsnmp_oid_stash_get_data (\fBnetsnmp_oid_stash_node\fP * root, oid * lookup, size_t lookup_len)"
.PP
-returns a data pointer associated with a given OID.
-.PP
-This is equivelent to netsnmp_oid_stash_get_node, but returns only the data not the entire node.
+returns a data pointer associated with a given OID. This is equivelent to netsnmp_oid_stash_get_node, but returns only the data not the entire \fBnode\fP.
.PP
\fBParameters:\fP
.RS 4
@@ -161,19 +136,13 @@
.PP
Definition at line 282 of file oid_stash.c.
-.PP
-References netsnmp_oid_stash_get_node(), NULL, and netsnmp_oid_stash_node_s::thedata.
-.PP
-Referenced by netsnmp_stash_cache_helper(), and netsnmp_table_data_set_helper_handler().
.SS "\fBnetsnmp_oid_stash_node\fP* netsnmp_oid_stash_get_node (\fBnetsnmp_oid_stash_node\fP * root, oid * lookup, size_t lookup_len)"
.PP
-returns a node associated with a given OID.
-.PP
-\fBParameters:\fP
+returns a \fBnode\fP associated with a given OID. \fBParameters:\fP
.RS 4
-\fIroot\fP the top of the stash tree
+\fIroot\fP the top of the stash \fBtree\fP
.br
-\fIlookup\fP the oid to look up a node for.
+\fIlookup\fP the oid to look up a \fBnode\fP for.
.br
\fIlookup_len\fP the length of the lookup oid
.RE
@@ -181,26 +150,14 @@
.PP
Definition at line 154 of file oid_stash.c.
-.PP
-References netsnmp_oid_stash_node_s::children, netsnmp_oid_stash_node_s::children_size, netsnmp_oid_stash_node_s::next_sibling, NULL, and netsnmp_oid_stash_node_s::value.
-.PP
-Referenced by netsnmp_oid_stash_get_data().
.SS "\fBnetsnmp_oid_stash_node\fP* netsnmp_oid_stash_getnext_node (\fBnetsnmp_oid_stash_node\fP * root, oid * lookup, size_t lookup_len)"
.PP
-returns the next node associated with a given OID.
-.PP
-INCOMPLETE. This is equivelent to a GETNEXT operation.
+returns the next \fBnode\fP associated with a given OID. INCOMPLETE. This is equivelent to a GETNEXT operation.
.PP
Definition at line 191 of file oid_stash.c.
-.PP
-References netsnmp_oid_stash_node_s::children, netsnmp_oid_stash_node_s::children_size, netsnmp_oid_stash_node_s::next_sibling, NULL, and netsnmp_oid_stash_node_s::value.
-.PP
-Referenced by netsnmp_stash_cache_helper().
.SS "void netsnmp_oid_stash_store (\fBnetsnmp_oid_stash_node\fP * root, const char * tokenname, NetSNMPStashDump * dumpfn, oid * curoid, size_t curoid_len)"
.PP
-stores data in a starsh tree to peristent storage.
-.PP
-This function can be called to save all data in a stash tree to Net-SNMP's percent storage. Make sure you register a parsing function with the read_config system to re-incorperate your saved data into future trees.
+stores data in a starsh \fBtree\fP to peristent storage. This function can be called to save all data in a stash \fBtree\fP to Net-SNMP's percent storage. Make sure you register a parsing function with the read_config system to re-incorperate your saved data into future trees.
.PP
\fBParameters:\fP
.RS 4
@@ -208,7 +165,7 @@
.br
\fItokenname\fP the file token name to save in (passing 'snmpd' will save things into snmpd.conf).
.br
-\fIdumpfn\fP A function which can dump the data stored at a particular node into a char buffer.
+\fIdumpfn\fP A function which can dump the data stored at a particular \fBnode\fP into a char buffer.
.br
\fIcuroid\fP must be a pointer to a OID array of length MAX_OID_LEN.
.br
@@ -218,15 +175,9 @@
.PP
Definition at line 334 of file oid_stash.c.
-.PP
-References netsnmp_oid_stash_node_s::children, netsnmp_oid_stash_node_s::children_size, netsnmp_ds_get_string(), netsnmp_oid_stash_store(), netsnmp_oid_stash_node_s::next_sibling, read_config_save_objid(), read_config_store(), SNMP_MAXBUF, netsnmp_oid_stash_node_s::thedata, and netsnmp_oid_stash_node_s::value.
-.PP
-Referenced by netsnmp_oid_stash_store(), and netsnmp_oid_stash_store_all().
.SS "int netsnmp_oid_stash_store_all (int majorID, int minorID, void * serverarg, void * clientarg)"
.PP
-a wrapper around netsnmp_oid_stash_store for use with a \fBsnmp_alarm\fP.
-.PP
-when calling \fBsnmp_alarm\fP, you can list this as a callback. The clientarg should be a pointer to a netsnmp_oid_stash_save_info pointer. It can also be called directly, of course. The last argument (clientarg) is the only one that is used. The rest are ignored by the function.
+a wrapper around netsnmp_oid_stash_store for use with a \fBsnmp_alarm\fP. when calling \fBsnmp_alarm\fP, you can list this as a callback. The clientarg should be a pointer to a netsnmp_oid_stash_save_info pointer. It can also be called directly, of course. The last argument (clientarg) is the only one that is used. The rest are ignored by the function.
.PP
\fBParameters:\fP
.RS 4
@@ -242,15 +193,11 @@
.PP
Definition at line 304 of file oid_stash.c.
-.PP
-References netsnmp_oid_stash_save_info_s::dumpfn, netsnmp_oid_stash_store(), netsnmp_oid_stash_save_info_s::root, and netsnmp_oid_stash_save_info_s::token.
.SS "void oid_stash_dump (\fBnetsnmp_oid_stash_node\fP * root, char * prefix)"
.PP
-For debugging: dump the netsnmp_oid_stash tree to stdout.
-.PP
-\fBParameters:\fP
+For debugging: dump the netsnmp_oid_stash \fBtree\fP to stdout. \fBParameters:\fP
.RS 4
-\fIroot\fP The top of the tree
+\fIroot\fP The top of the \fBtree\fP
.br
\fIprefix\fP a character string prefix printed to the beginning of each line.
.RE
@@ -258,5 +205,6 @@
.PP
Definition at line 374 of file oid_stash.c.
-.PP
-References netsnmp_oid_stash_node_s::children, netsnmp_oid_stash_node_s::children_size, netsnmp_oid_stash_node_s::next_sibling, netsnmp_oid_stash_node_s::thedata, and netsnmp_oid_stash_node_s::value.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_old_api.3 b/man/netsnmp_old_api.3
index c3d32d6..f081b79 100644
--- a/man/netsnmp_old_api.3
+++ b/man/netsnmp_old_api.3
@@ -1,10 +1,11 @@
-.TH "old_api" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "old_api" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-old_api \- Calls mib module code written in the old style of code.
-
+old_api \-
.PP
+Calls mib \fBmodule\fP code written in the old style of code.
+
.SS "Functions"
.in +1c
@@ -15,7 +16,7 @@
.ti -1c
.RI "int \fBnetsnmp_register_old_api\fP (const char *moduleName, struct \fBvariable\fP *var, size_t varsize, size_t numvars, oid *mibloc, size_t mibloclen, int priority, int range_subid, oid range_ubound, \fBnetsnmp_session\fP *ss, const char *context, int timeout, int flags)"
.br
-.RI "\fIRegisters an old API set into the mib tree. \fP"
+.RI "\fIRegisters an old API set into the mib \fBtree\fP. \fP"
.ti -1c
.RI "int \fBnetsnmp_register_mib_table_row\fP (const char *moduleName, struct \fBvariable\fP *var, size_t varsize, size_t numvars, oid *mibloc, size_t mibloclen, int priority, int var_subid, \fBnetsnmp_session\fP *ss, const char *context, int timeout, int flags)"
.br
@@ -27,48 +28,33 @@
.in -1c
.SH "Detailed Description"
.PP
-Calls mib module code written in the old style of code.
-.PP
-This is a backwards compatilibity module that allows code written in the old API to be run under the new handler based architecture. Use it by calling \fBnetsnmp_register_old_api()\fP.
+Calls mib \fBmodule\fP code written in the old style of code.
+
+This is a backwards compatilibity \fBmodule\fP that allows code written in the old API to be run under the new handler based architecture. Use it by calling \fBnetsnmp_register_old_api()\fP.
.SH "Function Documentation"
.PP
.SS "\fBnetsnmp_mib_handler\fP* get_old_api_handler (void)"
.PP
-returns a old_api handler that should be the final calling handler.
-.PP
-Don't use this function. Use the \fBnetsnmp_register_old_api()\fP function instead.
+returns a old_api handler that should be the final calling handler. Don't use this function. Use the \fBnetsnmp_register_old_api()\fP function instead.
.PP
Definition at line 37 of file old_api.c.
-.PP
-References netsnmp_create_handler(), and netsnmp_old_api_helper().
-.PP
-Referenced by netsnmp_register_mib_table_row(), and netsnmp_register_old_api().
.SS "int netsnmp_old_api_helper (\fBnetsnmp_mib_handler\fP * handler, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests)"
.PP
implements the old_api handler
.PP
Definition at line 226 of file old_api.c.
-.PP
-References variable::acl, variable::findVar, variable::magic, MIB_CLIENTS_ARE_EVIL, netsnmp_agent_request_info_s::mode, netsnmp_mib_handler_s::myvoid, variable_list::name, variable::name, variable_list::name_length, variable::namelen, netsnmp_request_info_s::next, NULL, netsnmp_request_info_s::requestvb, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, snmp_set_var_objid(), and variable::type.
-.PP
-Referenced by get_old_api_handler().
.SS "int netsnmp_register_mib_table_row (const char * moduleName, struct \fBvariable\fP * var, size_t varsize, size_t numvars, oid * mibloc, size_t mibloclen, int priority, int var_subid, \fBnetsnmp_session\fP * ss, const char * context, int timeout, int flags)"
.PP
registers a row within a mib table
.PP
Definition at line 107 of file old_api.c.
-.PP
-References netsnmp_handler_registration_s::contextName, register_parameters::contextName, register_parameters::flags, get_old_api_handler(), netsnmp_handler_registration_s::handler, HANDLER_CAN_RWRITE, netsnmp_handler_registration_s::handlerName, netsnmp_handler_registration_s::modes, netsnmp_mib_handler_s::myvoid, register_parameters::name, register_parameters::namelen, netsnmp_handler_registration_free(), netsnmp_register_handler_nocallback(), NULL, netsnmp_handler_registration_s::priority, register_parameters::priority, netsnmp_handler_registration_s::range_subid, register_parameters::range_subid, netsnmp_handler_registration_s::range_ubound, register_parameters::range_ubound, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, snmp_call_callbacks(), SNMP_MALLOC_TYPEDEF, netsnmp_handler_registration_s::timeout, and register_parameters::timeout.
.SS "int netsnmp_register_old_api (const char * moduleName, struct \fBvariable\fP * var, size_t varsize, size_t numvars, oid * mibloc, size_t mibloclen, int priority, int range_subid, oid range_ubound, \fBnetsnmp_session\fP * ss, const char * context, int timeout, int flags)"
.PP
-Registers an old API set into the mib tree.
-.PP
-Functionally this mimics the old \fBregister_mib_context()\fP function (and in fact the new \fBregister_mib_context()\fP function merely calls this new old_api one).
+Registers an old API set into the mib \fBtree\fP. Functionally this mimics the old register_mib_context() function (and in fact the new register_mib_context() function merely calls this new old_api one).
.PP
netsnmp_handler_registration_free(reginfo); already freed
.PP
Definition at line 48 of file old_api.c.
-.PP
-References netsnmp_handler_registration_s::contextName, get_old_api_handler(), netsnmp_handler_registration_s::handler, HANDLER_CAN_RWRITE, netsnmp_handler_registration_s::handlerName, memdup(), netsnmp_handler_registration_s::modes, netsnmp_mib_handler_s::myvoid, netsnmp_register_handler(), NULL, netsnmp_handler_registration_s::priority, netsnmp_handler_registration_s::range_subid, netsnmp_handler_registration_s::range_ubound, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, SNMP_FREE, SNMP_MALLOC_TYPEDEF, and netsnmp_handler_registration_s::timeout.
-.PP
-Referenced by register_mib_context().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_read_config.3 b/man/netsnmp_read_config.3
index 0f881a4..0d9ea18 100644
--- a/man/netsnmp_read_config.3
+++ b/man/netsnmp_read_config.3
@@ -1,10 +1,11 @@
-.TH "parsing various configuration files at run time" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "parsing various configuration files at run time" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-parsing various configuration files at run time \- The read_config related functions are a fairly extensible system of parsing various configuration files at the run time.
-
+parsing various configuration files at run time \-
.PP
+The read_config related functions are a fairly extensible system of parsing various configuration files at the run time.
+
.SS "Defines"
.in +1c
@@ -16,17 +17,17 @@
.in +1c
.ti -1c
-.RI "\fBconfig_line\fP * \fBregister_prenetsnmp_mib_handler\fP (const char *type, const char *token, void(*parser)(const char *, char *), void(*releaser)(void), const char *help)"
+.RI "struct \fBconfig_line\fP * \fBregister_prenetsnmp_mib_handler\fP (const char *type, const char *token, void(*parser)(const char *, char *), void(*releaser)(void), const char *help)"
.br
.ti -1c
-.RI "\fBconfig_line\fP * \fBregister_app_prenetsnmp_mib_handler\fP (const char *token, void(*parser)(const char *, char *), void(*releaser)(void), const char *help)"
+.RI "struct \fBconfig_line\fP * \fBregister_app_prenetsnmp_mib_handler\fP (const char *token, void(*parser)(const char *, char *), void(*releaser)(void), const char *help)"
.br
.ti -1c
-.RI "\fBconfig_line\fP * \fBregister_config_handler\fP (const char *type, const char *token, void(*parser)(const char *, char *), void(*releaser)(void), const char *help)"
+.RI "struct \fBconfig_line\fP * \fBregister_config_handler\fP (const char *type, const char *token, void(*parser)(const char *, char *), void(*releaser)(void), const char *help)"
.br
.RI "\fIregister_config_handler registers handlers for certain tokens specified in certain types of files. \fP"
.ti -1c
-.RI "\fBconfig_line\fP * \fBregister_app_config_handler\fP (const char *token, void(*parser)(const char *, char *), void(*releaser)(void), const char *help)"
+.RI "struct \fBconfig_line\fP * \fBregister_app_config_handler\fP (const char *token, void(*parser)(const char *, char *), void(*releaser)(void), const char *help)"
.br
.ti -1c
.RI "void \fBunregister_config_handler\fP (const char *type_param, const char *token)"
@@ -39,7 +40,7 @@
.RI "void \fBunregister_all_config_handlers\fP ()"
.br
.ti -1c
-.RI "\fBconfig_line\fP * \fBread_config_get_handlers\fP (const char *type)"
+.RI "struct \fBconfig_line\fP * \fBread_config_get_handlers\fP (const char *type)"
.br
.ti -1c
.RI "void \fBread_config_with_type_when\fP (const char *filename, const char *type, int when)"
@@ -48,7 +49,7 @@
.RI "void \fBread_config_with_type\fP (const char *filename, const char *type)"
.br
.ti -1c
-.RI "\fBconfig_line\fP * \fBread_config_find_handler\fP (struct \fBconfig_line\fP *line_handlers, const char *token)"
+.RI "struct \fBconfig_line\fP * \fBread_config_find_handler\fP (struct \fBconfig_line\fP *line_handlers, const char *token)"
.br
.ti -1c
.RI "int \fBrun_config_handler\fP (struct \fBconfig_line\fP *lptr, const char *token, char *cptr, int when)"
@@ -181,7 +182,7 @@
.in +1c
.ti -1c
-.RI "\fBconfig_files\fP * \fBconfig_files\fP = NULL"
+.RI "struct \fBconfig_files\fP * \fBconfig_files\fP = NULL"
.br
.ti -1c
.RI "int \fBlinecount\fP"
@@ -193,7 +194,7 @@
.SH "Detailed Description"
.PP
The read_config related functions are a fairly extensible system of parsing various configuration files at the run time.
-.PP
+
The idea is that the calling application is able to register handlers for certain tokens specified in certain types of files. The read_configs function can then be called to look for all the files that it has registrations for, find the first word on each line, and pass the remainder to the appropriately registered handler.
.PP
For persistent configuration storage you will need to use the read_config_read_data, read_config_store, and read_config_store_data APIs in conjunction with first registering a callback so when the agent shutsdown for whatever reason data is written to your configuration files. The following explains in more detail the sequence to make this happen.
@@ -217,9 +218,7 @@
.PP
.SS "char* read_config_read_data (int type, char * readfrom, void * dataptr, size_t * len)"
.PP
-read_config_read_data reads data of a given type from a token(s) on a configuration line.
-.PP
-The supported types are:
+read_config_read_data reads data of a given type from a token(s) on a configuration line. The supported types are:
.PP
.IP "\(bu" 2
ASN_INTEGER
@@ -254,15 +253,9 @@
.PP
Definition at line 1831 of file read_config.c.
-.PP
-References NULL, read_config_read_objid(), read_config_read_octet_string(), and skip_token().
-.PP
-Referenced by netsnmp_read_data_callback().
.SS "void read_config_store (const char * type, const char * line)"
.PP
-read_config_store intended for use by applications to store permenant configuration information generated by sets or persistent counters.
-.PP
-Appends line to a file named either ENV(SNMP_PERSISTENT_FILE) or '<NETSNMP_PERSISTENT_DIRECTORY>/<type>.conf'. Adds a trailing newline to the stored file if necessary.
+read_config_store intended for use by applications to store permenant configuration information generated by sets or persistent counters. Appends line to a file named either ENV(SNMP_PERSISTENT_FILE) or '<NETSNMP_PERSISTENT_DIRECTORY>/<type>.conf'. Adds a trailing newline to the stored file if necessary.
.PP
\fBParameters:\fP
.RS 4
@@ -279,15 +272,9 @@
.PP
Definition at line 1267 of file read_config.c.
-.PP
-References get_persistent_directory(), netsnmp_ds_get_boolean(), netsnmp_getenv(), NULL, and snmp_log().
-.PP
-Referenced by netsnmp_oid_stash_store(), netsnmp_save_all_data(), read_app_config_store(), and snmp_save_persistent().
.SS "char* read_config_store_data (int type, char * storeto, void * dataptr, size_t * len)"
.PP
-read_config_store_data stores data of a given type to a configuration line into the storeto buffer.
-.PP
-Calls read_config_store_data_prefix with the prefix parameter set to a char space. The supported types are:
+read_config_store_data stores data of a given type to a configuration line into the storeto buffer. Calls read_config_store_data_prefix with the prefix parameter set to a char space. The supported types are:
.PP
.IP "\(bu" 2
ASN_INTEGER
@@ -322,13 +309,9 @@
.PP
Definition at line 1990 of file read_config.c.
+.SS "struct \fBconfig_line\fP* register_config_handler (const char * type, const char * token, void(*)(const char *, char *) parser, void(*)(void) releaser, const char * help)\fC [read]\fP"
.PP
-References read_config_store_data_prefix().
-.SS "struct \fBconfig_line\fP* register_config_handler (const char * type, const char * token, void(*)(const char *, char *) parser, void(*)(void) releaser, const char * help)"
-.PP
-register_config_handler registers handlers for certain tokens specified in certain types of files.
-.PP
-Allows a module writer use/register multiple configuration files based off of the type parameter. A module writer may want to set up multiple configuration files to separate out related tasks/variables or just for management of where to put tokens as the module or modules get more complex in regard to handling token registrations.
+register_config_handler registers handlers for certain tokens specified in certain types of files. Allows a \fBmodule\fP writer use/register multiple configuration files based off of the type parameter. A \fBmodule\fP writer may want to set up multiple configuration files to separate out related tasks/variables or just for management of where to put tokens as the \fBmodule\fP or modules get more complex in regard to handling token registrations.
.PP
\fBParameters:\fP
.RS 4
@@ -351,13 +334,9 @@
.PP
Definition at line 284 of file read_config.c.
-.PP
-Referenced by netsnmp_ds_register_config(), netsnmp_register_save_list(), register_app_config_handler(), and register_mib_handlers().
.SS "void unregister_config_handler (const char * type_param, const char * token)"
.PP
-uregister_config_handler un-registers handlers given a specific type_param and token.
-.PP
-\fBParameters:\fP
+uregister_config_handler un-registers handlers given a specific type_param and token. \fBParameters:\fP
.RS 4
\fItype_param\fP the configuration file used where the token is located. Used to lookup the config file entry
.br
@@ -372,7 +351,6 @@
.PP
Definition at line 315 of file read_config.c.
-.PP
-References config_files, netsnmp_ds_get_string(), config_line::next, NULL, SNMP_FREE, and unregister_config_handler().
-.PP
-Referenced by netsnmp_ds_shutdown(), unregister_all_config_handlers(), unregister_app_config_handler(), and unregister_config_handler().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_read_only.3 b/man/netsnmp_read_only.3
index 0053823..fad6a45 100644
--- a/man/netsnmp_read_only.3
+++ b/man/netsnmp_read_only.3
@@ -1,10 +1,11 @@
-.TH "read_only" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "read_only" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-read_only \- Make your handler read_only automatically The only purpose of this handler is to return an appropriate error for any requests passed to it in a SET mode.
-
+read_only \-
.PP
+Make your handler read_only automatically The only purpose of this handler is to return an appropriate error for any requests passed to it in a SET mode.
+
.SS "Functions"
.in +1c
@@ -23,7 +24,7 @@
.SH "Detailed Description"
.PP
Make your handler read_only automatically The only purpose of this handler is to return an appropriate error for any requests passed to it in a SET mode.
-.PP
+
Inserting it into your handler chain will ensure you're never asked to perform a SET request so you can ignore those error conditions.
.SH "Function Documentation"
.PP
@@ -32,14 +33,11 @@
returns a read_only handler that can be injected into a given handler chain.
.PP
Definition at line 29 of file read_only.c.
-.PP
-References netsnmp_mib_handler_s::flags, MIB_HANDLER_AUTO_NEXT, netsnmp_create_handler(), netsnmp_read_only_helper(), and NULL.
-.PP
-Referenced by netsnmp_init_read_only_helper(), netsnmp_register_read_only_instance(), netsnmp_register_read_only_scalar(), and netsnmp_register_read_only_table_data().
.SS "void netsnmp_init_read_only_helper (void)"
.PP
initializes the read_only helper which then registers a read_only handler as a run-time injectable handler for configuration file use.
.PP
Definition at line 81 of file read_only.c.
-.PP
-References netsnmp_get_read_only_handler(), and netsnmp_register_handler_by_name().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_row_merge.3 b/man/netsnmp_row_merge.3
index 16454a8..df71874 100644
--- a/man/netsnmp_row_merge.3
+++ b/man/netsnmp_row_merge.3
@@ -1,10 +1,11 @@
-.TH "row_merge" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "row_merge" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-row_merge \- Calls sub handlers with request for one row at a time.
-
+row_merge \-
.PP
+Calls sub handlers with request for one row at a time.
+
.SS "Defines"
.in +1c
@@ -56,7 +57,7 @@
.SH "Detailed Description"
.PP
Calls sub handlers with request for one row at a time.
-.PP
+
This helper splits a whole bunch of requests into chunks based on the row index that they refer to, and passes all requests for a given row to the lower handlers. This is useful for handlers that don't want to process multiple rows at the same time, but are happy to iterate through the request list for a single row.
.SH "Function Documentation"
.PP
@@ -65,57 +66,36 @@
returns a row_merge handler that can be injected into a given handler chain.
.PP
Definition at line 28 of file row_merge.c.
-.PP
-References netsnmp_mib_handler_s::myvoid, netsnmp_create_handler(), netsnmp_row_merge_helper_handler(), and NULL.
-.PP
-Referenced by netsnmp_init_row_merge(), and netsnmp_register_row_merge().
.SS "void netsnmp_init_row_merge (void)"
.PP
initializes the row_merge helper which then registers a row_merge handler as a run-time injectable handler for configuration file use.
.PP
Definition at line 360 of file row_merge.c.
-.PP
-References netsnmp_get_row_merge_handler(), and netsnmp_register_handler_by_name().
.SS "int netsnmp_register_row_merge (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
functionally the same as calling \fBnetsnmp_register_handler()\fP but also injects a row_merge handler at the same time for you.
.PP
Definition at line 42 of file row_merge.c.
-.PP
-References netsnmp_get_row_merge_handler(), netsnmp_inject_handler(), netsnmp_register_handler(), and netsnmp_handler_registration_s::rootoid_len.
.SS "int netsnmp_row_merge_helper_handler (\fBnetsnmp_mib_handler\fP * handler, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests)"
.PP
Implements the row_merge handler.
.PP
Definition at line 154 of file row_merge.c.
-.PP
-References netsnmp_row_merge_status_x::count, netsnmp_agent_request_info_s::mode, netsnmp_mib_handler_s::myvoid, variable_list::name, variable_list::name_length, netsnmp_call_next_handler(), netsnmp_row_merge_status_get(), netsnmp_request_info_s::next, NULL, netsnmp_request_info_s::prev, netsnmp_request_info_s::processed, netsnmp_request_info_s::requestvb, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, ROW_MERGE_DONE, ROW_MERGE_WAITING, netsnmp_row_merge_status_x::rows, netsnmp_row_merge_status_x::saved_requests, netsnmp_row_merge_status_x::saved_status, and SNMP_FREE.
-.PP
-Referenced by netsnmp_get_row_merge_handler().
.SS "int netsnmp_row_merge_status_first (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo)"
.PP
-Determine if this is the first row.
-.PP
-returns 1 if this is the first row for this pass of the handler.
+Determine if this is the first row. returns 1 if this is the first row for this pass of the handler.
.PP
Definition at line 110 of file row_merge.c.
-.PP
-References netsnmp_row_merge_status_x::count, netsnmp_row_merge_status_x::current, netsnmp_row_merge_status_get(), and NULL.
.SS "\fBnetsnmp_row_merge_status\fP* netsnmp_row_merge_status_get (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, int create_missing)"
.PP
retrieve row_merge_status
.PP
Definition at line 67 of file row_merge.c.
-.PP
-References netsnmp_agent_add_list_data(), netsnmp_agent_get_list_data(), netsnmp_create_data_list(), NULL, snmp_log(), and SNMP_MALLOC_TYPEDEF.
-.PP
-Referenced by netsnmp_row_merge_helper_handler(), netsnmp_row_merge_status_first(), and netsnmp_row_merge_status_last().
.SS "int netsnmp_row_merge_status_last (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo)"
.PP
-Determine if this is the last row.
-.PP
-returns 1 if this is the last row for this pass of the handler.
+Determine if this is the last row. returns 1 if this is the last row for this pass of the handler.
.PP
Definition at line 130 of file row_merge.c.
-.PP
-References netsnmp_row_merge_status_x::count, netsnmp_row_merge_status_x::current, netsnmp_row_merge_status_get(), NULL, and netsnmp_row_merge_status_x::rows.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_scalar.3 b/man/netsnmp_scalar.3
index cb1ed10..ded4781 100644
--- a/man/netsnmp_scalar.3
+++ b/man/netsnmp_scalar.3
@@ -1,10 +1,11 @@
-.TH "scalar" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "scalar" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-scalar \- Process scalars easily.
-
+scalar \-
.PP
+Process scalars easily.
+
.SS "Functions"
.in +1c
@@ -27,14 +28,11 @@
.SH "Detailed Description"
.PP
Process scalars easily.
-.PP
.SH "Function Documentation"
.PP
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_scalar_handler (void)"
.PP
-Creates a scalar handler calling netsnmp_create_handler with a handler name defaulted to 'scalar' and access method, netsnmp_scalar_helper_handler.
-.PP
-\fBReturns:\fP
+Creates a scalar handler calling netsnmp_create_handler with a handler name defaulted to 'scalar' and access method, netsnmp_scalar_helper_handler. \fBReturns:\fP
.RS 4
Returns a pointer to a netsnmp_mib_handler struct which contains the handler's name and the access method
.RE
@@ -49,15 +47,9 @@
.PP
Definition at line 46 of file scalar.c.
-.PP
-References netsnmp_create_handler(), and netsnmp_scalar_helper_handler().
-.PP
-Referenced by netsnmp_register_read_only_scalar(), netsnmp_register_scalar(), and netsnmp_register_scalar_group().
.SS "int netsnmp_register_read_only_scalar (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
-This function registers a read only scalar helper handler.
-.PP
-This function is very similar to netsnmp_register_scalar the only addition is that the 'read_only' handler is injected into the handler chain prior to injecting the serialize handler and registering reginfo.
+This function registers a read only scalar helper handler. This function is very similar to netsnmp_register_scalar the only addition is that the 'read_only' handler is injected into the handler chain prior to injecting the serialize handler and registering reginfo.
.PP
\fBParameters:\fP
.RS 4
@@ -79,13 +71,9 @@
.PP
Definition at line 109 of file scalar.c.
-.PP
-References netsnmp_get_instance_handler(), netsnmp_get_read_only_handler(), netsnmp_get_scalar_handler(), netsnmp_inject_handler(), netsnmp_register_serialize(), netsnmp_handler_registration_s::rootoid, and netsnmp_handler_registration_s::rootoid_len.
.SS "int netsnmp_register_scalar (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
-This function registers a scalar helper handler.
-.PP
-The registered OID, reginfo->rootoid, space is extended for the instance subid using realloc() but the reginfo->rootoid_len length is not extended just yet. .This function subsequently injects the instance, scalar, and serialize helper handlers before actually registering reginfo.
+This function registers a scalar helper handler. The registered OID, reginfo->rootoid, space is extended for the instance subid using realloc() but the reginfo->rootoid_len length is not extended just yet. .This function subsequently injects the instance, scalar, and serialize helper handlers before actually registering reginfo.
.PP
Each handler is injected/pushed to the top of the handler chain list and will be processed last in first out, LIFO.
.PP
@@ -109,7 +97,6 @@
.PP
Definition at line 74 of file scalar.c.
-.PP
-References netsnmp_get_instance_handler(), netsnmp_get_scalar_handler(), netsnmp_inject_handler(), netsnmp_register_serialize(), netsnmp_handler_registration_s::rootoid, and netsnmp_handler_registration_s::rootoid_len.
-.PP
-Referenced by netsnmp_register_watched_scalar(), and netsnmp_watched_timestamp_register().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_scalar_group_group.3 b/man/netsnmp_scalar_group_group.3
index 60de05f..c9f7fe7 100644
--- a/man/netsnmp_scalar_group_group.3
+++ b/man/netsnmp_scalar_group_group.3
@@ -1,10 +1,11 @@
-.TH "scalar_group" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "scalar_group" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-scalar_group \- Process groups of scalars.
-
+scalar_group \-
.PP
+Process groups of scalars.
+
.SS "Functions"
.in +1c
@@ -21,5 +22,6 @@
.SH "Detailed Description"
.PP
Process groups of scalars.
-.PP
-
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_serialize.3 b/man/netsnmp_serialize.3
index 2b592cf..ce7789b 100644
--- a/man/netsnmp_serialize.3
+++ b/man/netsnmp_serialize.3
@@ -1,10 +1,11 @@
-.TH "serialize" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "serialize" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-serialize \- Calls sub handlers one request at a time.
-
+serialize \-
.PP
+Calls sub handlers one request at a time.
+
.SS "Functions"
.in +1c
@@ -28,7 +29,7 @@
.SH "Detailed Description"
.PP
Calls sub handlers one request at a time.
-.PP
+
This functionally passes in one request at a time into lower handlers rather than a whole bunch of requests at once. This is useful for handlers that don't want to iterate through the request lists themselves. Generally, this is probably less efficient so use with caution. The serialize handler might be useable to dynamically fix handlers with broken looping code, however.
.SH "Function Documentation"
.PP
@@ -37,32 +38,21 @@
returns a serialize handler that can be injected into a given handler chain.
.PP
Definition at line 31 of file serialize.c.
-.PP
-References netsnmp_create_handler(), and netsnmp_serialize_helper_handler().
-.PP
-Referenced by netsnmp_init_serialize(), and netsnmp_register_serialize().
.SS "void netsnmp_init_serialize (void)"
.PP
initializes the serialize helper which then registers a serialize handler as a run-time injectable handler for configuration file use.
.PP
Definition at line 93 of file serialize.c.
-.PP
-References netsnmp_get_serialize_handler(), and netsnmp_register_handler_by_name().
.SS "int netsnmp_register_serialize (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
functionally the same as calling \fBnetsnmp_register_handler()\fP but also injects a serialize handler at the same time for you.
.PP
Definition at line 40 of file serialize.c.
-.PP
-References netsnmp_get_serialize_handler(), netsnmp_inject_handler(), and netsnmp_register_handler().
-.PP
-Referenced by netsnmp_register_instance(), netsnmp_register_read_only_instance(), netsnmp_register_read_only_scalar(), netsnmp_register_scalar(), and netsnmp_register_scalar_group().
.SS "int netsnmp_serialize_helper_handler (\fBnetsnmp_mib_handler\fP * handler, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests)"
.PP
Implements the serial handler.
.PP
Definition at line 48 of file serialize.c.
-.PP
-References netsnmp_call_next_handler(), netsnmp_request_info_s::next, and NULL.
-.PP
-Referenced by netsnmp_get_serialize_handler().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_snmp_agent.3 b/man/netsnmp_snmp_agent.3
index e017752..0f01e02 100644
--- a/man/netsnmp_snmp_agent.3
+++ b/man/netsnmp_snmp_agent.3
@@ -1,4 +1,4 @@
-.TH "net-snmp agent related processing" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "net-snmp agent related processing" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -33,10 +33,10 @@
.in +1c
.ti -1c
-.RI "typedef \fB_agent_nsap\fP \fBagent_nsap\fP"
+.RI "typedef struct \fB_agent_nsap\fP \fBagent_nsap\fP"
.br
.ti -1c
-.RI "typedef \fBagent_set_cache_s\fP \fBagent_set_cache\fP"
+.RI "typedef struct \fBagent_set_cache_s\fP \fBagent_set_cache\fP"
.br
.in -1c
.SS "Enumerations"
@@ -122,6 +122,9 @@
.RI "void \fBnetsnmp_addrcache_initialise\fP (void)"
.br
.ti -1c
+.RI "void \fBnetsnmp_addrcache_destroy\fP (void)"
+.br
+.ti -1c
.RI "int \fBnetsnmp_addrcache_add\fP (const char *addr)"
.br
.ti -1c
@@ -167,7 +170,7 @@
.RI "void \fBnetsnmp_remove_and_free_agent_snmp_session\fP (\fBnetsnmp_agent_session\fP *asp)"
.br
.ti -1c
-.RI "void \fBnetsnmp_free_agent_snmp_session_by_session\fP (\fBnetsnmp_session\fP *sess, void(*free_request)(netsnmp_request_list *))"
+.RI "void \fBnetsnmp_free_agent_snmp_session_by_session\fP (\fBnetsnmp_session\fP *sess, void(*free_request)(\fBnetsnmp_request_list\fP *))"
.br
.ti -1c
.RI "int \fBhandle_snmp_packet\fP (int op, \fBnetsnmp_session\fP *session, int reqid, \fBnetsnmp_pdu\fP *pdu, void *magic)"
@@ -237,7 +240,7 @@
.br
.RI "\fIset error for all requests \fP"
.ti -1c
-.RI "u_long \fBnetsnmp_marker_uptime\fP (\fBmarker_t\fP pm)"
+.RI "u_long \fBnetsnmp_marker_uptime\fP (marker_t pm)"
.br
.ti -1c
.RI "u_long \fBnetsnmp_timeval_uptime\fP (struct timeval *tv)"
@@ -266,11 +269,11 @@
.ti -1c
.RI "int \fBnetsnmp_set_request_error\fP (\fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *request, int error_value)"
.br
-.RI "\fIdeprecated, use netsnmp_request_set_error instead \fP"
+.RI "\fIset error for a request \fP"
.ti -1c
.RI "int \fBnetsnmp_set_mode_request_error\fP (int mode, \fBnetsnmp_request_info\fP *request, int error_value)"
.br
-.RI "\fIdeprecated, use netsnmp_request_set_error instead \fP"
+.RI "\fIset error for a request \fP"
.ti -1c
.RI "int \fBnetsnmp_set_all_requests_error\fP (\fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *requests, int error_value)"
.br
@@ -283,7 +286,7 @@
.RI "oid \fBversion_sysoid\fP [] = { NETSNMP_SYSTEM_MIB }"
.br
.ti -1c
-.RI "int \fBversion_sysoid_len\fP = OID_LENGTH(\fBversion_sysoid\fP)"
+.RI "int \fBversion_sysoid_len\fP = OID_LENGTH(version_sysoid)"
.br
.ti -1c
.RI "int \fBlog_addresses\fP = 0"
@@ -304,7 +307,7 @@
.RI "\fBnetsnmp_session\fP * \fBmain_session\fP = NULL"
.br
.ti -1c
-.RI "timeval \fBstarttime\fP"
+.RI "struct timeval \fBstarttime\fP"
.br
.in -1c
.SH "Function Documentation"
@@ -313,16 +316,10 @@
.PP
set error for a request
.PP
-Definition at line 3395 of file snmp_agent.c.
-.PP
-References netsnmp_request_info_s::delegated, netsnmp_request_info_s::processed, REQUEST_IS_NOT_DELEGATED, netsnmp_request_info_s::requestvb, snmp_log(), netsnmp_request_info_s::status, and variable_list::type.
-.PP
-Referenced by netsnmp_request_set_error(), netsnmp_request_set_error_all(), netsnmp_request_set_error_idx(), netsnmp_set_mode_request_error(), and netsnmp_set_request_error().
+Definition at line 3414 of file snmp_agent.c.
.SS "int agent_check_and_process (int block)"
.PP
-This function checks for packets arriving on the SNMP port and processes them(snmp_read) if some are found, using the select().
-.PP
-If block is non zero, the function call blocks until a packet arrives
+This function checks for packets arriving on the SNMP port and processes them(snmp_read) if some are found, using the select(). If block is non zero, the function call blocks until a packet arrives
.PP
\fBParameters:\fP
.RS 4
@@ -337,35 +334,19 @@
.PP
Definition at line 566 of file snmp_agent.c.
-.PP
-References FD_ZERO, netsnmp_check_outstanding_agent_requests(), NULL, run_alarms(), snmp_log(), snmp_log_perror(), snmp_read(), snmp_select_info(), and snmp_timeout().
.SS "int check_getnext_results (\fBnetsnmp_agent_session\fP * asp)"
.PP
-returns 1 if there are valid GETNEXT requests left.
+returns 1 if there are valid GETNEXT requests left. Returns 0 if not.
.PP
-Returns 0 if not.
-.PP
-Definition at line 2796 of file snmp_agent.c.
-.PP
-References netsnmp_request_info_s::inclusive, netsnmp_request_info_s::index, netsnmp_agent_session_s::mode, variable_list::name, variable_list::name_length, netsnmp_request_info_s::next, NULL, netsnmp_agent_session_s::oldmode, netsnmp_request_info_s::range_end, netsnmp_request_info_s::range_end_len, netsnmp_request_info_s::requestvb, snmp_oid_compare(), snmp_set_var_objid(), snmp_set_var_typed_value(), netsnmp_agent_session_s::treecache, netsnmp_agent_session_s::treecache_num, and variable_list::type.
-.PP
-Referenced by handle_getnext_loop().
+Definition at line 2815 of file snmp_agent.c.
.SS "int handle_getnext_loop (\fBnetsnmp_agent_session\fP * asp)"
.PP
-repeatedly calls getnext handlers looking for an answer till all requests are satisified.
+repeatedly calls getnext handlers looking for an answer till all requests are satisified. It's expected that one pass has been made before entering this function
.PP
-It's expected that one pass has been made before entering this function
-.PP
-Definition at line 2913 of file snmp_agent.c.
-.PP
-References check_acm(), check_getnext_results(), handle_var_requests(), netsnmp_check_for_delegated(), netsnmp_reassign_requests(), netsnmp_running, and variable_list::next_variable.
-.PP
-Referenced by check_delayed_request(), and handle_pdu().
+Definition at line 2932 of file snmp_agent.c.
.SS "int handle_pdu (\fBnetsnmp_agent_session\fP * asp)"
.PP
-This function calls into netsnmp_set_mode_request_error, sets error_value given a reqinfo->mode value.
-.PP
-It's used to send specific errors back to the agent to process accordingly.
+This function calls into netsnmp_set_mode_request_error, sets error_value given a reqinfo->mode value. It's used to send specific errors back to the agent to process accordingly.
.PP
If error_value is set to SNMP_NOSUCHOBJECT, SNMP_NOSUCHINSTANCE, or SNMP_ENDOFMIBVIEW the following is applicable: Sets the error_value to request->requestvb->type if reqinfo->mode value is set to MODE_GET. If the reqinfo->mode value is set to MODE_GETNEXT or MODE_GETBULK the code calls snmp_log logging an error message.
.PP
@@ -432,45 +413,32 @@
.PP
.PP
-Definition at line 3207 of file snmp_agent.c.
-.PP
-References check_acm(), snmp_pdu::command, count_varbinds(), snmp_pdu::flags, get_set_cache(), handle_getnext_loop(), handle_set_loop(), handle_var_requests(), netsnmp_agent_session_s::mode, netsnmp_create_subtree_cache(), variable_list::next_variable, NULL, netsnmp_agent_session_s::oldmode, netsnmp_agent_session_s::pdu, netsnmp_agent_session_s::requests, snmp_increment_statistic(), snmp_replace_var_types(), snmp_set_var_typed_value(), netsnmp_agent_session_s::status, variable_list::type, snmp_pdu::variables, and netsnmp_agent_session_s::vbcount.
-.PP
-Referenced by netsnmp_handle_request().
+Definition at line 3226 of file snmp_agent.c.
.SS "int handle_snmp_packet (int op, \fBnetsnmp_session\fP * session, int reqid, \fBnetsnmp_pdu\fP * pdu, void * magic)"
.PP
handles an incoming SNMP packet into the agent
.PP
-Definition at line 1754 of file snmp_agent.c.
-.PP
-References check_access(), snmp_pdu::command, snmp_pdu::errstat, init_agent_snmp_session(), netsnmp_handle_request(), netsnmp_remove_and_free_agent_snmp_session(), NULL, netsnmp_agent_session_s::pdu, snmp_session::s_snmp_errno, send_easy_trap(), netsnmp_agent_session_s::session, snmp_free_pdu(), snmp_increment_statistic(), snmp_send(), netsnmp_agent_session_s::status, and snmp_pdu::version.
-.PP
-Referenced by netsnmp_register_agent_nsap().
+Definition at line 1771 of file snmp_agent.c.
.SS "\fBnetsnmp_request_info\fP* netsnmp_add_varbind_to_cache (\fBnetsnmp_agent_session\fP * asp, int vbcount, \fBnetsnmp_variable_list\fP * varbind_ptr, \fBnetsnmp_subtree\fP * tp)"
.PP
-Definition at line 1863 of file snmp_agent.c.
+\fBTodo\fP
+.RS 4
+make this be more intelligent about ranges. Right now we merely take the highest level commonality of a registration range and use that. At times we might be able to be smarter about checking the range itself as opposed to the \fBnode\fP above where the range exists, but I doubt this will come up all that frequently.
+.RE
.PP
-References netsnmp_request_info_s::agent_req_info, netsnmp_agent_session_s::cache_store, netsnmp_subtree_s::cacheid, snmp_pdu::command, netsnmp_request_info_s::delegated, netsnmp_subtree_s::end_a, netsnmp_subtree_s::end_len, netsnmp_subtree_s::global_cacheid, netsnmp_request_info_s::inclusive, netsnmp_request_info_s::index, variable_list::name, variable_list::name_length, netsnmp_acm_check_subtree(), netsnmp_free_request_data_sets(), netsnmp_get_local_cachid(), netsnmp_get_or_add_local_cachid(), netsnmp_oid_find_prefix(), netsnmp_request_info_s::next, netsnmp_subtree_s::next, NULL, netsnmp_request_info_s::parent_data, netsnmp_agent_session_s::pdu, netsnmp_request_info_s::prev, netsnmp_request_info_s::processed, netsnmp_request_info_s::range_end, netsnmp_request_info_s::range_end_len, netsnmp_agent_session_s::reqinfo, netsnmp_agent_session_s::requests, netsnmp_tree_cache_s::requests_begin, netsnmp_tree_cache_s::requests_end, netsnmp_request_info_s::requestvb, netsnmp_request_info_s::requestvb_start, netsnmp_subtree_s::start_a, netsnmp_subtree_s::start_len, netsnmp_request_info_s::status, netsnmp_tree_cache_s::subtree, netsnmp_request_info_s::subtree, netsnmp_agent_session_s::treecache, netsnmp_agent_session_s::treecache_len, netsnmp_agent_session_s::treecache_num, and variable_list::type.
+
.PP
-Referenced by netsnmp_create_subtree_cache(), and netsnmp_reassign_requests().
+Definition at line 1880 of file snmp_agent.c.
.SS "int netsnmp_check_transaction_id (int transaction_id)"
.PP
-Decide if the requested transaction_id is still being processed within the agent.
-.PP
-This is used to validate whether a delayed cache (containing possibly freed pointers) is still usable.
+Decide if the requested transaction_id is still being processed within the agent. This is used to validate whether a delayed cache (containing possibly freed pointers) is still usable.
.PP
returns SNMPERR_SUCCESS if it's still valid, or SNMPERR_GENERR if not.
.PP
-Definition at line 2699 of file snmp_agent.c.
-.PP
-References agent_delegated_list, netsnmp_agent_session_s::next, and NULL.
-.PP
-Referenced by check_delayed_request(), and netsnmp_handler_check_cache().
+Definition at line 2718 of file snmp_agent.c.
.SS "int netsnmp_request_set_error (\fBnetsnmp_request_info\fP * request, int error_value)"
.PP
-set error for a request
-.PP
-\fBParameters:\fP
+set error for a request \fBParameters:\fP
.RS 4
\fIrequest\fP request which has error
.br
@@ -479,16 +447,10 @@
.PP
.PP
-Definition at line 3463 of file snmp_agent.c.
-.PP
-References _request_set_error(), netsnmp_request_info_s::agent_req_info, and netsnmp_agent_request_info_s::mode.
-.PP
-Referenced by netsnmp_remove_delegated_requests_for_session().
+Definition at line 3482 of file snmp_agent.c.
.SS "NETSNMP_INLINE int netsnmp_request_set_error_all (\fBnetsnmp_request_info\fP * requests, int error)"
.PP
-set error for all requests
-.PP
-\fBParameters:\fP
+set error for all requests \fBParameters:\fP
.RS 4
\fIrequests\fP request list
.br
@@ -504,16 +466,10 @@
.PP
paranoid sanity checks
.PP
-Definition at line 3506 of file snmp_agent.c.
-.PP
-References _request_set_error(), netsnmp_request_info_s::agent_req_info, netsnmp_agent_request_info_s::mode, netsnmp_request_info_s::next, NULL, and snmp_log().
-.PP
-Referenced by netsnmp_cache_helper_handler(), netsnmp_multiplexer_helper_handler(), netsnmp_read_only_helper(), and netsnmp_set_all_requests_error().
+Definition at line 3525 of file snmp_agent.c.
.SS "int netsnmp_request_set_error_idx (\fBnetsnmp_request_info\fP * request, int error_value, int idx)"
.PP
-set error for a request within a request list
-.PP
-\fBParameters:\fP
+set error for a request within a request list \fBParameters:\fP
.RS 4
\fIrequest\fP head of the request list
.br
@@ -524,14 +480,10 @@
.PP
.PP
-Definition at line 3478 of file snmp_agent.c.
-.PP
-References _request_set_error(), netsnmp_request_info_s::agent_req_info, netsnmp_agent_request_info_s::mode, and netsnmp_request_info_s::next.
+Definition at line 3497 of file snmp_agent.c.
.SS "int netsnmp_set_all_requests_error (\fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests, int error_value)"
.PP
-set error for all request
-.PP
-\fBDeprecated\fP
+set error for all request \fBDeprecated\fP
.RS 4
use netsnmp_request_set_error_all
.RE
@@ -552,12 +504,10 @@
.PP
.PP
-Definition at line 3680 of file snmp_agent.c.
-.PP
-References netsnmp_request_set_error_all().
+Definition at line 3699 of file snmp_agent.c.
.SS "int netsnmp_set_mode_request_error (int mode, \fBnetsnmp_request_info\fP * request, int error_value)"
.PP
-deprecated, use netsnmp_request_set_error instead
+set error for a request deprecated, use netsnmp_request_set_error instead
.PP
\fBDeprecated\fP
.RS 4
@@ -580,12 +530,10 @@
.PP
.PP
-Definition at line 3664 of file snmp_agent.c.
-.PP
-References _request_set_error().
+Definition at line 3683 of file snmp_agent.c.
.SS "int netsnmp_set_request_error (\fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * request, int error_value)"
.PP
-deprecated, use netsnmp_request_set_error instead
+set error for a request deprecated, use netsnmp_request_set_error instead
.PP
\fBDeprecated\fP
.RS 4
@@ -612,15 +560,12 @@
.in +1c
\fBdelayed_instance.c\fP.
.PP
-Definition at line 3645 of file snmp_agent.c.
-.PP
-References _request_set_error(), and netsnmp_agent_request_info_s::mode.
-.PP
-Referenced by netsnmp_call_handlers(), netsnmp_instance_counter32_handler(), netsnmp_instance_helper_handler(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_num_file_handler(), netsnmp_instance_uint_handler(), netsnmp_instance_ulong_handler(), netsnmp_scalar_group_helper_handler(), netsnmp_scalar_helper_handler(), netsnmp_table_data_set_helper_handler(), netsnmp_watched_spinlock_handler(), netsnmp_watched_timestamp_handler(), netsnmp_watcher_helper_handler(), and table_helper_handler().
+Definition at line 3664 of file snmp_agent.c.
.SS "int netsnmp_wrap_up_request (\fBnetsnmp_agent_session\fP * asp, int status)"
.PP
-Definition at line 1501 of file snmp_agent.c.
+if asp->pdu
.PP
-References _fix_endofmibview(), _reorder_getbulk(), snmp_pdu::command, count_varbinds(), snmp_pdu::errindex, snmp_pdu::errstat, netsnmp_agent_session_s::index, variable_list::name, variable_list::name_length, netsnmp_processing_set, netsnmp_remove_and_free_agent_snmp_session(), variable_list::next_variable, NULL, netsnmp_agent_session_s::orig_pdu, netsnmp_agent_session_s::pdu, save_set_cache(), netsnmp_agent_session_s::session, SNMP_FREE, snmp_free_pdu(), snmp_increment_statistic(), snmp_increment_statistic_by(), snmp_log(), snmp_perror(), snmp_send(), sprint_realloc_objid(), netsnmp_agent_session_s::status, variable_list::type, snmp_pdu::variables, and snmp_pdu::version.
-.PP
-Referenced by check_delayed_request(), and netsnmp_handle_request().
+Definition at line 1518 of file snmp_agent.c.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_snmp_alarm.3 b/man/netsnmp_snmp_alarm.3
index 169535c..33e08af 100644
--- a/man/netsnmp_snmp_alarm.3
+++ b/man/netsnmp_snmp_alarm.3
@@ -1,4 +1,4 @@
-.TH "snmp_alarm" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "snmp_alarm" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -10,7 +10,7 @@
.in +1c
.ti -1c
-.RI "timeval \fBt\fP"
+.RI "struct timeval \fBt\fP"
.br
.ti -1c
.RI "unsigned int \fBflags\fP"
@@ -19,10 +19,10 @@
.RI "unsigned int \fBclientreg\fP"
.br
.ti -1c
-.RI "timeval \fBt_last\fP"
+.RI "struct timeval \fBt_last\fP"
.br
.ti -1c
-.RI "timeval \fBt_next\fP"
+.RI "struct timeval \fBt_next\fP"
.br
.ti -1c
.RI "void * \fBclientarg\fP"
@@ -31,7 +31,7 @@
.RI "SNMPAlarmCallback * \fBthecallback\fP"
.br
.ti -1c
-.RI "\fBsnmp_alarm\fP * \fBnext\fP"
+.RI "struct \fBsnmp_alarm\fP * \fBnext\fP"
.br
.in -1c
.SH "Detailed Description"
diff --git a/man/netsnmp_snmp_client.3 b/man/netsnmp_snmp_client.3
index 66933d4..56a8d92 100644
--- a/man/netsnmp_snmp_client.3
+++ b/man/netsnmp_snmp_client.3
@@ -1,37 +1,8 @@
-.TH "various PDU processing routines" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "various PDU processing routines" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
various PDU processing routines \-
-.SS "Defines"
-
-.in +1c
-.ti -1c
-.RI "#define \fBBSD4_2\fP"
-.br
-.ti -1c
-.RI "#define \fBNFDBITS\fP (sizeof(\fBfd_mask\fP) * NBBY)"
-.br
-.ti -1c
-.RI "#define \fBFD_SET\fP(n, p) ((p)->fds_bits[(n)/NFDBITS] |= (1 << ((n) % NFDBITS)))"
-.br
-.ti -1c
-.RI "#define \fBFD_CLR\fP(n, p) ((p)->fds_bits[(n)/NFDBITS] &= ~(1 << ((n) % NFDBITS)))"
-.br
-.ti -1c
-.RI "#define \fBFD_ISSET\fP(n, p) ((p)->fds_bits[(n)/NFDBITS] & (1 << ((n) % NFDBITS)))"
-.br
-.ti -1c
-.RI "#define \fBFD_ZERO\fP(p) memset((p), 0, sizeof(*(p)))"
-.br
-.in -1c
-.SS "Typedefs"
-
-.in +1c
-.ti -1c
-.RI "typedef long \fBfd_mask\fP"
-.br
-.in -1c
.SS "Functions"
.in +1c
@@ -131,9 +102,7 @@
.PP
.SS "int snmp_set_var_typed_value (\fBnetsnmp_variable_list\fP * newvar, u_char type, const u_char * val_str, size_t val_len)"
.PP
-snmp_set_var_typed_value is used to set data into the netsnmp_variable_list structure.
-.PP
-Used to return data to the snmp request via the netsnmp_request_info structure's requestvb pointer.
+snmp_set_var_typed_value is used to set data into the netsnmp_variable_list structure. Used to return data to the snmp request via the netsnmp_request_info structure's requestvb pointer.
.PP
\fBParameters:\fP
.RS 4
@@ -157,15 +126,12 @@
.in +1c
\fBdelayed_instance.c\fP.
.PP
-Definition at line 686 of file snmp_client.c.
-.PP
-References snmp_set_var_value(), and variable_list::type.
-.PP
-Referenced by _reorder_getbulk(), check_getnext_results(), handle_pdu(), netsnmp_check_getnext_reply(), netsnmp_create_subtree_cache(), netsnmp_instance_counter32_handler(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_num_file_handler(), netsnmp_instance_uint_handler(), netsnmp_instance_ulong_handler(), netsnmp_stash_cache_helper(), netsnmp_table_build_result(), netsnmp_table_data_build_result(), netsnmp_watched_timestamp_handler(), netsnmp_watcher_helper_handler(), snmp_replace_var_types(), and snmp_reset_var_types().
+Definition at line 687 of file snmp_client.c.
.SS "int snmp_set_var_value (\fBnetsnmp_variable_list\fP * vars, const u_char * value, size_t len)"
.PP
-Definition at line 753 of file snmp_client.c.
+FALL THROUGH
.PP
-References variable_list::buf, netsnmp_vardata::counter64, netsnmp_vardata::integer, NULL, netsnmp_vardata::objid, snmp_log(), snmp_set_detail(), netsnmp_vardata::string, variable_list::type, variable_list::val, and variable_list::val_len.
-.PP
-Referenced by parse_one_oid_index(), snmp_set_var_typed_integer(), snmp_set_var_typed_value(), and snmp_varlist_add_variable().
+Definition at line 754 of file snmp_client.c.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_snmp_logging.3 b/man/netsnmp_snmp_logging.3
index 2e200d3..382c9c0 100644
--- a/man/netsnmp_snmp_logging.3
+++ b/man/netsnmp_snmp_logging.3
@@ -1,4 +1,4 @@
-.TH "generic logging for net-snmp" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "generic logging for net-snmp" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -13,39 +13,6 @@
.RI "#define \fBva_copy\fP(dest, src) memcpy (&dest, &src, sizeof (va_list))"
.br
.ti -1c
-.RI "#define \fBLOG_CONS\fP 0"
-.br
-.ti -1c
-.RI "#define \fBLOG_PID\fP 0"
-.br
-.ti -1c
-.RI "#define \fBLOG_LOCAL0\fP 0"
-.br
-.ti -1c
-.RI "#define \fBLOG_LOCAL1\fP 0"
-.br
-.ti -1c
-.RI "#define \fBLOG_LOCAL2\fP 0"
-.br
-.ti -1c
-.RI "#define \fBLOG_LOCAL3\fP 0"
-.br
-.ti -1c
-.RI "#define \fBLOG_LOCAL4\fP 0"
-.br
-.ti -1c
-.RI "#define \fBLOG_LOCAL5\fP 0"
-.br
-.ti -1c
-.RI "#define \fBLOG_LOCAL6\fP 0"
-.br
-.ti -1c
-.RI "#define \fBLOG_LOCAL7\fP 0"
-.br
-.ti -1c
-.RI "#define \fBLOG_DAEMON\fP 0"
-.br
-.ti -1c
.RI "#define \fBLOG_USER\fP 0"
.br
.in -1c
@@ -65,7 +32,7 @@
.RI "void \fBshutdown_snmp_logging\fP (void)"
.br
.ti -1c
-.RI "int \fBdecode_priority\fP (char *optarg, int *pri_max)"
+.RI "int \fBdecode_priority\fP (char **optarg, int *pri_max)"
.br
.ti -1c
.RI "int \fBdecode_facility\fP (char *optarg)"
@@ -164,11 +131,11 @@
.ti -1c
.RI "int \fBsnmp_vlog\fP (int priority, const char *format, va_list ap)"
.br
-.RI "\fIThis snmp logging function allows variable argument list given the specified priority, format and a populated va_list structure. \fP"
+.RI "\fIThis snmp logging function allows \fBvariable\fP argument list given the specified priority, format and a populated va_list structure. \fP"
.ti -1c
.RI "int \fBsnmp_log\fP (int priority, const char *format,...)"
.br
-.RI "\fIThis snmp logging function allows variable argument list given the specified format and priority. \fP"
+.RI "\fIThis snmp logging function allows \fBvariable\fP argument list given the specified format and priority. \fP"
.ti -1c
.RI "void \fBsnmp_log_perror\fP (const char *s)"
.br
@@ -190,30 +157,22 @@
.PP
.SS "void netsnmp_logging_restart (void)"
.PP
-Definition at line 616 of file snmp_logging.c.
+hmm, don't zero status isn't saved.. i think it's safer not to overwrite, in case a hup is just to re-read config files...
.PP
-References netsnmp_log_handler_s::enabled, logh_head, netsnmp_enable_filelog(), netsnmp_log_handler_s::next, snmp_disable_filelog_entry(), snmp_disable_syslog_entry(), snmp_enable_syslog_ident(), and netsnmp_log_handler_s::type.
+Definition at line 636 of file snmp_logging.c.
.SS "int snmp_get_do_logging (void)"
.PP
-Is logging done?
-.PP
-\fBReturns:\fP
+Is logging done? \fBReturns:\fP
.RS 4
Returns 0 if logging is off, 1 when it is done.
.RE
.PP
.PP
-Definition at line 473 of file snmp_logging.c.
-.PP
-References netsnmp_log_handler_s::enabled, logh_head, and netsnmp_log_handler_s::next.
-.PP
-Referenced by netsnmp_agent_check_parse().
+Definition at line 493 of file snmp_logging.c.
.SS "int snmp_log (int priority, const char * format, ...)"
.PP
-This snmp logging function allows variable argument list given the specified format and priority.
-.PP
-Calls the snmp_vlog function. The default logfile this function writes to is /var/log/snmpd.log.
+This snmp logging function allows \fBvariable\fP argument list given the specified format and priority. Calls the snmp_vlog function. The default logfile this function writes to is /var/log/snmpd.log.
.PP
\fBSee also:\fP
.RS 4
@@ -226,16 +185,10 @@
.in +1c
\fBdelayed_instance.c\fP.
.PP
-Definition at line 1255 of file snmp_logging.c.
-.PP
-References snmp_vlog().
-.PP
-Referenced by _callback_lock(), _request_set_error(), _sess_read(), agent_check_and_process(), config_perror(), config_pwarn(), convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), copy_word(), create_trap_session(), init_agent(), init_master_agent(), netsnmp_addrcache_add(), netsnmp_agent_check_packet(), netsnmp_agent_check_parse(), netsnmp_baby_steps_handler_get(), netsnmp_cache_create(), netsnmp_cache_helper_handler(), netsnmp_cache_timer_start(), netsnmp_cache_timer_stop(), netsnmp_call_handler(), netsnmp_call_handlers(), netsnmp_call_next_handler(), netsnmp_call_next_handler_one_request(), netsnmp_config_parse_add_row(), netsnmp_config_parse_table_set(), netsnmp_container_get_null(), netsnmp_container_iterator_get(), netsnmp_container_table_handler_get(), netsnmp_container_table_register(), netsnmp_data_list_add_data(), netsnmp_data_list_add_node(), netsnmp_ds_handle_config(), netsnmp_get_multiplexer_handler(), netsnmp_get_table_data_handler(), netsnmp_get_table_data_set_handler(), netsnmp_get_table_handler(), netsnmp_get_tdata_handler(), netsnmp_inject_handler_before(), netsnmp_instance_counter32_handler(), netsnmp_mark_row_column_writable(), netsnmp_multiplexer_helper_handler(), netsnmp_read_data_callback(), netsnmp_register_handler(), netsnmp_register_handler_nocallback(), netsnmp_register_mib(), netsnmp_register_num_file_instance(), netsnmp_register_save_list(), netsnmp_request_set_error_all(), netsnmp_row_merge_status_get(), netsnmp_save_all_data_callback(), netsnmp_send_traps(), netsnmp_sess_log_error(), netsnmp_set_row_column(), netsnmp_table_container_register(), netsnmp_table_data_add_row(), netsnmp_table_data_set_helper_handler(), netsnmp_table_iterator_helper_handler(), netsnmp_table_row_handler_get(), netsnmp_table_row_register(), netsnmp_table_set_add_default_row(), netsnmp_tdata_add_row(), netsnmp_wrap_up_request(), read_config_files(), read_config_print_usage(), read_config_read_octet_string(), read_config_store(), register_signal(), snmp_build(), snmp_clean_persistent(), snmp_log_perror(), snmp_pdu_parse(), snmp_perror(), snmp_save_persistent(), snmp_set_var_value(), snmpd_parse_config_authtrap(), snmpv3_make_report(), snmpv3_packet_build(), snmpv3_parse(), and table_helper_handler().
+Definition at line 1275 of file snmp_logging.c.
.SS "int snmp_vlog (int priority, const char * format, va_list ap)"
.PP
-This snmp logging function allows variable argument list given the specified priority, format and a populated va_list structure.
-.PP
-The default logfile this function writes to is /var/log/snmpd.log.
+This snmp logging function allows \fBvariable\fP argument list given the specified priority, format and a populated va_list structure. The default logfile this function writes to is /var/log/snmpd.log.
.PP
\fBParameters:\fP
.RS 4
@@ -270,7 +223,7 @@
.PP
.br
-\fIformat\fP is a pointer to a char representing the variable argument list format used.
+\fIformat\fP is a pointer to a char representing the \fBvariable\fP argument list format used.
.br
\fIap\fP is a va_list type used to traverse the list of arguments.
.RE
@@ -287,8 +240,7 @@
.PP
.PP
-Definition at line 1194 of file snmp_logging.c.
-.PP
-References LOGLENGTH, NULL, snmp_log_string(), va_copy, and vsnprintf().
-.PP
-Referenced by snmp_log().
+Definition at line 1214 of file snmp_logging.c.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_snmp_pdu.3 b/man/netsnmp_snmp_pdu.3
index 09d5d05..1351954 100644
--- a/man/netsnmp_snmp_pdu.3
+++ b/man/netsnmp_snmp_pdu.3
@@ -1,15 +1,16 @@
-.TH "snmp_pdu" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "snmp_pdu" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-snmp_pdu \- The snmp protocol data unit.
-
+snmp_pdu \-
.PP
+The snmp protocol data unit.
+
.SH SYNOPSIS
.br
.PP
-\fC#include <snmp_api.h>\fP
.PP
+\fC#include <snmp_api.h>\fP
.SS "Data Fields"
.in +1c
@@ -155,192 +156,136 @@
Definition at line 75 of file snmp_api.h.
.SH "Field Documentation"
.PP
-.SS "long \fBsnmp_pdu::version\fP"
-.PP
-snmp version
-.PP
-Definition at line 81 of file snmp_api.h.
-.PP
-Referenced by check_access(), handle_snmp_packet(), in_a_view(), netsnmp_acm_check_subtree(), netsnmp_wrap_up_request(), send_trap_to_sess(), snmp_pdu_create(), and snmpv3_parse().
-.SS "int \fBsnmp_pdu::command\fP"
-.PP
-Type of this PDU.
-.PP
-Definition at line 83 of file snmp_api.h.
-.PP
-Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), handle_pdu(), handle_snmp_packet(), netsnmp_add_varbind_to_cache(), netsnmp_agent_check_parse(), netsnmp_check_outstanding_agent_requests(), netsnmp_create_subtree_cache(), netsnmp_handle_request(), netsnmp_wrap_up_request(), save_set_cache(), send_trap_to_sess(), snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), snmp_pdu_parse(), snmpv3_make_report(), and snmpv3_scopedPDU_parse().
-.SS "long \fBsnmp_pdu::reqid\fP"
-.PP
-Request id - note: not incremented on retries.
-.PP
-Definition at line 85 of file snmp_api.h.
-.PP
-Referenced by snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), and snmp_pdu_parse().
-.SS "long \fBsnmp_pdu::msgid\fP"
-.PP
-Message id for V3 messages note: incremented for each retry.
-.PP
-Definition at line 87 of file snmp_api.h.
-.PP
-Referenced by snmp_fix_pdu(), snmp_pdu_create(), and snmpv3_parse().
-.SS "long \fBsnmp_pdu::transid\fP"
-.PP
-Unique ID for incoming transactions.
-.PP
-Definition at line 89 of file snmp_api.h.
-.PP
-Referenced by check_delayed_request(), get_set_cache(), netsnmp_create_delegated_cache(), and save_set_cache().
-.SS "long \fBsnmp_pdu::sessid\fP"
-.PP
-Session id for AgentX messages.
-.PP
-Definition at line 91 of file snmp_api.h.
-.PP
-Referenced by send_trap_to_sess().
-.SS "long \fBsnmp_pdu::errstat\fP"
-.PP
-Error status (non_repeaters in GetBulk).
-.PP
-Definition at line 93 of file snmp_api.h.
-.PP
-Referenced by _reorder_getbulk(), handle_snmp_packet(), netsnmp_agent_check_parse(), netsnmp_create_subtree_cache(), netsnmp_wrap_up_request(), snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), snmp_pdu_parse(), and snmpv3_make_report().
-.SS "long \fBsnmp_pdu::errindex\fP"
-.PP
-Error index (max_repetitions in GetBulk).
-.PP
-Definition at line 95 of file snmp_api.h.
-.PP
-Referenced by _reorder_getbulk(), netsnmp_agent_check_parse(), netsnmp_create_subtree_cache(), netsnmp_wrap_up_request(), snmp_fix_pdu(), snmp_pdu_build(), snmp_pdu_create(), snmp_pdu_parse(), and snmpv3_make_report().
-.SS "u_long \fBsnmp_pdu::time\fP"
-.PP
-Uptime.
-.PP
-Definition at line 97 of file snmp_api.h.
-.PP
-Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), snmp_pdu_create(), and snmp_pdu_parse().
-.SS "int \fBsnmp_pdu::securityLevel\fP"
-.PP
-noAuthNoPriv, authNoPriv, authPriv
-.PP
-Definition at line 102 of file snmp_api.h.
-.PP
-Referenced by snmpv3_make_report(), snmpv3_packet_build(), and snmpv3_parse().
-.SS "void* \fBsnmp_pdu::transport_data\fP"
-.PP
-Transport-specific opaque data.
-.PP
-This replaces the IP-centric address field.
-.PP
-Definition at line 110 of file snmp_api.h.
-.PP
-Referenced by snmp_create_sess_pdu(), snmp_free_pdu(), and snmp_pdu_create().
-.SS "const oid* \fBsnmp_pdu::tDomain\fP"
-.PP
-The actual transport domain.
-.PP
-This SHOULD NOT BE FREE()D.
-.PP
-Definition at line 117 of file snmp_api.h.
-.PP
-Referenced by snmp_create_sess_pdu().
-.SS "u_char* \fBsnmp_pdu::community\fP"
-.PP
-community for outgoing requests.
-.PP
-Definition at line 127 of file snmp_api.h.
-.PP
-Referenced by convert_v1pdu_to_v2(), and snmp_free_pdu().
-.SS "size_t \fBsnmp_pdu::community_len\fP"
-.PP
-length of community name.
-.PP
-Definition at line 129 of file snmp_api.h.
-.PP
-Referenced by convert_v1pdu_to_v2().
-.SS "oid* \fBsnmp_pdu::enterprise\fP"
-.PP
-System OID.
-.PP
-Definition at line 135 of file snmp_api.h.
-.PP
-Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_free_pdu(), snmp_pdu_build(), and snmp_pdu_parse().
-.SS "long \fBsnmp_pdu::trap_type\fP"
-.PP
-trap type
-.PP
-Definition at line 138 of file snmp_api.h.
-.PP
-Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), and snmp_pdu_parse().
-.SS "long \fBsnmp_pdu::specific_type\fP"
-.PP
-specific type
-.PP
-Definition at line 140 of file snmp_api.h.
-.PP
-Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), and snmp_pdu_parse().
.SS "unsigned char \fBsnmp_pdu::agent_addr\fP[4]"
.PP
This is ONLY used for v1 TRAPs.
.PP
Definition at line 142 of file snmp_api.h.
+.SS "int \fBsnmp_pdu::command\fP"
.PP
-Referenced by convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), netsnmp_send_traps(), snmp_pdu_build(), and snmp_pdu_parse().
+Type of this PDU.
+.PP
+Definition at line 83 of file snmp_api.h.
+.SS "u_char* \fBsnmp_pdu::community\fP"
+.PP
+community for outgoing requests.
+.PP
+Definition at line 127 of file snmp_api.h.
+.SS "size_t \fBsnmp_pdu::community_len\fP"
+.PP
+length of community name.
+.PP
+Definition at line 129 of file snmp_api.h.
.SS "u_char* \fBsnmp_pdu::contextEngineID\fP"
.PP
context snmpEngineID
.PP
Definition at line 148 of file snmp_api.h.
-.PP
-Referenced by snmp_free_pdu(), snmpv3_make_report(), snmpv3_parse(), and snmpv3_scopedPDU_parse().
.SS "size_t \fBsnmp_pdu::contextEngineIDLen\fP"
.PP
Length of contextEngineID.
.PP
Definition at line 150 of file snmp_api.h.
-.PP
-Referenced by snmpv3_make_report(), snmpv3_parse(), and snmpv3_scopedPDU_parse().
.SS "char* \fBsnmp_pdu::contextName\fP"
.PP
authoritative contextName
.PP
Definition at line 152 of file snmp_api.h.
-.PP
-Referenced by netsnmp_create_subtree_cache(), snmp_free_pdu(), snmpv3_make_report(), and snmpv3_scopedPDU_parse().
.SS "size_t \fBsnmp_pdu::contextNameLen\fP"
.PP
Length of contextName.
.PP
Definition at line 154 of file snmp_api.h.
+.SS "oid* \fBsnmp_pdu::enterprise\fP"
.PP
-Referenced by snmp_pdu_create(), snmpv3_make_report(), and snmpv3_scopedPDU_parse().
+System OID.
+.PP
+Definition at line 135 of file snmp_api.h.
+.SS "long \fBsnmp_pdu::errindex\fP"
+.PP
+Error index (max_repetitions in GetBulk).
+.PP
+Definition at line 95 of file snmp_api.h.
+.SS "long \fBsnmp_pdu::errstat\fP"
+.PP
+Error status (non_repeaters in GetBulk).
+.PP
+Definition at line 93 of file snmp_api.h.
+.SS "long \fBsnmp_pdu::msgid\fP"
+.PP
+Message id for V3 messages note: incremented for each retry.
+.PP
+Definition at line 87 of file snmp_api.h.
+.SS "long \fBsnmp_pdu::reqid\fP"
+.PP
+Request id - note: not incremented on retries.
+.PP
+Definition at line 85 of file snmp_api.h.
.SS "u_char* \fBsnmp_pdu::securityEngineID\fP"
.PP
authoritative snmpEngineID for security
.PP
Definition at line 156 of file snmp_api.h.
-.PP
-Referenced by send_trap_to_sess(), snmp_free_pdu(), snmpv3_make_report(), snmpv3_packet_build(), snmpv3_parse(), and snmpv3_scopedPDU_parse().
.SS "size_t \fBsnmp_pdu::securityEngineIDLen\fP"
.PP
Length of securityEngineID.
.PP
Definition at line 158 of file snmp_api.h.
+.SS "int \fBsnmp_pdu::securityLevel\fP"
.PP
-Referenced by send_trap_to_sess(), snmpv3_make_report(), snmpv3_packet_build(), snmpv3_parse(), and snmpv3_scopedPDU_parse().
+noAuthNoPriv, authNoPriv, authPriv
+.PP
+Definition at line 102 of file snmp_api.h.
.SS "char* \fBsnmp_pdu::securityName\fP"
.PP
on behalf of this principal
.PP
Definition at line 160 of file snmp_api.h.
-.PP
-Referenced by snmp_free_pdu(), snmpv3_packet_build(), and snmpv3_parse().
.SS "size_t \fBsnmp_pdu::securityNameLen\fP"
.PP
Length of securityName.
.PP
Definition at line 162 of file snmp_api.h.
+.SS "long \fBsnmp_pdu::sessid\fP"
.PP
-Referenced by snmp_pdu_create(), snmpv3_packet_build(), and snmpv3_parse().
+Session id for AgentX messages.
+.PP
+Definition at line 91 of file snmp_api.h.
+.SS "long \fBsnmp_pdu::specific_type\fP"
+.PP
+specific type
+.PP
+Definition at line 140 of file snmp_api.h.
+.SS "const oid* \fBsnmp_pdu::tDomain\fP"
+.PP
+The actual transport domain. This SHOULD NOT BE FREE()D.
+.PP
+Definition at line 117 of file snmp_api.h.
+.SS "u_long \fBsnmp_pdu::time\fP"
+.PP
+Uptime.
+.PP
+Definition at line 97 of file snmp_api.h.
+.SS "long \fBsnmp_pdu::transid\fP"
+.PP
+Unique ID for incoming transactions.
+.PP
+Definition at line 89 of file snmp_api.h.
+.SS "void* \fBsnmp_pdu::transport_data\fP"
+.PP
+Transport-specific opaque data. This replaces the IP-centric address field.
+.PP
+Definition at line 110 of file snmp_api.h.
+.SS "long \fBsnmp_pdu::trap_type\fP"
+.PP
+trap type
+.PP
+Definition at line 138 of file snmp_api.h.
+.SS "long \fBsnmp_pdu::version\fP"
+.PP
+snmp version
+.PP
+Definition at line 81 of file snmp_api.h.
.SH "Author"
.PP
diff --git a/man/netsnmp_snmp_session.3 b/man/netsnmp_snmp_session.3
index 35b558c..9d5d6c0 100644
--- a/man/netsnmp_snmp_session.3
+++ b/man/netsnmp_snmp_session.3
@@ -1,15 +1,16 @@
-.TH "snmp_session" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "snmp_session" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-snmp_session \- The snmp session structure.
-
+snmp_session \-
.PP
+The snmp session structure.
+
.SH SYNOPSIS
.br
.PP
-\fC#include <snmp_api.h>\fP
.PP
+\fC#include <snmp_api.h>\fP
.SS "Data Fields"
.in +1c
@@ -29,10 +30,10 @@
.RI "u_long \fBflags\fP"
.br
.ti -1c
-.RI "\fBsnmp_session\fP * \fBsubsession\fP"
+.RI "struct \fBsnmp_session\fP * \fBsubsession\fP"
.br
.ti -1c
-.RI "\fBsnmp_session\fP * \fBnext\fP"
+.RI "struct \fBsnmp_session\fP * \fBnext\fP"
.br
.ti -1c
.RI "char * \fBpeername\fP"
@@ -197,7 +198,7 @@
.ti -1c
.RI "void * \fBsecurityInfo\fP"
.br
-.RI "\fIsecurity module specific \fP"
+.RI "\fIsecurity \fBmodule\fP specific \fP"
.ti -1c
.RI "void * \fBmyvoid\fP"
.br
@@ -210,93 +211,19 @@
Definition at line 187 of file snmp_api.h.
.SH "Field Documentation"
.PP
-.SS "long \fBsnmp_session::version\fP"
-.PP
-snmp version
-.PP
-Definition at line 192 of file snmp_api.h.
-.PP
-Referenced by add_trap_session(), create_user_from_session(), netsnmp_register_agent_nsap(), send_trap_to_sess(), snmp_sess_add_ex(), snmp_sess_init(), snmpd_parse_config_trapsess(), and snmpv3_engineID_probe().
-.SS "int \fBsnmp_session::retries\fP"
-.PP
-Number of retries before timeout.
-.PP
-Definition at line 194 of file snmp_api.h.
-.PP
-Referenced by snmp_sess_init(), and snmp_sess_timeout().
-.SS "long \fBsnmp_session::timeout\fP"
-.PP
-Number of uS until first timeout, then exponential backoff.
-.PP
-Definition at line 196 of file snmp_api.h.
-.PP
-Referenced by snmp_sess_init().
-.SS "char* \fBsnmp_session::peername\fP"
-.PP
-name or address of default peer (may include transport specifier and/or port number)
-.PP
-Definition at line 202 of file snmp_api.h.
-.PP
-Referenced by snmpd_parse_config_trapsess().
-.SS "u_short \fBsnmp_session::remote_port\fP"
-.PP
-UDP port number of peer.
-.PP
-(NO LONGER USED - USE peername INSTEAD)
-.PP
-Definition at line 204 of file snmp_api.h.
-.PP
-Referenced by snmp_sess_init().
-.SS "char* \fBsnmp_session::localname\fP"
-.PP
-My Domain name or dotted IP address, 0 for default.
-.PP
-Definition at line 206 of file snmp_api.h.
-.SS "u_short \fBsnmp_session::local_port\fP"
-.PP
-My UDP port number, 0 for default, picked randomly.
-.PP
-Definition at line 208 of file snmp_api.h.
.SS "u_char*(* \fBsnmp_session::authenticator\fP)(u_char *, size_t *, u_char *, size_t)"
.PP
Authentication function or NULL if null authentication is used.
-.PP
-Referenced by netsnmp_register_agent_nsap().
.SS "netsnmp_callback \fBsnmp_session::callback\fP"
.PP
Function to interpret incoming data.
.PP
Definition at line 214 of file snmp_api.h.
-.PP
-Referenced by _sess_read(), netsnmp_register_agent_nsap(), snmp_sess_synch_response(), snmp_sess_timeout(), and snmp_synch_response_cb().
.SS "void* \fBsnmp_session::callback_magic\fP"
.PP
Pointer to data that the callback function may consider important.
.PP
Definition at line 218 of file snmp_api.h.
-.PP
-Referenced by _sess_read(), snmp_sess_synch_response(), snmp_sess_timeout(), and snmp_synch_response_cb().
-.SS "int \fBsnmp_session::s_errno\fP"
-.PP
-copy of system errno
-.PP
-Definition at line 220 of file snmp_api.h.
-.PP
-Referenced by _sess_read(), and snmp_error().
-.SS "int \fBsnmp_session::s_snmp_errno\fP"
-.PP
-copy of library errno
-.PP
-Definition at line 222 of file snmp_api.h.
-.PP
-Referenced by _sess_read(), handle_snmp_packet(), snmp_build(), snmp_error(), snmp_sess_add_ex(), snmp_sess_async_send(), snmp_sess_open(), snmp_sess_read(), and snmpv3_engineID_probe().
-.SS "long \fBsnmp_session::sessid\fP"
-.PP
-Session id - AgentX only.
-.PP
-Definition at line 224 of file snmp_api.h.
-.PP
-Referenced by send_trap_to_sess().
.SS "u_char* \fBsnmp_session::community\fP"
.PP
community for outgoing requests.
@@ -307,27 +234,6 @@
Length of community name.
.PP
Definition at line 232 of file snmp_api.h.
-.SS "size_t \fBsnmp_session::rcvMsgMaxSize\fP"
-.PP
-Largest message to try to receive.
-.PP
-Definition at line 234 of file snmp_api.h.
-.PP
-Referenced by snmp_sess_add_ex(), and snmp_sess_init().
-.SS "size_t \fBsnmp_session::sndMsgMaxSize\fP"
-.PP
-Largest message to try to send.
-.PP
-Definition at line 236 of file snmp_api.h.
-.PP
-Referenced by snmpv3_parse().
-.SS "u_char \fBsnmp_session::isAuthoritative\fP"
-.PP
-are we the authoritative engine?
-.PP
-Definition at line 242 of file snmp_api.h.
-.PP
-Referenced by netsnmp_register_agent_nsap().
.SS "u_char* \fBsnmp_session::contextEngineID\fP"
.PP
authoritative snmpEngineID
@@ -338,175 +244,196 @@
Length of contextEngineID.
.PP
Definition at line 246 of file snmp_api.h.
-.SS "u_int \fBsnmp_session::engineBoots\fP"
-.PP
-initial engineBoots for remote engine
-.PP
-Definition at line 248 of file snmp_api.h.
-.PP
-Referenced by snmpv3_engineID_probe().
-.SS "u_int \fBsnmp_session::engineTime\fP"
-.PP
-initial engineTime for remote engine
-.PP
-Definition at line 250 of file snmp_api.h.
-.PP
-Referenced by snmpv3_engineID_probe().
.SS "char* \fBsnmp_session::contextName\fP"
.PP
authoritative contextName
.PP
Definition at line 252 of file snmp_api.h.
-.PP
-Referenced by unregister_mibs_by_session().
.SS "size_t \fBsnmp_session::contextNameLen\fP"
.PP
Length of contextName.
.PP
Definition at line 254 of file snmp_api.h.
-.SS "u_char* \fBsnmp_session::securityEngineID\fP"
+.SS "u_int \fBsnmp_session::engineBoots\fP"
.PP
-authoritative snmpEngineID
+initial engineBoots for remote engine
.PP
-Definition at line 256 of file snmp_api.h.
+Definition at line 248 of file snmp_api.h.
+.SS "u_int \fBsnmp_session::engineTime\fP"
.PP
-Referenced by create_user_from_session(), snmpd_parse_config_trapsess(), and snmpv3_engineID_probe().
-.SS "size_t \fBsnmp_session::securityEngineIDLen\fP"
+initial engineTime for remote engine
.PP
-Length of contextEngineID.
+Definition at line 250 of file snmp_api.h.
+.SS "u_char \fBsnmp_session::isAuthoritative\fP"
.PP
-Definition at line 258 of file snmp_api.h.
+are we the authoritative engine?
.PP
-Referenced by create_user_from_session(), snmpd_parse_config_trapsess(), and snmpv3_engineID_probe().
-.SS "char* \fBsnmp_session::securityName\fP"
+Definition at line 242 of file snmp_api.h.
+.SS "u_short \fBsnmp_session::local_port\fP"
.PP
-on behalf of this principal
+My UDP port number, 0 for default, picked randomly.
.PP
-Definition at line 260 of file snmp_api.h.
+Definition at line 208 of file snmp_api.h.
+.SS "char* \fBsnmp_session::localname\fP"
.PP
-Referenced by create_user_from_session().
-.SS "size_t \fBsnmp_session::securityNameLen\fP"
+My Domain name or dotted IP address, 0 for default.
.PP
-Length of securityName.
+Definition at line 206 of file snmp_api.h.
+.SS "void* \fBsnmp_session::myvoid\fP"
.PP
-Definition at line 262 of file snmp_api.h.
+use as you want data used by 'SNMP_FLAGS_RESP_CALLBACK' handling in the agent XXX: or should we add a new field into this structure?
.PP
-Referenced by create_user_from_session().
-.SS "oid* \fBsnmp_session::securityAuthProto\fP"
-.PP
-auth protocol oid
-.PP
-Definition at line 265 of file snmp_api.h.
-.PP
-Referenced by create_user_from_session().
-.SS "size_t \fBsnmp_session::securityAuthProtoLen\fP"
-.PP
-Length of auth protocol oid.
-.PP
-Definition at line 267 of file snmp_api.h.
-.PP
-Referenced by create_user_from_session().
-.SS "u_char \fBsnmp_session::securityAuthKey\fP[USM_AUTH_KU_LEN]"
-.PP
-Ku for auth protocol XXX.
-.PP
-Definition at line 269 of file snmp_api.h.
-.PP
-Referenced by create_user_from_session().
-.SS "size_t \fBsnmp_session::securityAuthKeyLen\fP"
-.PP
-Length of Ku for auth protocol.
-.PP
-Definition at line 271 of file snmp_api.h.
-.PP
-Referenced by create_user_from_session().
-.SS "u_char* \fBsnmp_session::securityAuthLocalKey\fP"
-.PP
-Kul for auth protocol.
-.PP
-Definition at line 273 of file snmp_api.h.
-.PP
-Referenced by create_user_from_session().
-.SS "size_t \fBsnmp_session::securityAuthLocalKeyLen\fP"
-.PP
-Length of Kul for auth protocol XXX.
-.PP
-Definition at line 275 of file snmp_api.h.
-.PP
-Referenced by create_user_from_session().
-.SS "oid* \fBsnmp_session::securityPrivProto\fP"
-.PP
-priv protocol oid
-.PP
-Definition at line 278 of file snmp_api.h.
-.PP
-Referenced by create_user_from_session().
-.SS "size_t \fBsnmp_session::securityPrivProtoLen\fP"
-.PP
-Length of priv protocol oid.
-.PP
-Definition at line 280 of file snmp_api.h.
-.PP
-Referenced by create_user_from_session().
-.SS "u_char \fBsnmp_session::securityPrivKey\fP[USM_PRIV_KU_LEN]"
-.PP
-Ku for privacy protocol XXX.
-.PP
-Definition at line 282 of file snmp_api.h.
-.PP
-Referenced by create_user_from_session().
-.SS "size_t \fBsnmp_session::securityPrivKeyLen\fP"
-.PP
-Length of Ku for priv protocol.
-.PP
-Definition at line 284 of file snmp_api.h.
-.PP
-Referenced by create_user_from_session().
-.SS "u_char* \fBsnmp_session::securityPrivLocalKey\fP"
-.PP
-Kul for priv protocol.
-.PP
-Definition at line 286 of file snmp_api.h.
-.PP
-Referenced by create_user_from_session().
-.SS "size_t \fBsnmp_session::securityPrivLocalKeyLen\fP"
-.PP
-Length of Kul for priv protocol XXX.
-.PP
-Definition at line 288 of file snmp_api.h.
-.PP
-Referenced by create_user_from_session().
-.SS "int \fBsnmp_session::securityModel\fP"
-.PP
-snmp security model, v1, v2c, usm
-.PP
-Definition at line 291 of file snmp_api.h.
-.PP
-Referenced by create_user_from_session(), snmp_sess_close(), and snmp_sess_init().
-.SS "int \fBsnmp_session::securityLevel\fP"
-.PP
-noAuthNoPriv, authNoPriv, authPriv
-.PP
-Definition at line 293 of file snmp_api.h.
+Definition at line 308 of file snmp_api.h.
.SS "char* \fBsnmp_session::paramName\fP"
.PP
target param name
.PP
Definition at line 295 of file snmp_api.h.
+.SS "char* \fBsnmp_session::peername\fP"
+.PP
+name or address of default peer (may include transport specifier and/or port number)
+.PP
+Definition at line 202 of file snmp_api.h.
+.SS "size_t \fBsnmp_session::rcvMsgMaxSize\fP"
+.PP
+Largest message to try to receive.
+.PP
+Definition at line 234 of file snmp_api.h.
+.SS "u_short \fBsnmp_session::remote_port\fP"
+.PP
+UDP port number of peer. (NO LONGER USED - USE peername INSTEAD)
+.PP
+Definition at line 204 of file snmp_api.h.
+.SS "int \fBsnmp_session::retries\fP"
+.PP
+Number of retries before timeout.
+.PP
+Definition at line 194 of file snmp_api.h.
+.SS "int \fBsnmp_session::s_errno\fP"
+.PP
+copy of system errno
+.PP
+Definition at line 220 of file snmp_api.h.
+.SS "int \fBsnmp_session::s_snmp_errno\fP"
+.PP
+copy of library errno
+.PP
+Definition at line 222 of file snmp_api.h.
+.SS "u_char \fBsnmp_session::securityAuthKey\fP[USM_AUTH_KU_LEN]"
+.PP
+Ku for auth protocol XXX.
+.PP
+Definition at line 269 of file snmp_api.h.
+.SS "size_t \fBsnmp_session::securityAuthKeyLen\fP"
+.PP
+Length of Ku for auth protocol.
+.PP
+Definition at line 271 of file snmp_api.h.
+.SS "u_char* \fBsnmp_session::securityAuthLocalKey\fP"
+.PP
+Kul for auth protocol.
+.PP
+Definition at line 273 of file snmp_api.h.
+.SS "size_t \fBsnmp_session::securityAuthLocalKeyLen\fP"
+.PP
+Length of Kul for auth protocol XXX.
+.PP
+Definition at line 275 of file snmp_api.h.
+.SS "oid* \fBsnmp_session::securityAuthProto\fP"
+.PP
+auth protocol oid
+.PP
+Definition at line 265 of file snmp_api.h.
+.SS "size_t \fBsnmp_session::securityAuthProtoLen\fP"
+.PP
+Length of auth protocol oid.
+.PP
+Definition at line 267 of file snmp_api.h.
+.SS "u_char* \fBsnmp_session::securityEngineID\fP"
+.PP
+authoritative snmpEngineID
+.PP
+Definition at line 256 of file snmp_api.h.
+.SS "size_t \fBsnmp_session::securityEngineIDLen\fP"
+.PP
+Length of contextEngineID.
+.PP
+Definition at line 258 of file snmp_api.h.
.SS "void* \fBsnmp_session::securityInfo\fP"
.PP
-security module specific
+security \fBmodule\fP specific
.PP
Definition at line 300 of file snmp_api.h.
-.SS "void* \fBsnmp_session::myvoid\fP"
+.SS "int \fBsnmp_session::securityLevel\fP"
.PP
-use as you want data
+noAuthNoPriv, authNoPriv, authPriv
.PP
-used by 'SNMP_FLAGS_RESP_CALLBACK' handling in the agent XXX: or should we add a new field into this structure?
+Definition at line 293 of file snmp_api.h.
+.SS "int \fBsnmp_session::securityModel\fP"
.PP
-Definition at line 308 of file snmp_api.h.
+snmp security model, v1, v2c, usm
.PP
-Referenced by snmp_synch_response_cb().
+Definition at line 291 of file snmp_api.h.
+.SS "char* \fBsnmp_session::securityName\fP"
+.PP
+on behalf of this principal
+.PP
+Definition at line 260 of file snmp_api.h.
+.SS "size_t \fBsnmp_session::securityNameLen\fP"
+.PP
+Length of securityName.
+.PP
+Definition at line 262 of file snmp_api.h.
+.SS "u_char \fBsnmp_session::securityPrivKey\fP[USM_PRIV_KU_LEN]"
+.PP
+Ku for privacy protocol XXX.
+.PP
+Definition at line 282 of file snmp_api.h.
+.SS "size_t \fBsnmp_session::securityPrivKeyLen\fP"
+.PP
+Length of Ku for priv protocol.
+.PP
+Definition at line 284 of file snmp_api.h.
+.SS "u_char* \fBsnmp_session::securityPrivLocalKey\fP"
+.PP
+Kul for priv protocol.
+.PP
+Definition at line 286 of file snmp_api.h.
+.SS "size_t \fBsnmp_session::securityPrivLocalKeyLen\fP"
+.PP
+Length of Kul for priv protocol XXX.
+.PP
+Definition at line 288 of file snmp_api.h.
+.SS "oid* \fBsnmp_session::securityPrivProto\fP"
+.PP
+priv protocol oid
+.PP
+Definition at line 278 of file snmp_api.h.
+.SS "size_t \fBsnmp_session::securityPrivProtoLen\fP"
+.PP
+Length of priv protocol oid.
+.PP
+Definition at line 280 of file snmp_api.h.
+.SS "long \fBsnmp_session::sessid\fP"
+.PP
+Session id - AgentX only.
+.PP
+Definition at line 224 of file snmp_api.h.
+.SS "size_t \fBsnmp_session::sndMsgMaxSize\fP"
+.PP
+Largest message to try to send.
+.PP
+Definition at line 236 of file snmp_api.h.
+.SS "long \fBsnmp_session::timeout\fP"
+.PP
+Number of uS until first timeout, then exponential backoff.
+.PP
+Definition at line 196 of file snmp_api.h.
+.SS "long \fBsnmp_session::version\fP"
+.PP
+snmp version
+.PP
+Definition at line 192 of file snmp_api.h.
.SH "Author"
.PP
diff --git a/man/netsnmp_stash_cache.3 b/man/netsnmp_stash_cache.3
index d1fd9de..b61b11e 100644
--- a/man/netsnmp_stash_cache.3
+++ b/man/netsnmp_stash_cache.3
@@ -1,10 +1,11 @@
-.TH "stash_cache" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "stash_cache" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-stash_cache \- Automatically caches data for certain handlers.
-
+stash_cache \-
.PP
+Automatically caches data for certain handlers.
+
.SS "Functions"
.in +1c
@@ -49,7 +50,7 @@
.SH "Detailed Description"
.PP
Automatically caches data for certain handlers.
-.PP
+
This handler caches data in an optimized way which may aleviate the need for the lower level handlers to perform as much optimization. Specifically, somewhere in the lower level handlers must be a handler that supports the MODE_GET_STASH operation. Note that the table_iterator helper supports this.
.SH "Function Documentation"
.PP
@@ -57,60 +58,37 @@
.PP
updates a given cache depending on whether it needs to or not.
.PP
-Definition at line 194 of file stash_cache.c.
-.PP
-References netsnmp_stash_cache_info_s::cache, netsnmp_cache_s::cache_hint, netsnmp_handler_args_s::handler, netsnmp_cache_s::magic, netsnmp_agent_request_info_s::mode, netsnmp_agent_add_list_data(), netsnmp_call_next_handler(), netsnmp_create_data_list(), netsnmp_get_new_stash_cache(), netsnmp_mib_handler_s::next, NULL, netsnmp_handler_args_s::reginfo, netsnmp_handler_args_s::reqinfo, and netsnmp_handler_args_s::requests.
-.PP
-Referenced by netsnmp_get_timed_bare_stash_cache_handler().
+Definition at line 195 of file stash_cache.c.
.SS "\fBnetsnmp_oid_stash_node\fP** netsnmp_extract_stash_cache (\fBnetsnmp_agent_request_info\fP * reqinfo)"
.PP
extracts a pointer to the stash_cache info from the reqinfo structure.
.PP
-Definition at line 112 of file stash_cache.c.
-.PP
-References netsnmp_agent_get_list_data().
-.PP
-Referenced by netsnmp_stash_to_next_helper(), and netsnmp_table_iterator_helper_handler().
+Definition at line 113 of file stash_cache.c.
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_bare_stash_cache_handler (void)"
.PP
returns a single stash_cache handler that can be injected into a given handler chain (with a fixed timeout), but *only* if that handler chain explicitly supports stash cache processing.
.PP
-Definition at line 78 of file stash_cache.c.
-.PP
-References netsnmp_get_timed_bare_stash_cache_handler(), and NULL.
-.PP
-Referenced by netsnmp_get_stash_cache_handler().
+Definition at line 79 of file stash_cache.c.
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_stash_cache_handler (void)"
.PP
returns a stash_cache handler sub-chain that can be injected into a given (arbitrary) handler chain, using a fixed cache timeout.
.PP
-Definition at line 87 of file stash_cache.c.
-.PP
-References netsnmp_get_bare_stash_cache_handler(), netsnmp_get_stash_to_next_handler(), and netsnmp_mib_handler_s::next.
-.PP
-Referenced by netsnmp_init_stash_cache_helper().
+Definition at line 88 of file stash_cache.c.
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_timed_bare_stash_cache_handler (int timeout, oid * rootoid, size_t rootoid_len)"
.PP
returns a stash_cache handler that can be injected into a given handler chain (with the specified timeout and root OID values), but *only* if that handler chain explicitly supports stash cache processing.
.PP
Definition at line 44 of file stash_cache.c.
-.PP
-References _netsnmp_stash_cache_free(), _netsnmp_stash_cache_load(), netsnmp_mib_handler_s::myvoid, netsnmp_cache_create(), netsnmp_cache_handler_get(), netsnmp_create_handler(), netsnmp_handler_free(), netsnmp_stash_cache_helper(), netsnmp_mib_handler_s::next, and NULL.
-.PP
-Referenced by netsnmp_get_bare_stash_cache_handler(), and netsnmp_get_timed_stash_cache_handler().
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_timed_stash_cache_handler (int timeout, oid * rootoid, size_t rootoid_len)"
.PP
returns a stash_cache handler sub-chain that can be injected into a given (arbitrary) handler chain, using a configurable cache timeout.
.PP
-Definition at line 100 of file stash_cache.c.
-.PP
-References netsnmp_get_stash_to_next_handler(), netsnmp_get_timed_bare_stash_cache_handler(), and netsnmp_mib_handler_s::next.
+Definition at line 101 of file stash_cache.c.
.SS "void netsnmp_init_stash_cache_helper (void)"
.PP
initializes the stash_cache helper which then registers a stash_cache handler as a run-time injectable handler for configuration file use.
.PP
-Definition at line 237 of file stash_cache.c.
-.PP
-References netsnmp_get_stash_cache_handler(), and netsnmp_register_handler_by_name().
-.PP
-Referenced by netsnmp_init_helpers().
+Definition at line 238 of file stash_cache.c.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_stash_to_next.3 b/man/netsnmp_stash_to_next.3
index 2505e77..73eccae 100644
--- a/man/netsnmp_stash_to_next.3
+++ b/man/netsnmp_stash_to_next.3
@@ -1,10 +1,11 @@
-.TH "stash_to_next" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "stash_to_next" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-stash_to_next \- Convert GET_STASH requests into GETNEXT requests for the handler.
-
+stash_to_next \-
.PP
+Convert GET_STASH requests into GETNEXT requests for the handler.
+
.SS "Functions"
.in +1c
@@ -19,7 +20,7 @@
.SH "Detailed Description"
.PP
Convert GET_STASH requests into GETNEXT requests for the handler.
-.PP
+
The purpose of this handler is to convert a GET_STASH auto-cache request to a series of GETNEXT requests. It can be inserted into a handler chain where the lower-level handlers don't process such requests themselves.
.SH "Function Documentation"
.PP
@@ -28,7 +29,6 @@
returns a stash_to_next handler that can be injected into a given handler chain.
.PP
Definition at line 28 of file stash_to_next.c.
-.PP
-References netsnmp_mib_handler_s::flags, MIB_HANDLER_AUTO_NEXT, netsnmp_create_handler(), netsnmp_stash_to_next_helper(), and NULL.
-.PP
-Referenced by netsnmp_get_stash_cache_handler(), and netsnmp_get_timed_stash_cache_handler().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_table.3 b/man/netsnmp_table.3
index 370781c..c99eec3 100644
--- a/man/netsnmp_table.3
+++ b/man/netsnmp_table.3
@@ -1,61 +1,56 @@
-.TH "table" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "table" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-table \- Helps you implement a table.
-
+table \-
.PP
+Helps you implement a table.
+
.SS "Modules"
.in +1c
.ti -1c
.RI "\fBtable_array\fP"
.br
-.RI "\fIHelps you implement a table when data can be stored locally. \fP"
.PP
-.in +1c
+.RI "\fIHelps you implement a table when data can be stored locally. \fP"
.ti -1c
.RI "\fBtable_container\fP"
.br
-.RI "\fIHelps you implement a table when data can be found via a netsnmp_container. \fP"
.PP
-.in +1c
+.RI "\fIHelps you implement a table when data can be found via a netsnmp_container. \fP"
.ti -1c
.RI "\fBtable_data\fP"
.br
-.RI "\fIHelps you implement a table with datamatted storage. \fP"
.PP
-.in +1c
+.RI "\fIHelps you implement a table with datamatted storage. \fP"
.ti -1c
.RI "\fBgeneric_table_API\fP"
.br
-.RI "\fIGeneral requirements for a table helper. \fP"
.PP
-.in +1c
+.RI "\fIGeneral requirements for a table helper. \fP"
.ti -1c
.RI "\fBtable_iterator\fP"
.br
-.RI "\fIThe table iterator helper is designed to simplify the task of writing a table handler for the net-snmp agent when the data being accessed is not in an oid sorted form and must be accessed externally. \fP"
.PP
-.in +1c
+.RI "\fIThe table iterator helper is designed to simplify the task of writing a table handler for the net-snmp agent when the data being accessed is not in an oid sorted form and must be accessed externally. \fP"
.ti -1c
.RI "\fBtable_row\fP"
.br
-.RI "\fIHelps you implement a table shared across two or more subagents, or otherwise split into individual row slices. \fP"
.PP
-.in +1c
+.RI "\fIHelps you implement a table shared across two or more subagents, or otherwise split into individual row slices. \fP"
.ti -1c
.RI "\fBtdata\fP"
.br
-.RI "\fIImplement a table with datamatted storage. \fP"
.PP
+.RI "\fIImplement a table with datamatted storage. \fP"
.in -1c
.SS "Defines"
@@ -123,7 +118,7 @@
.SH "Detailed Description"
.PP
Helps you implement a table.
-.PP
+
This handler helps you implement a table by doing some of the processing for you.
.PP
This handler truly shows the power of the new handler mechanism. By creating a table handler and injecting it into your calling chain, or by using the \fBnetsnmp_register_table()\fP function to register your table, you get access to some pre-parsed information. Specifically, the table handler pulls out the column number and indexes from the request oid so that you don't have to do the complex work to do that parsing within your own code.
@@ -133,18 +128,12 @@
.PP
.SS "int netsnmp_check_getnext_reply (\fBnetsnmp_request_info\fP * request, oid * prefix, size_t prefix_len, \fBnetsnmp_variable_list\fP * newvar, \fBnetsnmp_variable_list\fP ** outvar)"
.PP
-checks the original request against the current data being passed in if its greater than the request oid but less than the current valid return, set the current valid return to the new value.
-.PP
-returns 1 if outvar was replaced with the oid from newvar (success). returns 0 if not.
+checks the original request against the current data being passed in if its greater than the request oid but less than the current valid return, set the current valid return to the new value. returns 1 if outvar was replaced with the oid from newvar (success). returns 0 if not.
.PP
Definition at line 884 of file table.c.
-.PP
-References build_oid_noalloc(), variable_list::name, variable_list::name_length, netsnmp_request_info_s::requestvb, snmp_clone_varbind(), snmp_free_varbind(), snmp_oid_compare(), snmp_set_var_objid(), snmp_set_var_typed_value(), netsnmp_vardata::string, variable_list::type, variable_list::val, and variable_list::val_len.
.SS "NETSNMP_INLINE \fBnetsnmp_table_request_info\fP* netsnmp_extract_table_info (\fBnetsnmp_request_info\fP * request)"
.PP
-Extracts the processed table information from a given request.
-.PP
-Call this from subhandlers on a request to extract the processed netsnmp_request_info information. The resulting information includes the index values and the column number.
+Extracts the processed table information from a given request. Call this from subhandlers on a request to extract the processed netsnmp_request_info information. The resulting information includes the index values and the column number.
.PP
\fBParameters:\fP
.RS 4
@@ -159,24 +148,14 @@
.PP
Definition at line 125 of file table.c.
-.PP
-References netsnmp_request_get_list_data().
-.PP
-Referenced by _netsnmp_tdata_helper_handler(), netsnmp_container_table_row_insert(), netsnmp_insert_iterator_context(), netsnmp_insert_table_row(), netsnmp_table_data_helper_handler(), netsnmp_table_data_set_helper_handler(), netsnmp_table_iterator_helper_handler(), and table_helper_handler().
.SS "\fBnetsnmp_table_registration_info\fP* netsnmp_find_table_registration_info (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
extracts the registered netsnmp_table_registration_info object from a netsnmp_handler_registration object
.PP
Definition at line 134 of file table.c.
-.PP
-References netsnmp_find_handler_data_by_name().
-.PP
-Referenced by netsnmp_table_data_helper_handler(), and netsnmp_table_iterator_helper_handler().
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_table_handler (\fBnetsnmp_table_registration_info\fP * tabreq)"
.PP
-Given a netsnmp_table_registration_info object, creates a table handler.
-.PP
-You can use this table handler by injecting it into a calling chain. When the handler gets called, it'll do processing and store it's information into the request->parent_data structure.
+Given a netsnmp_table_registration_info object, creates a table handler. You can use this table handler by injecting it into a calling chain. When the handler gets called, it'll do processing and store it's information into the request->parent_data structure.
.PP
The table helper handler pulls out the column number and indexes from the request oid so that you don't have to do the complex work of parsing within your own code.
.PP
@@ -193,80 +172,50 @@
.PP
Definition at line 85 of file table.c.
-.PP
-References count_varbinds(), netsnmp_table_registration_info_s::indexes, netsnmp_mib_handler_s::myvoid, netsnmp_create_handler(), NULL, netsnmp_table_registration_info_s::number_indexes, snmp_log(), and table_helper_handler().
-.PP
-Referenced by netsnmp_register_table(), and netsnmp_sparse_table_register().
.SS "int netsnmp_register_table (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_table_registration_info\fP * tabreq)"
.PP
creates a table handler given the netsnmp_table_registration_info object, inserts it into the request chain and then calls \fBnetsnmp_register_handler()\fP to register the table into the agent.
.PP
Definition at line 108 of file table.c.
-.PP
-References netsnmp_get_table_handler(), netsnmp_inject_handler(), and netsnmp_register_handler().
-.PP
-Referenced by netsnmp_container_table_register(), netsnmp_register_table_data(), netsnmp_register_table_iterator(), netsnmp_table_container_register(), and netsnmp_table_row_register().
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_sparse_table_handler_get (void)"
.PP
create sparse table handler
.PP
Definition at line 722 of file table.c.
-.PP
-References netsnmp_create_handler(), and SPARSE_TABLE_HANDLER_NAME.
.SS "int netsnmp_sparse_table_register (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_table_registration_info\fP * tabreq)"
.PP
creates a table handler given the netsnmp_table_registration_info object, inserts it into the request chain and then calls \fBnetsnmp_register_handler()\fP to register the table into the agent.
.PP
Definition at line 733 of file table.c.
-.PP
-References netsnmp_create_handler(), netsnmp_get_table_handler(), netsnmp_inject_handler(), netsnmp_register_handler(), and SPARSE_TABLE_HANDLER_NAME.
.SS "int netsnmp_table_build_oid (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_request_info\fP * reqinfo, \fBnetsnmp_table_request_info\fP * table_info)"
.PP
-given a registration info object, a request object and the table info object it builds the request->requestvb->name oid from the index values and column information found in the table_info object.
-.PP
-Index values are extracted from the table_info varbinds.
+given a registration info object, a request object and the table info object it builds the request->requestvb->name oid from the index values and column information found in the table_info object. Index values are extracted from the table_info varbinds.
.PP
.Entry
.PP
.column
.PP
Definition at line 784 of file table.c.
-.PP
-References build_oid(), netsnmp_table_request_info_s::colnum, netsnmp_table_request_info_s::indexes, variable_list::name, variable_list::name_length, netsnmp_request_info_s::requestvb, netsnmp_handler_registration_s::rootoid, and netsnmp_handler_registration_s::rootoid_len.
-.PP
-Referenced by netsnmp_table_build_result().
.SS "int netsnmp_table_build_oid_from_index (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_request_info\fP * reqinfo, \fBnetsnmp_table_request_info\fP * table_info)"
.PP
-given a registration info object, a request object and the table info object it builds the request->requestvb->name oid from the index values and column information found in the table_info object.
-.PP
-Index values are extracted from the table_info index oid.
+given a registration info object, a request object and the table info object it builds the request->requestvb->name oid from the index values and column information found in the table_info object. Index values are extracted from the table_info index oid.
.PP
Definition at line 821 of file table.c.
-.PP
-References netsnmp_table_request_info_s::colnum, netsnmp_table_request_info_s::index_oid, netsnmp_table_request_info_s::index_oid_len, variable_list::name, variable_list::name_length, variable_list::name_loc, netsnmp_request_info_s::requestvb, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, snmp_clone_mem(), and SNMP_FREE.
.SS "int netsnmp_table_build_result (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_request_info\fP * reqinfo, \fBnetsnmp_table_request_info\fP * table_info, u_char type, u_char * result, size_t result_len)"
.PP
-Builds the result to be returned to the agent given the table information.
-.PP
-Use this function to return results from lowel level handlers to the agent. It takes care of building the proper resulting oid (containing proper indexing) and inserts the result value into the returning varbind.
+Builds the result to be returned to the agent given the table information. Use this function to return results from lowel level handlers to the agent. It takes care of building the proper resulting oid (containing proper indexing) and inserts the result value into the returning varbind.
.PP
Definition at line 751 of file table.c.
-.PP
-References variable_list::name, variable_list::name_loc, netsnmp_table_build_oid(), NULL, netsnmp_request_info_s::requestvb, and snmp_set_var_typed_value().
.SS "int netsnmp_update_indexes_from_variable_list (\fBnetsnmp_table_request_info\fP * tri)"
.PP
builds an oid given a set of indexes.
.PP
Definition at line 866 of file table.c.
-.PP
-References build_oid_noalloc(), netsnmp_table_request_info_s::index_oid, netsnmp_table_request_info_s::index_oid_len, netsnmp_table_request_info_s::indexes, and NULL.
.SS "int netsnmp_update_variable_list_from_index (\fBnetsnmp_table_request_info\fP * tri)"
.PP
parses an OID into table indexses
.PP
Definition at line 850 of file table.c.
-.PP
-References netsnmp_table_request_info_s::index_oid, netsnmp_table_request_info_s::index_oid_len, netsnmp_table_request_info_s::indexes, parse_oid_indexes(), and snmp_reset_var_buffers().
.SS "int table_helper_handler (\fBnetsnmp_mib_handler\fP * handler, \fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_agent_request_info\fP * reqinfo, \fBnetsnmp_request_info\fP * requests)"
.PP
implements the table helper handler
@@ -280,7 +229,6 @@
for loop
.PP
Definition at line 142 of file table.c.
-.PP
-References netsnmp_table_request_info_s::colnum, netsnmp_mib_handler_s::handler_name, netsnmp_table_request_info_s::index_oid, netsnmp_table_request_info_s::index_oid_len, netsnmp_table_request_info_s::indexes, netsnmp_table_registration_info_s::indexes, netsnmp_table_registration_info_s::max_column, netsnmp_table_registration_info_s::min_column, netsnmp_agent_request_info_s::mode, netsnmp_mib_handler_s::myvoid, netsnmp_agent_get_list_data(), netsnmp_call_next_handler(), netsnmp_create_data_list(), netsnmp_extract_table_info(), netsnmp_free_agent_data_sets(), netsnmp_request_add_list_data(), netsnmp_set_request_error(), netsnmp_request_info_s::next, netsnmp_mib_handler_s::next, variable_list::next_variable, NULL, netsnmp_table_registration_info_s::number_indexes, netsnmp_table_request_info_s::number_indexes, parse_one_oid_index(), netsnmp_request_info_s::processed, netsnmp_table_request_info_s::reg_info, netsnmp_request_info_s::requestvb, netsnmp_handler_registration_s::rootoid, netsnmp_handler_registration_s::rootoid_len, snmp_clone_varbind(), SNMP_FREE, snmp_log(), SNMP_MALLOC_TYPEDEF, snmp_oid_compare(), snmp_set_var_objid(), sprint_realloc_by_type(), netsnmp_request_info_s::status, variable_list::type, and netsnmp_table_registration_info_s::valid_columns.
-.PP
-Referenced by netsnmp_get_table_handler().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_table_array.3 b/man/netsnmp_table_array.3
index 1967350..1055fb2 100644
--- a/man/netsnmp_table_array.3
+++ b/man/netsnmp_table_array.3
@@ -1,10 +1,11 @@
-.TH "table_array" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "table_array" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-table_array \- Helps you implement a table when data can be stored locally.
-
+table_array \-
.PP
+Helps you implement a table when data can be stored locally.
+
.SS "Functions"
.in +1c
@@ -31,7 +32,7 @@
.SH "Detailed Description"
.PP
Helps you implement a table when data can be stored locally.
-.PP
+
The data is stored in a sorted array, using a binary search for lookups.
.PP
The table_array handler is used (automatically) in conjuntion with the \fBtable\fP handler. It is primarily intended to be used with the mib2c configuration file mib2c.array-user.conf.
@@ -54,7 +55,7 @@
.PP
If your table contains a RowStatus object, by default the code will not allow object in an active row to be modified. To allow active rows to be modified, remove the comment block around the #define <PREFIX>_CAN_MODIFY_ACTIVE_ROW in the header file.
.PP
-Code will be generated to maintain a secondary index for all rows, stored in a binary tree. This is very useful for finding rows by a key other than the OID index. By default, the functions for maintaining this tree will be based on a character string. NOTE: this will likely be made into a more generic mechanism, using new callback methods, in the near future.
+Code will be generated to maintain a secondary index for all rows, stored in a binary \fBtree\fP. This is very useful for finding rows by a key other than the OID index. By default, the functions for maintaining this \fBtree\fP will be based on a character string. NOTE: this will likely be made into a more generic mechanism, using new callback methods, in the near future.
.PP
The generated code contains many TODO comments. Make sure you check each one to see if it applies to your code. Examples include checking indices for syntax (ranges, etc), initializing default values in newly created rows, checking for row activation and deactivation requirements, etc.
.SH "Function Documentation"
@@ -64,30 +65,21 @@
find the context data used by the table_array helper
.PP
Definition at line 229 of file table_array.c.
-.PP
-References netsnmp_request_get_list_data().
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_find_table_array_handler (\fBnetsnmp_handler_registration\fP * reginfo)"
.PP
find the handler for the table_array helper.
.PP
Definition at line 212 of file table_array.c.
-.PP
-References netsnmp_mib_handler_s::access_method, netsnmp_handler_registration_s::handler, netsnmp_mib_handler_s::next, and NULL.
.SS "int netsnmp_table_array_check_row_status (\fBnetsnmp_table_array_callbacks\fP * cb, \fBnetsnmp_request_group\fP * ag, long * rs_new, long * rs_old)"
.PP
this function is called to validate RowStatus transitions.
.PP
Definition at line 236 of file table_array.c.
-.PP
-References netsnmp_table_array_callbacks_s::can_activate, netsnmp_table_array_callbacks_s::can_deactivate, netsnmp_table_array_callbacks_s::can_delete, netsnmp_request_group_s::existing_row, NULL, netsnmp_request_group_s::row_deleted, and netsnmp_request_group_s::undo_info.
.SS "int netsnmp_table_container_register (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_table_registration_info\fP * tabreg, \fBnetsnmp_table_array_callbacks\fP * cb, \fBnetsnmp_container\fP * container, int group_rows)"
.PP
-register specified callbacks for the specified table/oid.
-.PP
-If the group_rows parameter is set, the row related callbacks will be called once for each unique row index. Otherwise, each callback will be called only once, for all objects.
+register specified callbacks for the specified table/oid. If the group_rows parameter is set, the row related callbacks will be called once for each unique row index. Otherwise, each callback will be called only once, for all objects.
.PP
Definition at line 149 of file table_array.c.
-.PP
-References netsnmp_table_array_callbacks_s::can_set, table_container_data_s::cb, netsnmp_container_s::compare, netsnmp_table_array_callbacks_s::delete_row, netsnmp_table_array_callbacks_s::duplicate_row, netsnmp_handler_registration_s::handler, netsnmp_mib_handler_s::myvoid, netsnmp_container_s::ncompare, netsnmp_register_table(), NULL, netsnmp_table_array_callbacks_s::row_copy, snmp_log(), SNMP_MALLOC_TYPEDEF, table_container_data_s::table, and table_container_data_s::tblreg_info.
-.PP
-Referenced by netsnmp_table_array_register().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_table_container.3 b/man/netsnmp_table_container.3
index c22c876..3d7b77f 100644
--- a/man/netsnmp_table_container.3
+++ b/man/netsnmp_table_container.3
@@ -1,10 +1,11 @@
-.TH "table_container" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "table_container" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-table_container \- Helps you implement a table when data can be found via a netsnmp_container.
-
+table_container \-
.PP
+Helps you implement a table when data can be found via a netsnmp_container.
+
.SS "Functions"
.in +1c
@@ -35,14 +36,6 @@
.br
.RI "\fIretrieve the container used by the table_container helper \fP"
.ti -1c
-.RI "void * \fBnetsnmp_container_table_row_extract\fP (\fBnetsnmp_request_info\fP *request)"
-.br
-.RI "\fIfind the context data used by the table_container helper \fP"
-.ti -1c
-.RI "void * \fBnetsnmp_container_table_extract_context\fP (\fBnetsnmp_request_info\fP *request)"
-.br
-.RI "\fIfind the context data used by the table_container helper \fP"
-.ti -1c
.RI "void \fBnetsnmp_container_table_row_insert\fP (\fBnetsnmp_request_info\fP *request, \fBnetsnmp_index\fP *row)"
.br
.RI "\fIinserts a newly created table_container entry into a request list \fP"
@@ -54,7 +47,7 @@
.SH "Detailed Description"
.PP
Helps you implement a table when data can be found via a netsnmp_container.
-.PP
+
The table_container handler is used (automatically) in conjuntion with the \fBtable\fP handler.
.PP
This handler will use the index information provided by the \fBtable\fP handler to find the row needed to process the request.
@@ -65,7 +58,7 @@
.PP
TABLE_CONTAINER_KEY_NETSNMP_INDEX The container should do comparisons based on a key that may be cast to a netsnmp index (netsnmp_index *). This index contains only the index portion of the OID, not the entire OID.
.PP
-TABLE_CONTAINER_KEY_VARBIND_INDEX The container should do comparisons based on a key that may be cast to a netsnmp variable list (netsnmp_variable_list *). This variable list will contain one varbind for each index component.
+TABLE_CONTAINER_KEY_VARBIND_INDEX The container should do comparisons based on a key that may be cast to a netsnmp \fBvariable\fP list (netsnmp_variable_list *). This \fBvariable\fP list will contain one varbind for each index component.
.PP
TABLE_CONTAINER_KEY_VARBIND_RAW (NOTE: unimplemented) While not yet implemented, future plans include passing the request varbind with the full OID to a container.
.PP
@@ -95,47 +88,19 @@
retrieve the container used by the table_container helper
.PP
Definition at line 320 of file table_container.c.
-.PP
-References netsnmp_request_get_list_data().
-.SS "void* netsnmp_container_table_extract_context (\fBnetsnmp_request_info\fP * request)"
-.PP
-find the context data used by the table_container helper
-.PP
-Definition at line 339 of file table_container.c.
-.PP
-References netsnmp_request_get_list_data().
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_container_table_handler_get (\fBnetsnmp_table_registration_info\fP * tabreg, \fBnetsnmp_container\fP * container, char key_type)"
.PP
returns a netsnmp_mib_handler object for the table_container helper
.PP
Definition at line 254 of file table_container.c.
-.PP
-References netsnmp_container_s::compare, netsnmp_mib_handler_s::flags, container_table_data_s::key_type, MIB_HANDLER_AUTO_NEXT, netsnmp_mib_handler_s::myvoid, netsnmp_container_s::ncompare, netsnmp_create_handler(), NULL, snmp_log(), SNMP_MALLOC_TYPEDEF, container_table_data_s::table, and container_table_data_s::tblreg_info.
-.PP
-Referenced by netsnmp_container_table_register().
-.SS "void* netsnmp_container_table_row_extract (\fBnetsnmp_request_info\fP * request)"
-.PP
-find the context data used by the table_container helper
-.PP
-Definition at line 329 of file table_container.c.
-.PP
-References netsnmp_request_get_list_data().
-.PP
-Referenced by _netsnmp_tdata_helper_handler(), and netsnmp_tdata_extract_row().
.SS "void netsnmp_container_table_row_insert (\fBnetsnmp_request_info\fP * request, \fBnetsnmp_index\fP * row)"
.PP
inserts a newly created table_container entry into a request list
.PP
Definition at line 351 of file table_container.c.
-.PP
-References build_oid_noalloc(), netsnmp_table_request_info_s::indexes, netsnmp_create_data_list(), netsnmp_extract_table_info(), netsnmp_request_add_list_data(), netsnmp_request_info_s::next, NULL, netsnmp_request_info_s::prev, netsnmp_request_info_s::processed, and snmp_oid_compare().
-.PP
-Referenced by netsnmp_insert_tdata_row().
.SS "\fBnetsnmp_index\fP* netsnmp_table_index_find_next_row (\fBnetsnmp_container\fP * c, \fBnetsnmp_table_request_info\fP * tblreq)"
.PP
-deprecated, backwards compatability only
-.PP
-expected impact to remove: none
+deprecated, backwards compatability only expected impact to remove: none
.IP "\(bu" 2
used between helpers, shouldn't have been used by end users
.PP
@@ -147,5 +112,6 @@
.PP
Definition at line 721 of file table_container.c.
-.PP
-References NULL.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_table_data.3 b/man/netsnmp_table_data.3
index 29ec28b..0a4b709 100644
--- a/man/netsnmp_table_data.3
+++ b/man/netsnmp_table_data.3
@@ -1,19 +1,20 @@
-.TH "table_data" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "table_data" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-table_data \- Helps you implement a table with datamatted storage.
-
+table_data \-
.PP
+Helps you implement a table with datamatted storage.
+
.SS "Modules"
.in +1c
.ti -1c
.RI "\fBtable_dataset\fP"
.br
-.RI "\fIHelps you implement a table with automatted storage. \fP"
.PP
+.RI "\fIHelps you implement a table with automatted storage. \fP"
.in -1c
.SS "Functions"
@@ -170,8 +171,8 @@
.SH "Detailed Description"
.PP
Helps you implement a table with datamatted storage.
-.PP
-This helper is obsolete. If you are writing a new module, please consider using the table_tdata helper instead.
+
+This helper is obsolete. If you are writing a new \fBmodule\fP, please consider using the table_tdata helper instead.
.PP
This helper helps you implement a table where all the indexes are expected to be stored within the agent itself and not in some external storage location. It can be used to store a list of rows, where a row consists of the indexes to the table and a generic data pointer. You can then implement a subhandler which is passed the exact row definition and data it must return data for or accept data for. Complex GETNEXT handling is greatly simplified in this case.
.SH "Function Documentation"
@@ -181,10 +182,6 @@
creates and returns a pointer to table data set
.PP
Definition at line 52 of file table_data.c.
-.PP
-References netsnmp_table_data_s::name, and SNMP_MALLOC_TYPEDEF.
-.PP
-Referenced by netsnmp_create_table_data_set(), and netsnmp_table_data_create_table().
.SS "\fBnetsnmp_table_row\fP* netsnmp_create_table_data_row (void)"
.PP
creates and returns a pointer to table data set
@@ -194,170 +191,93 @@
\fBdata_set.c\fP.
.PP
Definition at line 62 of file table_data.c.
-.PP
-References SNMP_MALLOC_TYPEDEF.
-.PP
-Referenced by netsnmp_config_parse_add_row(), and netsnmp_table_data_set_create_row_from_defaults().
.SS "\fBnetsnmp_table_data\fP* netsnmp_extract_table (\fBnetsnmp_request_info\fP * request)"
.PP
extracts the table being accessed passed from the table_data helper
.PP
-Definition at line 649 of file table_data.c.
-.PP
-References netsnmp_request_get_list_data().
+Definition at line 653 of file table_data.c.
.SS "\fBnetsnmp_table_row\fP* netsnmp_extract_table_row (\fBnetsnmp_request_info\fP * request)"
.PP
extracts the row being accessed passed from the table_data helper
.PP
-Definition at line 657 of file table_data.c.
-.PP
-References netsnmp_request_get_list_data().
-.PP
-Referenced by netsnmp_extract_table_row_data(), and netsnmp_table_data_set_helper_handler().
+Definition at line 661 of file table_data.c.
.SS "void* netsnmp_extract_table_row_data (\fBnetsnmp_request_info\fP * request)"
.PP
extracts the data from the row being accessed passed from the table_data helper
.PP
-Definition at line 666 of file table_data.c.
-.PP
-References netsnmp_table_row_s::data, netsnmp_extract_table_row(), and NULL.
-.PP
-Referenced by netsnmp_extract_table_data_set_column().
+Definition at line 670 of file table_data.c.
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_table_data_handler (\fBnetsnmp_table_data\fP * table)"
.PP
Creates a table_data handler and returns it.
.PP
-Definition at line 371 of file table_data.c.
-.PP
-References netsnmp_mib_handler_s::flags, MIB_HANDLER_AUTO_NEXT, netsnmp_mib_handler_s::myvoid, netsnmp_create_handler(), netsnmp_table_data_helper_handler(), NULL, and snmp_log().
-.PP
-Referenced by netsnmp_register_table_data().
+Definition at line 375 of file table_data.c.
.SS "NETSNMP_INLINE void netsnmp_insert_table_row (\fBnetsnmp_request_info\fP * request, \fBnetsnmp_table_row\fP * row)"
.PP
inserts a newly created table_data row into a request
.PP
-Definition at line 678 of file table_data.c.
-.PP
-References build_oid_noalloc(), netsnmp_table_request_info_s::indexes, netsnmp_create_data_list(), netsnmp_extract_table_info(), netsnmp_request_add_list_data(), netsnmp_request_info_s::next, NULL, netsnmp_request_info_s::prev, and snmp_oid_compare().
+Definition at line 682 of file table_data.c.
.SS "int netsnmp_register_read_only_table_data (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_table_data\fP * table, \fBnetsnmp_table_registration_info\fP * table_info)"
.PP
registers a handler as a read-only data table If table_info != NULL, it registers it as a normal table too.
.PP
-Definition at line 405 of file table_data.c.
-.PP
-References netsnmp_get_read_only_handler(), netsnmp_inject_handler(), and netsnmp_register_table_data().
+Definition at line 409 of file table_data.c.
.SS "int netsnmp_register_table_data (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_table_data\fP * table, \fBnetsnmp_table_registration_info\fP * table_info)"
.PP
-registers a handler as a data table.
+registers a handler as a data table. If table_info != NULL, it registers it as a normal table too.
.PP
-If table_info != NULL, it registers it as a normal table too.
-.PP
-Definition at line 394 of file table_data.c.
-.PP
-References netsnmp_get_table_data_handler(), netsnmp_inject_handler(), and netsnmp_register_table().
-.PP
-Referenced by netsnmp_register_read_only_table_data(), and netsnmp_register_table_data_set().
+Definition at line 398 of file table_data.c.
.SS "int netsnmp_table_data_add_row (\fBnetsnmp_table_data\fP * table, \fBnetsnmp_table_row\fP * row)"
.PP
-Adds a row of data to a given table (stored in proper lexographical order).
-.PP
-returns SNMPERR_SUCCESS on successful addition. or SNMPERR_GENERR on failure (E.G., indexes already existed)
+Adds a row of data to a given table (stored in proper lexographical order). returns SNMPERR_SUCCESS on successful addition. or SNMPERR_GENERR on failure (E.G., indexes already existed)
.PP
xxx-rks: remove invalid row?
.PP
-Definition at line 130 of file table_data.c.
-.PP
-References netsnmp_table_data_s::first_row, netsnmp_table_row_s::index_oid, netsnmp_table_row_s::index_oid_len, netsnmp_table_row_s::indexes, netsnmp_table_data_s::last_row, netsnmp_table_data_s::name, netsnmp_table_data_generate_index_oid(), netsnmp_table_row_s::next, NULL, netsnmp_table_row_s::prev, snmp_free_varbind(), snmp_log(), snmp_oid_compare(), and netsnmp_table_data_s::store_indexes.
-.PP
-Referenced by netsnmp_config_parse_add_row(), netsnmp_table_data_replace_row(), and netsnmp_table_dataset_add_row().
+Definition at line 134 of file table_data.c.
.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_clone_row (\fBnetsnmp_table_row\fP * row)"
.PP
-clones a data row.
-.PP
-DOES NOT CLONE THE CONTAINED DATA.
+clones a data row. DOES NOT CLONE THE CONTAINED DATA.
.PP
Definition at line 70 of file table_data.c.
-.PP
-References memdup(), NULL, and snmp_clone_varbind().
-.PP
-Referenced by netsnmp_table_data_set_clone_row().
.SS "void* netsnmp_table_data_delete_row (\fBnetsnmp_table_row\fP * row)"
.PP
-deletes a row's memory.
+deletes a row's memory. returns the void data that it doesn't know how to delete.
.PP
-returns the void data that it doesn't know how to delete.
-.PP
-Definition at line 101 of file table_data.c.
-.PP
-References netsnmp_table_row_s::data, netsnmp_table_row_s::index_oid, netsnmp_table_row_s::indexes, NULL, SNMP_FREE, and snmp_free_varbind().
-.PP
-Referenced by netsnmp_table_data_delete_table(), netsnmp_table_data_remove_and_delete_row(), and netsnmp_table_dataset_delete_row().
+Definition at line 105 of file table_data.c.
.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_get (\fBnetsnmp_table_data\fP * table, \fBnetsnmp_variable_list\fP * indexes)"
.PP
finds the data in 'datalist' stored at 'indexes'
.PP
-Definition at line 804 of file table_data.c.
-.PP
-References build_oid_noalloc(), netsnmp_table_data_get_from_oid(), and NULL.
-.PP
-Referenced by netsnmp_table_data_row_get_byidx().
+Definition at line 808 of file table_data.c.
.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_get_first_row (\fBnetsnmp_table_data\fP * table)"
.PP
returns the first row in the table
.PP
-Definition at line 785 of file table_data.c.
-.PP
-References netsnmp_table_data_s::first_row, and NULL.
-.PP
-Referenced by netsnmp_table_data_entry_first(), netsnmp_table_data_row_first(), and netsnmp_table_data_set_get_first_row().
+Definition at line 789 of file table_data.c.
.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_get_from_oid (\fBnetsnmp_table_data\fP * table, oid * searchfor, size_t searchfor_len)"
.PP
finds the data in 'datalist' stored at the searchfor oid
.PP
-Definition at line 818 of file table_data.c.
-.PP
-References netsnmp_table_data_s::first_row, netsnmp_table_row_s::index_oid, netsnmp_table_row_s::index_oid_len, netsnmp_table_row_s::next, NULL, and snmp_oid_compare().
-.PP
-Referenced by netsnmp_table_data_get(), netsnmp_table_data_row_get(), and netsnmp_table_data_row_get_byoid().
+Definition at line 822 of file table_data.c.
.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_get_next_row (\fBnetsnmp_table_data\fP * table, \fBnetsnmp_table_row\fP * row)"
.PP
returns the next row in the table
.PP
-Definition at line 794 of file table_data.c.
-.PP
-References netsnmp_table_row_s::next, and NULL.
-.PP
-Referenced by netsnmp_table_data_row_next(), and netsnmp_table_data_set_get_next_row().
+Definition at line 798 of file table_data.c.
.SS "void* netsnmp_table_data_remove_and_delete_row (\fBnetsnmp_table_data\fP * table, \fBnetsnmp_table_row\fP * row)"
.PP
-removes and frees a row of data to a given table and returns the void *
+removes and frees a row of data to a given table and returns the void * returns the void * data on successful deletion. or NULL on failure (bad arguments)
.PP
-returns the void * data on successful deletion. or NULL on failure (bad arguments)
-.PP
-Definition at line 270 of file table_data.c.
-.PP
-References netsnmp_table_data_delete_row(), netsnmp_table_data_remove_row(), and NULL.
-.PP
-Referenced by netsnmp_table_data_remove_delete_row(), netsnmp_table_dataset_remove_and_delete_row(), and netsnmp_table_dataset_remove_row().
+Definition at line 274 of file table_data.c.
.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_remove_row (\fBnetsnmp_table_data\fP * table, \fBnetsnmp_table_row\fP * row)"
.PP
-removes a row of data to a given table and returns it (no free's called)
+removes a row of data to a given table and returns it (no free's called) returns the row pointer itself on successful removing. or NULL on failure (bad arguments)
.PP
-returns the row pointer itself on successful removing. or NULL on failure (bad arguments)
-.PP
-Definition at line 244 of file table_data.c.
-.PP
-References netsnmp_table_data_s::first_row, netsnmp_table_data_s::last_row, netsnmp_table_row_s::next, NULL, and netsnmp_table_row_s::prev.
-.PP
-Referenced by netsnmp_table_data_remove_and_delete_row(), and netsnmp_table_data_replace_row().
+Definition at line 248 of file table_data.c.
.SS "NETSNMP_INLINE void netsnmp_table_data_replace_row (\fBnetsnmp_table_data\fP * table, \fBnetsnmp_table_row\fP * origrow, \fBnetsnmp_table_row\fP * newrow)"
.PP
-swaps out origrow with newrow.
+swaps out origrow with newrow. This does *not* delete/free anything!
.PP
-This does *not* delete/free anything!
-.PP
-Definition at line 229 of file table_data.c.
-.PP
-References netsnmp_table_data_add_row(), and netsnmp_table_data_remove_row().
-.PP
-Referenced by netsnmp_table_dataset_replace_row().
+Definition at line 233 of file table_data.c.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_table_dataset.3 b/man/netsnmp_table_dataset.3
index 81593a2..a4f9997 100644
--- a/man/netsnmp_table_dataset.3
+++ b/man/netsnmp_table_dataset.3
@@ -1,10 +1,11 @@
-.TH "table_dataset" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "table_dataset" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-table_dataset \- Helps you implement a table with automatted storage.
-
+table_dataset \-
.PP
+Helps you implement a table with automatted storage.
+
.SS "Functions"
.in +1c
@@ -26,11 +27,11 @@
.ti -1c
.RI "NETSNMP_INLINE void \fBnetsnmp_table_dataset_delete_all_data\fP (\fBnetsnmp_table_data_set_storage\fP *data)"
.br
-.RI "\fIdeletes all the data from this node and beyond in the linked list \fP"
+.RI "\fIdeletes all the data from this \fBnode\fP and beyond in the linked list \fP"
.ti -1c
.RI "NETSNMP_INLINE void \fBnetsnmp_table_dataset_delete_row\fP (\fBnetsnmp_table_row\fP *row)"
.br
-.RI "\fIdeletes all the data from this node and beyond in the linked list \fP"
+.RI "\fIdeletes all the data from this \fBnode\fP and beyond in the linked list \fP"
.ti -1c
.RI "NETSNMP_INLINE void \fBnetsnmp_table_dataset_add_row\fP (\fBnetsnmp_table_data_set\fP *table, \fBnetsnmp_table_row\fP *row)"
.br
@@ -126,8 +127,8 @@
.SH "Detailed Description"
.PP
Helps you implement a table with automatted storage.
-.PP
-This helper is obsolete. If you are writing a new module, please consider using the table_dataset2 helper instead.
+
+This helper is obsolete. If you are writing a new \fBmodule\fP, please consider using the table_dataset2 helper instead.
.PP
This handler helps you implement a table where all the data is expected to be stored within the agent itself and not in some external storage location. It handles all MIB requests including GETs, GETNEXTs and SETs. It's possible to simply create a table without actually ever defining a handler to be called when SNMP requests come in. To use the data, you can either attach a sub-handler that merely uses/manipulates the data further when requests come in, or you can loop through it externally when it's actually needed. This handler is most useful in cases where a table is holding configuration data for something which gets triggered via another event.
.PP
@@ -143,33 +144,21 @@
\fBdata_set.c\fP.
.PP
Definition at line 80 of file table_dataset.c.
-.PP
-References netsnmp_create_table_data(), NULL, SNMP_MALLOC_TYPEDEF, and netsnmp_table_data_set_s::table.
-.PP
-Referenced by netsnmp_config_parse_table_set().
.SS "NETSNMP_INLINE \fBnetsnmp_table_data_set\fP* netsnmp_extract_table_data_set (\fBnetsnmp_request_info\fP * request)"
.PP
extracts a netsnmp_table_data_set pointer from a given request
.PP
Definition at line 816 of file table_dataset.c.
-.PP
-References netsnmp_request_get_list_data().
.SS "\fBnetsnmp_table_data_set_storage\fP* netsnmp_extract_table_data_set_column (\fBnetsnmp_request_info\fP * request, unsigned int column)"
.PP
extracts a netsnmp_table_data_set pointer from a given request
.PP
Definition at line 826 of file table_dataset.c.
-.PP
-References netsnmp_extract_table_row_data(), and netsnmp_table_data_set_find_column().
.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_table_data_set_handler (\fBnetsnmp_table_data_set\fP * data_set)"
.PP
Given a netsnmp_table_data_set definition, create a handler for it.
.PP
Definition at line 356 of file table_dataset.c.
-.PP
-References netsnmp_mib_handler_s::flags, MIB_HANDLER_AUTO_NEXT, netsnmp_mib_handler_s::myvoid, netsnmp_create_handler(), netsnmp_table_data_set_helper_handler(), NULL, and snmp_log().
-.PP
-Referenced by netsnmp_register_table_data_set().
.SS "int netsnmp_mark_row_column_writable (\fBnetsnmp_table_row\fP * row, int column, int writable)"
.PP
marks a given column in a row as writable or not.
@@ -178,16 +167,10 @@
.in +1c
\fBdata_set.c\fP.
.PP
-Definition at line 1187 of file table_dataset.c.
-.PP
-References netsnmp_table_data_set_storage_s::column, netsnmp_table_row_s::data, netsnmp_table_data_set_find_column(), netsnmp_table_data_set_storage_s::next, snmp_log(), SNMP_MALLOC_TYPEDEF, and netsnmp_table_data_set_storage_s::writable.
-.PP
-Referenced by netsnmp_config_parse_add_row(), and netsnmp_table_data_set_create_row_from_defaults().
+Definition at line 1192 of file table_dataset.c.
.SS "void netsnmp_register_auto_data_table (\fBnetsnmp_table_data_set\fP * table_set, char * registration_name)"
.PP
-registers a table_dataset so that the 'add_row' snmpd.conf token can be used to add data to this table.
-.PP
-If registration_name is NULL then the name used when the table was created will be used instead.
+registers a table_dataset so that the 'add_row' snmpd.conf token can be used to add data to this table. If registration_name is NULL then the name used when the table was created will be used instead.
.PP
\fBTodo\fP
.RS 4
@@ -201,96 +184,58 @@
\fBdata_set.c\fP.
.PP
Definition at line 853 of file table_dataset.c.
-.PP
-References netsnmp_table_data_s::name, netsnmp_add_list_data(), netsnmp_create_data_list(), NULL, SNMP_MALLOC_TYPEDEF, netsnmp_table_data_set_s::table, and data_set_tables_s::table_set.
-.PP
-Referenced by netsnmp_config_parse_table_set().
.SS "int netsnmp_register_table_data_set (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_table_data_set\fP * data_set, \fBnetsnmp_table_registration_info\fP * table_info)"
.PP
-register a given data_set at a given oid (specified in the netsnmp_handler_registration pointer).
-.PP
-The reginfo->handler->access_method *may* be null if the call doesn't ever want to be called for SNMP operations.
+register a given data_set at a given oid (specified in the netsnmp_handler_registration pointer). The reginfo->handler->access_method *may* be null if the call doesn't ever want to be called for SNMP operations.
.PP
\fBExamples: \fP
.in +1c
\fBdata_set.c\fP.
.PP
Definition at line 382 of file table_dataset.c.
-.PP
-References netsnmp_table_data_set_storage_s::column, netsnmp_table_data_set_s::default_row, netsnmp_table_registration_info_s::indexes, netsnmp_table_data_s::indexes_template, netsnmp_table_registration_info_s::max_column, netsnmp_table_registration_info_s::min_column, netsnmp_get_table_data_set_handler(), netsnmp_inject_handler(), netsnmp_register_table_data(), netsnmp_table_data_set_storage_s::next, NULL, snmp_clone_varbind(), SNMP_MALLOC_TYPEDEF, SNMP_MAX, SNMP_MIN, and netsnmp_table_data_set_s::table.
-.PP
-Referenced by netsnmp_config_parse_table_set().
.SS "int netsnmp_set_row_column (\fBnetsnmp_table_row\fP * row, unsigned int column, int type, const char * value, size_t value_len)"
.PP
-sets a given column in a row with data given a type, value, and length.
-.PP
-Data is memdup'ed by the function.
+sets a given column in a row with data given a type, value, and length. Data is memdup'ed by the function.
.PP
\fBExamples: \fP
.in +1c
\fBdata_set.c\fP.
.PP
-Definition at line 1222 of file table_dataset.c.
-.PP
-References netsnmp_table_data_set_storage_s::column, netsnmp_table_row_s::data, netsnmp_table_data_set_storage_s::data, netsnmp_table_data_set_storage_s::data_len, memdup(), netsnmp_table_data_set_find_column(), netsnmp_table_data_set_storage_s::next, SNMP_FREE, snmp_log(), SNMP_MALLOC_TYPEDEF, netsnmp_table_data_set_storage_s::string, netsnmp_table_data_set_storage_s::type, and netsnmp_table_data_set_storage_s::voidp.
-.PP
-Referenced by netsnmp_config_parse_add_row(), and netsnmp_table_data_set_create_row_from_defaults().
+Definition at line 1227 of file table_dataset.c.
.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_set_clone_row (\fBnetsnmp_table_row\fP * row)"
.PP
clones a dataset row, including all data.
.PP
Definition at line 92 of file table_dataset.c.
-.PP
-References netsnmp_table_row_s::data, memdup(), netsnmp_table_data_clone_row(), netsnmp_table_dataset_delete_row(), netsnmp_table_data_set_storage_s::next, and NULL.
-.PP
-Referenced by netsnmp_table_data_set_helper_handler().
.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_set_create_row_from_defaults (\fBnetsnmp_table_data_set_storage\fP * defrow)"
.PP
creates a new row from an existing defined default set
.PP
Definition at line 226 of file table_dataset.c.
-.PP
-References netsnmp_table_data_set_storage_s::column, netsnmp_table_data_set_storage_s::data, netsnmp_table_data_set_storage_s::data_len, netsnmp_create_table_data_row(), netsnmp_mark_row_column_writable(), netsnmp_set_row_column(), netsnmp_table_data_set_storage_s::next, NULL, netsnmp_table_data_set_storage_s::type, netsnmp_table_data_set_storage_s::voidp, and netsnmp_table_data_set_storage_s::writable.
-.PP
-Referenced by netsnmp_table_data_set_create_newrowstash().
.SS "\fBnetsnmp_table_data_set_storage\fP* netsnmp_table_data_set_find_column (\fBnetsnmp_table_data_set_storage\fP * start, unsigned int column)"
.PP
Finds a column within a given storage set, given the pointer to the start of the storage set list.
.PP
-Definition at line 1175 of file table_dataset.c.
-.PP
-References netsnmp_table_data_set_storage_s::column, and netsnmp_table_data_set_storage_s::next.
-.PP
-Referenced by netsnmp_extract_table_data_set_column(), netsnmp_mark_row_column_writable(), netsnmp_set_row_column(), netsnmp_table_data_set_helper_handler(), and netsnmp_table_set_add_default_row().
+Definition at line 1180 of file table_dataset.c.
.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_set_get_first_row (\fBnetsnmp_table_data_set\fP * table)"
.PP
returns the first row in the table
.PP
-Definition at line 1144 of file table_dataset.c.
-.PP
-References netsnmp_table_data_get_first_row(), and netsnmp_table_data_set_s::table.
+Definition at line 1149 of file table_dataset.c.
.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_set_get_next_row (\fBnetsnmp_table_data_set\fP * table, \fBnetsnmp_table_row\fP * row)"
.PP
returns the next row in the table
.PP
-Definition at line 1151 of file table_dataset.c.
-.PP
-References netsnmp_table_data_get_next_row(), and netsnmp_table_data_set_s::table.
+Definition at line 1156 of file table_dataset.c.
.SS "NETSNMP_INLINE void netsnmp_table_dataset_add_index (\fBnetsnmp_table_data_set\fP * table, u_char type)"
.PP
-adds an index to the table.
-.PP
-Call this repeatly for each index.
+adds an index to the table. Call this repeatly for each index.
.PP
\fBExamples: \fP
.in +1c
\fBdata_set.c\fP.
.PP
-Definition at line 1276 of file table_dataset.c.
-.PP
-References netsnmp_table_data_set_s::table.
-.PP
-Referenced by netsnmp_table_set_add_indexes().
+Definition at line 1281 of file table_dataset.c.
.SS "NETSNMP_INLINE void netsnmp_table_dataset_add_row (\fBnetsnmp_table_data_set\fP * table, \fBnetsnmp_table_row\fP * row)"
.PP
adds a new row to a dataset table
@@ -300,96 +245,57 @@
\fBdata_set.c\fP.
.PP
Definition at line 171 of file table_dataset.c.
-.PP
-References netsnmp_table_data_add_row(), and netsnmp_table_data_set_s::table.
-.PP
-Referenced by netsnmp_table_data_set_helper_handler().
.SS "NETSNMP_INLINE void netsnmp_table_dataset_delete_all_data (\fBnetsnmp_table_data_set_storage\fP * data)"
.PP
-deletes all the data from this node and beyond in the linked list
+deletes all the data from this \fBnode\fP and beyond in the linked list
.PP
Definition at line 148 of file table_dataset.c.
-.PP
-References netsnmp_table_dataset_delete_data().
-.PP
-Referenced by netsnmp_table_dataset_delete_row(), and netsnmp_table_dataset_remove_and_delete_row().
.SS "NETSNMP_INLINE \fBnetsnmp_table_data_set_storage\fP* netsnmp_table_dataset_delete_data (\fBnetsnmp_table_data_set_storage\fP * data)"
.PP
-deletes a single dataset table data.
-.PP
-returns the (possibly still good) next pointer of the deleted data object.
+deletes a single dataset table data. returns the (possibly still good) next pointer of the deleted data object.
.PP
Definition at line 135 of file table_dataset.c.
-.PP
-References netsnmp_table_data_set_storage_s::data, netsnmp_table_data_set_storage_s::next, NULL, SNMP_FREE, and netsnmp_table_data_set_storage_s::voidp.
-.PP
-Referenced by netsnmp_table_dataset_delete_all_data().
.SS "NETSNMP_INLINE void netsnmp_table_dataset_delete_row (\fBnetsnmp_table_row\fP * row)"
.PP
-deletes all the data from this node and beyond in the linked list
+deletes all the data from this \fBnode\fP and beyond in the linked list
.PP
Definition at line 158 of file table_dataset.c.
-.PP
-References netsnmp_table_data_delete_row(), and netsnmp_table_dataset_delete_all_data().
-.PP
-Referenced by netsnmp_table_data_set_clone_row(), and netsnmp_table_data_set_helper_handler().
.SS "NETSNMP_INLINE void netsnmp_table_dataset_remove_and_delete_row (\fBnetsnmp_table_data_set\fP * table, \fBnetsnmp_table_row\fP * row)"
.PP
removes a row from the table and then deletes it (and all its data)
.PP
Definition at line 203 of file table_dataset.c.
-.PP
-References netsnmp_table_data_remove_and_delete_row(), netsnmp_table_dataset_delete_all_data(), and netsnmp_table_data_set_s::table.
-.PP
-Referenced by netsnmp_table_data_set_helper_handler().
.SS "NETSNMP_INLINE void netsnmp_table_dataset_remove_row (\fBnetsnmp_table_data_set\fP * table, \fBnetsnmp_table_row\fP * row)"
.PP
removes a row from the table, but doesn't delete/free the column values
.PP
Definition at line 192 of file table_dataset.c.
-.PP
-References netsnmp_table_data_remove_and_delete_row(), and netsnmp_table_data_set_s::table.
.SS "NETSNMP_INLINE void netsnmp_table_dataset_replace_row (\fBnetsnmp_table_data_set\fP * table, \fBnetsnmp_table_row\fP * origrow, \fBnetsnmp_table_row\fP * newrow)"
.PP
adds a new row to a dataset table
.PP
Definition at line 181 of file table_dataset.c.
-.PP
-References netsnmp_table_data_replace_row(), and netsnmp_table_data_set_s::table.
-.PP
-Referenced by netsnmp_table_data_set_helper_handler().
.SS "int netsnmp_table_set_add_default_row (\fBnetsnmp_table_data_set\fP * table_set, unsigned int column, int type, int writable, void * default_value, size_t default_value_len)"
.PP
-adds a new default row to a table_set.
-.PP
-Arguments should be the table_set, column number, variable type and finally a 1 if it is allowed to be writable, or a 0 if not. If the default_value field is not NULL, it will be used to populate new valuse in that column fro newly created rows. It is copied into the storage template (free your calling argument).
+adds a new default row to a table_set. Arguments should be the table_set, column number, \fBvariable\fP type and finally a 1 if it is allowed to be writable, or a 0 if not. If the default_value field is not NULL, it will be used to populate new valuse in that column fro newly created rows. It is copied into the storage template (free your calling argument).
.PP
returns SNMPERR_SUCCESS or SNMPERR_FAILURE
.PP
Definition at line 252 of file table_dataset.c.
-.PP
-References netsnmp_table_data_set_storage_s::column, netsnmp_table_data_set_storage_s::data, netsnmp_table_data_set_storage_s::data_len, netsnmp_table_data_set_s::default_row, memdup(), netsnmp_table_data_set_find_column(), netsnmp_table_data_set_storage_s::next, NULL, snmp_log(), SNMP_MALLOC_TYPEDEF, netsnmp_table_data_set_storage_s::type, netsnmp_table_data_set_storage_s::voidp, and netsnmp_table_data_set_storage_s::writable.
-.PP
-Referenced by netsnmp_config_parse_table_set(), and netsnmp_table_set_multi_add_default_row().
.SS "void netsnmp_table_set_add_indexes (\fBnetsnmp_table_data_set\fP * tset, ...)"
.PP
-adds multiple indexes to a table_dataset helper object.
+adds multiple indexes to a table_dataset helper object. To end the list, use a 0 after the list of ASN index types.
.PP
-To end the list, use a 0 after the list of ASN index types.
-.PP
-Definition at line 1287 of file table_dataset.c.
-.PP
-References netsnmp_table_dataset_add_index().
+Definition at line 1292 of file table_dataset.c.
.SS "void netsnmp_table_set_multi_add_default_row (\fBnetsnmp_table_data_set\fP * tset, ...)"
.PP
-adds multiple data column definitions to each row.
-.PP
-Functionally, this is a wrapper around calling netsnmp_table_set_add_default_row repeatedly for you.
+adds multiple data column definitions to each row. Functionally, this is a wrapper around calling netsnmp_table_set_add_default_row repeatedly for you.
.PP
\fBExamples: \fP
.in +1c
\fBdata_set.c\fP.
.PP
Definition at line 313 of file table_dataset.c.
-.PP
-References netsnmp_table_set_add_default_row().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_table_generic.3 b/man/netsnmp_table_generic.3
index 96f2e8e..d0e32a3 100644
--- a/man/netsnmp_table_generic.3
+++ b/man/netsnmp_table_generic.3
@@ -1,43 +1,44 @@
-.TH "generic_table_API" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "generic_table_API" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-generic_table_API \- General requirements for a table helper.
-
+generic_table_API \-
.PP
+General requirements for a table helper.
+
.SS "Modules"
.in +1c
.ti -1c
.RI "\fBtable_maintenance\fP"
.br
-.RI "\fIRoutines for maintaining the contents of a table. \fP"
.PP
-.in +1c
+.RI "\fIRoutines for maintaining the contents of a table. \fP"
.ti -1c
.RI "\fBmib_maintenance\fP"
.br
-.RI "\fIRoutines for maintaining a MIB table. \fP"
.PP
-.in +1c
+.RI "\fIRoutines for maintaining a MIB table. \fP"
.ti -1c
.RI "\fBtable_rows\fP"
.br
-.RI "\fIRoutines for working with the rows of a table. \fP"
.PP
-.in +1c
+.RI "\fIRoutines for working with the rows of a table. \fP"
.ti -1c
.RI "\fBtable_indexes\fP"
.br
-.RI "\fIRoutines for working with row indexes. \fP"
.PP
+.RI "\fIRoutines for working with row indexes. \fP"
.in -1c
.SH "Detailed Description"
.PP
General requirements for a table helper.
-.PP
+
A given table helper need not implement the whole of this API, and may need to adjust the prototype of certain routines. But this description provides a suitable standard design framework.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_table_indexes.3 b/man/netsnmp_table_indexes.3
index 8c5091d..11d6d05 100644
--- a/man/netsnmp_table_indexes.3
+++ b/man/netsnmp_table_indexes.3
@@ -1,10 +1,11 @@
-.TH "table_indexes" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "table_indexes" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-table_indexes \- Routines for working with row indexes.
-
+table_indexes \-
.PP
+Routines for working with row indexes.
+
.SS "Functions"
.in +1c
@@ -40,7 +41,6 @@
.SH "Detailed Description"
.PP
Routines for working with row indexes.
-.PP
.SH "Function Documentation"
.PP
.SS "int netsnmp_generic_compare_idx (void * row, \fBnetsnmp_variable_list\fP * index)"
@@ -78,3 +78,6 @@
Report the instance OIDs for a row.
.PP
Definition at line 319 of file table_generic.c.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_table_iterator.3 b/man/netsnmp_table_iterator.3
index 6f9827c..2070cac 100644
--- a/man/netsnmp_table_iterator.3
+++ b/man/netsnmp_table_iterator.3
@@ -1,10 +1,11 @@
-.TH "table_iterator" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "table_iterator" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-table_iterator \- The table iterator helper is designed to simplify the task of writing a table handler for the net-snmp agent when the data being accessed is not in an oid sorted form and must be accessed externally.
-
+table_iterator \-
.PP
+The table iterator helper is designed to simplify the task of writing a table handler for the net-snmp agent when the data being accessed is not in an oid sorted form and must be accessed externally.
+
.SS "Data Structures"
.in +1c
@@ -15,10 +16,6 @@
.RI "struct \fBnetsnmp_iterator_info_s\fP"
.br
.RI "\fIHolds iterator information containing functions which should be called by the iterator_handler to loop over your data set and sort it in a SNMP specific manner. \fP"
-.ti -1c
-.RI "struct \fBnetsnmp_iterator_info_s\fP"
-.br
-.RI "\fIHolds iterator information containing functions which should be called by the iterator_handler to loop over your data set and sort it in a SNMP specific manner. \fP"
.in -1c
.SS "Defines"
@@ -37,7 +34,7 @@
.in +1c
.ti -1c
-.RI "typedef \fBti_cache_info_s\fP \fBti_cache_info\fP"
+.RI "typedef struct \fBti_cache_info_s\fP \fBti_cache_info\fP"
.br
.ti -1c
.RI "typedef \fBnetsnmp_variable_list\fP *( \fBNetsnmp_First_Data_Point\fP )(void **loop_context, void **data_context, \fBnetsnmp_variable_list\fP *, struct \fBnetsnmp_iterator_info_s\fP *)"
@@ -55,7 +52,7 @@
.RI "typedef void( \fBNetsnmp_Free_Data_Context\fP )(void *, struct \fBnetsnmp_iterator_info_s\fP *)"
.br
.ti -1c
-.RI "typedef \fBnetsnmp_iterator_info_s\fP \fBnetsnmp_iterator_info\fP"
+.RI "typedef struct \fBnetsnmp_iterator_info_s\fP \fBnetsnmp_iterator_info\fP"
.br
.RI "\fITypedefs the \fBnetsnmp_iterator_info_s\fP struct into netsnmp_iterator_info. \fP"
.in -1c
@@ -63,7 +60,7 @@
.in +1c
.ti -1c
-.RI "\fBnetsnmp_iterator_info\fP * \fBnetsnmp_iterator_create_table\fP (\fBNetsnmp_First_Data_Point\fP *firstDP, \fBNetsnmp_Next_Data_Point\fP *nextDP, \fBNetsnmp_First_Data_Point\fP *getidx, \fBnetsnmp_variable_list\fP *indexes)"
+.RI "\fBnetsnmp_iterator_info\fP * \fBnetsnmp_iterator_create_table\fP (Netsnmp_First_Data_Point *firstDP, Netsnmp_Next_Data_Point *nextDP, Netsnmp_First_Data_Point *getidx, \fBnetsnmp_variable_list\fP *indexes)"
.br
.ti -1c
.RI "void \fBnetsnmp_iterator_delete_table\fP (\fBnetsnmp_iterator_info\fP *iinfo)"
@@ -116,19 +113,19 @@
.in +1c
.ti -1c
-.RI "\fBNetsnmp_Node_Handler\fP \fBnetsnmp_table_iterator_helper_handler\fP"
+.RI "Netsnmp_Node_Handler \fBnetsnmp_table_iterator_helper_handler\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
The table iterator helper is designed to simplify the task of writing a table handler for the net-snmp agent when the data being accessed is not in an oid sorted form and must be accessed externally.
-.PP
-Functionally, it is a specialized version of the more generic table helper but easies the burden of GETNEXT processing by manually looping through all the data indexes retrieved through function calls which should be supplied by the module that wishes help. The module the table_iterator helps should, afterwards, never be called for the case of 'MODE_GETNEXT' and only for the GET and SET related modes instead.
+
+Functionally, it is a specialized version of the more generic table helper but easies the burden of GETNEXT processing by manually looping through all the data indexes retrieved through function calls which should be supplied by the \fBmodule\fP that wishes help. The \fBmodule\fP the table_iterator helps should, afterwards, never be called for the case of 'MODE_GETNEXT' and only for the GET and SET related modes instead.
.PP
The fundamental notion between the table iterator is that it allows your code to iterate over each 'row' within your data storage mechanism, without requiring that it be sorted in a SNMP-index-compliant manner. Through the get_first_data_point and get_next_data_point hooks, the table_iterator helper will repeatedly call your hooks to find the 'proper' row of data that needs processing. The following concepts are important:
.PP
.IP "\(bu" 2
-A loop context is a pointer which indicates where in the current processing of a set of rows you currently are. Allows the get_*_data_point routines to move from one row to the next, once the iterator handler has identified the appropriate row for this request, the job of the loop context is done. The most simple example would be a pointer to an integer which simply counts rows from 1 to X. More commonly, it might be a pointer to a linked list node, or someother internal or external reference to a data set (file seek value, array pointer, ...). If allocated during iteration, either the free_loop_context_at_end (preferably) or the free_loop_context pointers should be set.
+A loop context is a pointer which indicates where in the current processing of a set of rows you currently are. Allows the get_*_data_point routines to move from one row to the next, once the iterator handler has identified the appropriate row for this request, the job of the loop context is done. The most simple example would be a pointer to an integer which simply counts rows from 1 to X. More commonly, it might be a pointer to a linked list \fBnode\fP, or someother internal or external reference to a data set (file seek value, array pointer, ...). If allocated during iteration, either the free_loop_context_at_end (preferably) or the free_loop_context pointers should be set.
.PP
.PP
.IP "\(bu" 2
@@ -138,7 +135,7 @@
The table iterator operates in a series of steps that call your code hooks from your netsnmp_iterator_info registration pointer.
.PP
.IP "\(bu" 2
-the get_first_data_point hook is called at the beginning of processing. It should set the variable list to a list of indexes for the given table. It should also set the loop_context and maybe a data_context which you will get a pointer back to when it needs to call your code to retrieve actual data later. The list of indexes should be returned after being update.
+the get_first_data_point hook is called at the beginning of processing. It should set the \fBvariable\fP list to a list of indexes for the given table. It should also set the loop_context and maybe a data_context which you will get a pointer back to when it needs to call your code to retrieve actual data later. The list of indexes should be returned after being update.
.PP
.PP
.IP "\(bu" 2
@@ -150,14 +147,11 @@
.SS "struct \fBnetsnmp_iterator_info_s\fP \fBnetsnmp_iterator_info\fP"
.PP
Typedefs the \fBnetsnmp_iterator_info_s\fP struct into netsnmp_iterator_info.
-.PP
.SH "Function Documentation"
.PP
.SS "void * netsnmp_extract_iterator_context (\fBnetsnmp_request_info\fP * request)"
.PP
-extracts the table_iterator specific data from a request.
-.PP
-This function extracts the table iterator specific data from a netsnmp_request_info object. Calls netsnmp_request_get_list_data with request->parent_data set with data from a request that was added previously by a module and TABLE_ITERATOR_NAME handler name.
+extracts the table_iterator specific data from a request. This function extracts the table iterator specific data from a netsnmp_request_info object. Calls netsnmp_request_get_list_data with request->parent_data set with data from a request that was added previously by a \fBmodule\fP and TABLE_ITERATOR_NAME handler name.
.PP
\fBParameters:\fP
.RS 4
@@ -170,31 +164,15 @@
.RE
.PP
-.PP
-Definition at line 234 of file table_iterator.c.
-.PP
-References netsnmp_request_get_list_data(), and TABLE_ITERATOR_NAME.
.SS "\fBnetsnmp_mib_handler\fP * netsnmp_get_table_iterator_handler (\fBnetsnmp_iterator_info\fP * iinfo)"
.PP
returns a netsnmp_mib_handler object for the table_iterator helper
-.PP
-Definition at line 169 of file table_iterator.c.
-.PP
-References netsnmp_mib_handler_s::myvoid, netsnmp_create_handler(), netsnmp_table_iterator_helper_handler, NULL, and TABLE_ITERATOR_NAME.
-.PP
-Referenced by netsnmp_register_table_iterator().
.SS "void netsnmp_insert_iterator_context (\fBnetsnmp_request_info\fP * request, void * data)"
.PP
inserts table_iterator specific data for a newly created row into a request
-.PP
-Definition at line 242 of file table_iterator.c.
-.PP
-References build_oid_noalloc(), netsnmp_table_request_info_s::indexes, netsnmp_create_data_list(), netsnmp_extract_table_info(), netsnmp_request_add_list_data(), netsnmp_request_info_s::next, NULL, netsnmp_request_info_s::prev, snmp_oid_compare(), and TABLE_ITERATOR_NAME.
.SS "int netsnmp_register_table_iterator (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_iterator_info\fP * iinfo)"
.PP
-Creates and registers a table iterator helper handler calling netsnmp_create_handler with a handler name set to TABLE_ITERATOR_NAME and access method, netsnmp_table_iterator_helper_handler.
-.PP
-If NOT_SERIALIZED is not defined the function injects the serialize handler into the calling chain prior to calling netsnmp_register_table.
+Creates and registers a table iterator helper handler calling netsnmp_create_handler with a handler name set to TABLE_ITERATOR_NAME and access method, netsnmp_table_iterator_helper_handler. If NOT_SERIALIZED is not defined the function injects the serialize handler into the calling chain prior to calling netsnmp_register_table.
.PP
\fBParameters:\fP
.RS 4
@@ -209,7 +187,6 @@
.RE
.PP
-.PP
-Definition at line 205 of file table_iterator.c.
-.PP
-References HANDLER_CAN_STASH, netsnmp_table_registration_info_s::indexes, netsnmp_iterator_info_s::indexes, netsnmp_handler_registration_s::modes, netsnmp_get_table_iterator_handler(), netsnmp_inject_handler(), netsnmp_register_table(), snmp_clone_varbind(), and netsnmp_iterator_info_s::table_reginfo.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_table_iterator.h.3 b/man/netsnmp_table_iterator.h.3
index 1b0499d..94de2b3 100644
--- a/man/netsnmp_table_iterator.h.3
+++ b/man/netsnmp_table_iterator.h.3
@@ -1,4 +1,4 @@
-.TH "table_iterator.h" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "table_iterator.h" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -43,7 +43,7 @@
.RI "typedef void( \fBNetsnmp_Free_Data_Context\fP )(void *, struct \fBnetsnmp_iterator_info_s\fP *)"
.br
.ti -1c
-.RI "typedef \fBnetsnmp_iterator_info_s\fP \fBnetsnmp_iterator_info\fP"
+.RI "typedef struct \fBnetsnmp_iterator_info_s\fP \fBnetsnmp_iterator_info\fP"
.br
.RI "\fITypedefs the \fBnetsnmp_iterator_info_s\fP struct into netsnmp_iterator_info. \fP"
.in -1c
@@ -98,7 +98,7 @@
.in +1c
.ti -1c
-.RI "\fBNetsnmp_Node_Handler\fP \fBnetsnmp_table_iterator_helper_handler\fP"
+.RI "Netsnmp_Node_Handler \fBnetsnmp_table_iterator_helper_handler\fP"
.br
.in -1c
.SH "Detailed Description"
diff --git a/man/netsnmp_table_maintenance.3 b/man/netsnmp_table_maintenance.3
index b8dace1..416f81c 100644
--- a/man/netsnmp_table_maintenance.3
+++ b/man/netsnmp_table_maintenance.3
@@ -1,10 +1,11 @@
-.TH "table_maintenance" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "table_maintenance" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-table_maintenance \- Routines for maintaining the contents of a table.
-
+table_maintenance \-
.PP
+Routines for maintaining the contents of a table.
+
.SS "Functions"
.in +1c
@@ -52,7 +53,7 @@
.SH "Detailed Description"
.PP
Routines for maintaining the contents of a table.
-.PP
+
This would typically be part of implementing an SNMP MIB, but could potentially also be used for a standalone table.
.PP
This section of the generic API is primarily relevant to table helpers where the representation of the table is constructed and maintained within the helper itself. 'External' tables will typically look after such aspects directly, although this section of the abstract API framework could also help direct the design of such table-specific implementations.
@@ -70,39 +71,29 @@
Definition at line 82 of file table_generic.c.
.SS "int netsnmp_generic_copy_row (void * dst_row, void * src_row)"
.PP
-Copy the contents of one row into another.
-.PP
-The destination row structure should be created before this routine is called.
+Copy the contents of one row into another. The destination row structure should be created before this routine is called.
.PP
Definition at line 90 of file table_generic.c.
.SS "void* netsnmp_generic_create_row (void)"
.PP
-Create a new row structure suitable for this style of table.
-.PP
-Note that this would typically be a 'standalone' row, and would not automatically be inserted into an actual table.
+Create a new row structure suitable for this style of table. Note that this would typically be a 'standalone' row, and would not automatically be inserted into an actual table.
.PP
Definition at line 76 of file table_generic.c.
.SS "void* netsnmp_generic_create_table (const char * name, int flags)"
.PP
-Create a structure to represent the table.
-.PP
-This could be as simple as the head of a linked list, or a more complex container structure. The 'name' field would typically be used to distinguish between several tables implemented using the same table helper. The 'flags' field would be used to control various (helper-specific) aspects of table behaviour.
+Create a structure to represent the table. This could be as simple as the head of a linked list, or a more complex container structure. The 'name' field would typically be used to distinguish between several tables implemented using the same table helper. The 'flags' field would be used to control various (helper-specific) aspects of table behaviour.
.PP
The table structure returned should typically be regarded as an opaque, private structure. All operations on the content of the table should ideally use the appropriate routines from this API.
.PP
Definition at line 60 of file table_generic.c.
.SS "void netsnmp_generic_delete_row (void * row)"
.PP
-Delete a row data structure.
-.PP
-The row should be removed from any relevant table(s) before this routine is called.
+Delete a row data structure. The row should be removed from any relevant table(s) before this routine is called.
.PP
Definition at line 98 of file table_generic.c.
.SS "void netsnmp_generic_delete_table (void * table)"
.PP
-Release the structure representing a table.
-.PP
-Any rows still contained within the table should also be removed and deleted.
+Release the structure representing a table. Any rows still contained within the table should also be removed and deleted.
.PP
Definition at line 68 of file table_generic.c.
.SS "void netsnmp_generic_remove_delete_row (void * table, void * row)"
@@ -112,15 +103,14 @@
Definition at line 127 of file table_generic.c.
.SS "void* netsnmp_generic_remove_row (void * table, void * row)"
.PP
-Remove a row from the table.
-.PP
-The data structure for the row should not be released, and would be the return value of this routine.
+Remove a row from the table. The data structure for the row should not be released, and would be the return value of this routine.
.PP
Definition at line 121 of file table_generic.c.
.SS "int netsnmp_generic_replace_row (void * table, void * old_row, void * new_row)"
.PP
-Replace one row with another in the table.
-.PP
-This will typically (but not necessarily) involve two rows sharing the same index information (e.g. to implement update/restore-style SET behaviour).
+Replace one row with another in the table. This will typically (but not necessarily) involve two rows sharing the same index information (e.g. to implement update/restore-style SET behaviour).
.PP
Definition at line 113 of file table_generic.c.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_table_rows.3 b/man/netsnmp_table_rows.3
index 027933a..63b39f0 100644
--- a/man/netsnmp_table_rows.3
+++ b/man/netsnmp_table_rows.3
@@ -1,10 +1,11 @@
-.TH "table_rows" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "table_rows" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-table_rows \- Routines for working with the rows of a table.
-
+table_rows \-
.PP
+Routines for working with the rows of a table.
+
.SS "Functions"
.in +1c
@@ -44,7 +45,6 @@
.SH "Detailed Description"
.PP
Routines for working with the rows of a table.
-.PP
.SH "Function Documentation"
.PP
.SS "int netsnmp_generic_row_count (void * table)"
@@ -59,9 +59,7 @@
Definition at line 228 of file table_generic.c.
.SS "void* netsnmp_generic_row_get (void * table, void * row)"
.PP
-Retrieve the given row from the table.
-.PP
-This could either be the same data pointer, passed in, or a separate row structure sharing the same index values (or NULL).
+Retrieve the given row from the table. This could either be the same data pointer, passed in, or a separate row structure sharing the same index values (or NULL).
.PP
This routine also provides a means to tell whether a given row is present in the table.
.PP
@@ -78,9 +76,7 @@
Definition at line 270 of file table_generic.c.
.SS "void* netsnmp_generic_row_next (void * table, void * row)"
.PP
-Retrieve the following row from the table.
-.PP
-If the specified row is not present, this routine should return the entry next after the position this row would have occupied.
+Retrieve the following row from the table. If the specified row is not present, this routine should return the entry next after the position this row would have occupied.
.PP
Definition at line 249 of file table_generic.c.
.SS "void* netsnmp_generic_row_next_byidx (void * table, \fBnetsnmp_variable_list\fP * indexes)"
@@ -93,3 +89,6 @@
Retrieve the next row after the specified instance OIDs.
.PP
Definition at line 276 of file table_generic.c.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_tdata.3 b/man/netsnmp_tdata.3
index a8898d4..f17d9a5 100644
--- a/man/netsnmp_tdata.3
+++ b/man/netsnmp_tdata.3
@@ -1,10 +1,11 @@
-.TH "tdata" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "tdata" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-tdata \- Implement a table with datamatted storage.
-
+tdata \-
.PP
+Implement a table with datamatted storage.
+
.SS "Functions"
.in +1c
@@ -136,13 +137,13 @@
.in +1c
.ti -1c
-.RI "\fBNetsnmp_Node_Handler\fP \fB_netsnmp_tdata_helper_handler\fP"
+.RI "Netsnmp_Node_Handler \fB_netsnmp_tdata_helper_handler\fP"
.br
.in -1c
.SH "Detailed Description"
.PP
Implement a table with datamatted storage.
-.PP
+
This helper helps you implement a table where all the rows are expected to be stored within the agent itself and not in some external storage location. It can be used to store a list of rows, where a row consists of the indexes to the table and a generic data pointer. You can then implement a subhandler which is passed the exact row definition and data it must return data for or accept data for. Complex GETNEXT handling is greatly simplified in this case.
.SH "Function Documentation"
.PP
@@ -151,215 +152,136 @@
Creates a tdata handler and returns it.
.PP
Definition at line 284 of file table_tdata.c.
-.PP
-References _netsnmp_tdata_helper_handler, netsnmp_mib_handler_s::flags, MIB_HANDLER_AUTO_NEXT, netsnmp_mib_handler_s::myvoid, netsnmp_create_handler(), NULL, and snmp_log().
-.PP
-Referenced by netsnmp_tdata_register().
.SS "NETSNMP_INLINE void netsnmp_insert_tdata_row (\fBnetsnmp_request_info\fP * request, \fBnetsnmp_tdata_row\fP * row)"
.PP
inserts a newly created tdata row into a request
.PP
Definition at line 399 of file table_tdata.c.
-.PP
-References netsnmp_container_table_row_insert().
.SS "int netsnmp_tdata_add_row (\fBnetsnmp_tdata\fP * table, \fBnetsnmp_tdata_row\fP * row)"
.PP
-Adds a row to the given table (stored in proper lexographical order).
-.PP
-returns SNMPERR_SUCCESS on successful addition. or SNMPERR_GENERR on failure (E.G., indexes already existed)
+Adds a row to the given table (stored in proper lexographical order). returns SNMPERR_SUCCESS on successful addition. or SNMPERR_GENERR on failure (E.G., indexes already existed)
.PP
Definition at line 186 of file table_tdata.c.
-.PP
-References _netsnmp_tdata_generate_index_oid(), netsnmp_tdata_s::container, netsnmp_tdata_s::flags, netsnmp_tdata_row_s::indexes, netsnmp_tdata_s::name, NULL, netsnmp_tdata_row_s::oid_index, netsnmp_index_s::oids, snmp_free_varbind(), and snmp_log().
-.PP
-Referenced by netsnmp_tdata_replace_row().
.SS "\fBnetsnmp_tdata_row\fP* netsnmp_tdata_clone_row (\fBnetsnmp_tdata_row\fP * row)"
.PP
-clones a 'tdata' row.
-.PP
-DOES NOT CLONE THE TABLE-SPECIFIC ENTRY DATA.
+clones a 'tdata' row. DOES NOT CLONE THE TABLE-SPECIFIC ENTRY DATA.
.PP
Definition at line 92 of file table_tdata.c.
-.PP
-References memdup(), NULL, snmp_clone_varbind(), SNMP_FREE, and snmp_free_varbind().
.SS "int netsnmp_tdata_compare_idx (\fBnetsnmp_tdata_row\fP * row, \fBnetsnmp_variable_list\fP * indexes)"
.PP
compare a row with the given index values
.PP
Definition at line 518 of file table_tdata.c.
-.PP
-References build_oid_noalloc(), netsnmp_tdata_compare_oid(), and NULL.
.SS "int netsnmp_tdata_compare_oid (\fBnetsnmp_tdata_row\fP * row, oid * compareto, size_t compareto_len)"
.PP
compare a row with the given index OID
.PP
Definition at line 531 of file table_tdata.c.
-.PP
-References netsnmp_index_s::len, netsnmp_index_s::oids, and snmp_oid_compare().
-.PP
-Referenced by netsnmp_tdata_compare_idx().
.SS "int netsnmp_tdata_copy_row (\fBnetsnmp_tdata_row\fP * dst_row, \fBnetsnmp_tdata_row\fP * src_row)"
.PP
-copy the contents of a 'tdata' row.
-.PP
-DOES NOT COPY THE TABLE-SPECIFIC ENTRY DATA.
+copy the contents of a 'tdata' row. DOES NOT COPY THE TABLE-SPECIFIC ENTRY DATA.
.PP
Definition at line 129 of file table_tdata.c.
-.PP
-References memdup(), and snmp_clone_varbind().
.SS "\fBnetsnmp_tdata_row\fP* netsnmp_tdata_create_row (void)"
.PP
creates and returns a pointer to new row data structure
.PP
Definition at line 84 of file table_tdata.c.
-.PP
-References SNMP_MALLOC_TYPEDEF.
.SS "\fBnetsnmp_tdata\fP* netsnmp_tdata_create_table (const char * name, long flags)"
.PP
creates and returns a 'tdata' table data structure
.PP
Definition at line 54 of file table_tdata.c.
-.PP
-References netsnmp_tdata_s::container, netsnmp_tdata_s::name, NULL, and SNMP_MALLOC_TYPEDEF.
.SS "void* netsnmp_tdata_delete_row (\fBnetsnmp_tdata_row\fP * row)"
.PP
deletes the memory used by the specified row returns the table-specific entry data (that it doesn't know how to delete)
.PP
Definition at line 157 of file table_tdata.c.
-.PP
-References netsnmp_tdata_row_s::data, netsnmp_tdata_row_s::indexes, NULL, netsnmp_tdata_row_s::oid_index, netsnmp_index_s::oids, SNMP_FREE, and snmp_free_varbind().
-.PP
-Referenced by netsnmp_tdata_remove_and_delete_row().
.SS "void netsnmp_tdata_delete_table (\fBnetsnmp_tdata\fP * table)"
.PP
creates and returns a 'tdata' table data structure
.PP
Definition at line 68 of file table_tdata.c.
-.PP
-References netsnmp_tdata_s::container, netsnmp_tdata_s::name, and SNMP_FREE.
.SS "\fBnetsnmp_container\fP* netsnmp_tdata_extract_container (\fBnetsnmp_request_info\fP * request)"
.PP
extracts the tdata container from the request structure
.PP
Definition at line 370 of file table_tdata.c.
-.PP
-References netsnmp_tdata_s::container, netsnmp_request_get_list_data(), and NULL.
.SS "void* netsnmp_tdata_extract_entry (\fBnetsnmp_request_info\fP * request)"
.PP
extracts the (table-specific) entry being accessed from the request structure
.PP
Definition at line 387 of file table_tdata.c.
-.PP
-References netsnmp_tdata_row_s::data, netsnmp_tdata_extract_row(), and NULL.
.SS "\fBnetsnmp_tdata_row\fP* netsnmp_tdata_extract_row (\fBnetsnmp_request_info\fP * request)"
.PP
extracts the tdata row being accessed from the request structure
.PP
Definition at line 379 of file table_tdata.c.
-.PP
-References netsnmp_container_table_row_extract().
-.PP
-Referenced by netsnmp_tdata_extract_entry().
.SS "\fBnetsnmp_tdata\fP* netsnmp_tdata_extract_table (\fBnetsnmp_request_info\fP * request)"
.PP
extracts the tdata table from the request structure
.PP
Definition at line 362 of file table_tdata.c.
-.PP
-References netsnmp_request_get_list_data().
.SS "int netsnmp_tdata_register (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_tdata\fP * table, \fBnetsnmp_table_registration_info\fP * table_info)"
.PP
registers a tdata-based MIB table
.PP
Definition at line 351 of file table_tdata.c.
-.PP
-References netsnmp_tdata_s::container, netsnmp_container_table_register(), netsnmp_get_tdata_handler(), and netsnmp_inject_handler().
.SS "void* netsnmp_tdata_remove_and_delete_row (\fBnetsnmp_tdata\fP * table, \fBnetsnmp_tdata_row\fP * row)"
.PP
-removes and frees a row of the given table and returns the table-specific entry data
-.PP
-returns the void * pointer on successful deletion. or NULL on failure (bad arguments)
+removes and frees a row of the given table and returns the table-specific entry data returns the void * pointer on successful deletion. or NULL on failure (bad arguments)
.PP
Definition at line 260 of file table_tdata.c.
-.PP
-References netsnmp_tdata_delete_row(), netsnmp_tdata_remove_row(), and NULL.
.SS "\fBnetsnmp_tdata_row\fP* netsnmp_tdata_remove_row (\fBnetsnmp_tdata\fP * table, \fBnetsnmp_tdata_row\fP * row)"
.PP
-removes a row from the given table and returns it (no free's called)
-.PP
-returns the row pointer itself on successful removing. or NULL on failure (bad arguments)
+removes a row from the given table and returns it (no free's called) returns the row pointer itself on successful removing. or NULL on failure (bad arguments)
.PP
Definition at line 242 of file table_tdata.c.
-.PP
-References netsnmp_tdata_s::container, and NULL.
-.PP
-Referenced by netsnmp_tdata_remove_and_delete_row(), and netsnmp_tdata_replace_row().
.SS "void netsnmp_tdata_replace_row (\fBnetsnmp_tdata\fP * table, \fBnetsnmp_tdata_row\fP * origrow, \fBnetsnmp_tdata_row\fP * newrow)"
.PP
-swaps out origrow with newrow.
-.PP
-This does *not* delete/free anything!
+swaps out origrow with newrow. This does *not* delete/free anything!
.PP
Definition at line 227 of file table_tdata.c.
-.PP
-References netsnmp_tdata_add_row(), and netsnmp_tdata_remove_row().
.SS "void* netsnmp_tdata_row_entry (\fBnetsnmp_tdata_row\fP * row)"
.PP
returns the (table-specific) entry data for a given row
.PP
Definition at line 414 of file table_tdata.c.
-.PP
-References netsnmp_tdata_row_s::data, and NULL.
.SS "\fBnetsnmp_tdata_row\fP* netsnmp_tdata_row_first (\fBnetsnmp_tdata\fP * table)"
.PP
returns the first row in the table
.PP
Definition at line 424 of file table_tdata.c.
-.PP
-References netsnmp_tdata_s::container.
.SS "\fBnetsnmp_tdata_row\fP* netsnmp_tdata_row_get (\fBnetsnmp_tdata\fP * table, \fBnetsnmp_tdata_row\fP * row)"
.PP
finds a row in the 'tdata' table given another row
.PP
Definition at line 431 of file table_tdata.c.
-.PP
-References netsnmp_tdata_s::container.
.SS "\fBnetsnmp_tdata_row\fP* netsnmp_tdata_row_get_byidx (\fBnetsnmp_tdata\fP * table, \fBnetsnmp_variable_list\fP * indexes)"
.PP
finds a row in the 'tdata' table given the index values
.PP
Definition at line 447 of file table_tdata.c.
-.PP
-References build_oid_noalloc(), netsnmp_tdata_row_get_byoid(), and NULL.
.SS "\fBnetsnmp_tdata_row\fP* netsnmp_tdata_row_get_byoid (\fBnetsnmp_tdata\fP * table, oid * searchfor, size_t searchfor_len)"
.PP
finds a row in the 'tdata' table given the index OID
.PP
Definition at line 460 of file table_tdata.c.
-.PP
-References netsnmp_tdata_s::container, netsnmp_index_s::len, NULL, and netsnmp_index_s::oids.
-.PP
-Referenced by netsnmp_tdata_row_get_byidx().
.SS "\fBnetsnmp_tdata_row\fP* netsnmp_tdata_row_next (\fBnetsnmp_tdata\fP * table, \fBnetsnmp_tdata_row\fP * row)"
.PP
returns the next row in the table
.PP
Definition at line 439 of file table_tdata.c.
-.PP
-References netsnmp_tdata_s::container.
.SS "\fBnetsnmp_tdata_row\fP* netsnmp_tdata_row_next_byidx (\fBnetsnmp_tdata\fP * table, \fBnetsnmp_variable_list\fP * indexes)"
.PP
finds the lexically next row in the 'tdata' table given the index values
.PP
Definition at line 475 of file table_tdata.c.
-.PP
-References build_oid_noalloc(), netsnmp_tdata_row_next_byoid(), and NULL.
.SS "\fBnetsnmp_tdata_row\fP* netsnmp_tdata_row_next_byoid (\fBnetsnmp_tdata\fP * table, oid * searchfor, size_t searchfor_len)"
.PP
finds the lexically next row in the 'tdata' table given the index OID
.PP
Definition at line 489 of file table_tdata.c.
-.PP
-References netsnmp_tdata_s::container, netsnmp_index_s::len, NULL, and netsnmp_index_s::oids.
-.PP
-Referenced by netsnmp_tdata_row_next_byidx().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_util.3 b/man/netsnmp_util.3
index 253476e..877107b 100644
--- a/man/netsnmp_util.3
+++ b/man/netsnmp_util.3
@@ -1,4 +1,4 @@
-.TH "Memory Utility Routines" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "Memory Utility Routines" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -7,7 +7,7 @@
.in +1c
.ti -1c
-.RI "#define \fBSNMP_MAXPATH\fP 1024"
+.RI "#define \fBSNMP_MAXPATH\fP PATH_MAX"
.br
.ti -1c
.RI "#define \fBSNMP_MAXBUF\fP (1024 * 4)"
@@ -90,12 +90,6 @@
.RI "#define \fBSNMP_MACRO_VAL_TO_STR_PRIV\fP(s) #s"
.br
.ti -1c
-.RI "#define \fBFALSE\fP 0"
-.br
-.ti -1c
-.RI "#define \fBTRUE\fP 1"
-.br
-.ti -1c
.RI "#define \fBQUITFUN\fP(e, l)"
.br
.ti -1c
@@ -179,35 +173,35 @@
.RI "char * \fBdump_snmpEngineID\fP (const u_char *buf, size_t *buflen)"
.br
.ti -1c
-.RI "\fBmarker_t\fP \fBatime_newMarker\fP (void)"
+.RI "marker_t \fBatime_newMarker\fP (void)"
.br
.RI "\fIcreate a new time marker. \fP"
.ti -1c
-.RI "void \fBatime_setMarker\fP (\fBmarker_t\fP pm)"
+.RI "void \fBatime_setMarker\fP (marker_t pm)"
.br
.RI "\fIset a time marker. \fP"
.ti -1c
-.RI "long \fBatime_diff\fP (\fBmarker_t\fP first, \fBmarker_t\fP second)"
+.RI "long \fBatime_diff\fP (marker_t first, marker_t second)"
.br
.RI "\fIReturns the difference (in msec) between the two markers. \fP"
.ti -1c
-.RI "u_long \fBuatime_diff\fP (\fBmarker_t\fP first, \fBmarker_t\fP second)"
+.RI "u_long \fBuatime_diff\fP (marker_t first, marker_t second)"
.br
.RI "\fIReturns the difference (in u_long msec) between the two markers. \fP"
.ti -1c
-.RI "u_long \fBuatime_hdiff\fP (\fBmarker_t\fP first, \fBmarker_t\fP second)"
+.RI "u_long \fBuatime_hdiff\fP (marker_t first, marker_t second)"
.br
.RI "\fIReturns the difference (in u_long 1/100th secs) between the two markers (functionally this is what sysUpTime needs). \fP"
.ti -1c
-.RI "int \fBatime_ready\fP (\fBmarker_t\fP pm, int deltaT)"
+.RI "int \fBatime_ready\fP (marker_t pm, int deltaT)"
.br
.RI "\fITest: Has (marked time plus delta) exceeded current time (in msec) ? Returns 0 if test fails or cannot be tested (no marker). \fP"
.ti -1c
-.RI "int \fBuatime_ready\fP (\fBmarker_t\fP pm, unsigned int deltaT)"
+.RI "int \fBuatime_ready\fP (marker_t pm, unsigned int deltaT)"
.br
.RI "\fITest: Has (marked time plus delta) exceeded current time (in msec) ? Returns 0 if test fails or cannot be tested (no marker). \fP"
.ti -1c
-.RI "int \fBmarker_tticks\fP (\fBmarker_t\fP pm)"
+.RI "int \fBmarker_tticks\fP (marker_t pm)"
.br
.RI "\fIReturn the number of timeTicks since the given marker. \fP"
.ti -1c
@@ -216,19 +210,17 @@
.ti -1c
.RI "char * \fBnetsnmp_getenv\fP (const char *name)"
.br
-.RI "\fINon Windows: Returns a pointer to the desired environment variable or NULL if the environment variable does not exist. \fP"
+.RI "\fINon Windows: Returns a pointer to the desired environment \fBvariable\fP or NULL if the environment \fBvariable\fP does not exist. \fP"
.ti -1c
.RI "int \fBnetsnmp_addrstr_hton\fP (char *ptr, size_t len)"
.br
.in -1c
.SH "Define Documentation"
.PP
-.SS "#define DIFFTIMEVAL(now, then, diff)"
-.PP
-\fBValue:\fP
+.SS "#define DIFFTIMEVAL(now, then, diff)"\fBValue:\fP
.PP
.nf
-{ \
+{ \
now.tv_sec--; \
now.tv_usec += 1000000L; \
diff.tv_sec = now.tv_sec - then.tv_sec; \
@@ -241,9 +233,7 @@
.fi
.PP
Definition at line 131 of file tools.h.
-.SS "#define ISTRANSFORM(ttype, toid)"
-.PP
-\fBValue:\fP
+.SS "#define ISTRANSFORM(ttype, toid)"\fBValue:\fP
.PP
.nf
!snmp_oid_compare(ttype, USM_LENGTH_OID_TRANSFORM, \
@@ -251,9 +241,7 @@
.fi
.PP
Definition at line 150 of file tools.h.
-.SS "#define QUITFUN(e, l)"
-.PP
-\fBValue:\fP
+.SS "#define QUITFUN(e, l)"\fBValue:\fP
.PP
.nf
if ( (e) != SNMPERR_SUCCESS) { \
@@ -268,13 +256,9 @@
Frees a pointer only if it is !NULL and sets its value to NULL.
.PP
Definition at line 53 of file tools.h.
-.PP
-Referenced by _sess_read(), build_oid_segment(), clear_callback(), clear_context(), clear_lookup_cache(), convert_v2pdu_to_v1(), create_user_from_session(), dump_chunk(), fprint_description(), fprint_objid(), fprint_value(), fprint_variable(), free_agent_snmp_session(), get_module_node(), get_node(), get_set_cache(), netsnmp_addrcache_add(), netsnmp_agent_check_packet(), netsnmp_agent_check_parse(), netsnmp_cache_reqinfo_extract(), netsnmp_cache_reqinfo_insert(), netsnmp_config_remember_free_list(), netsnmp_create_handler(), netsnmp_fixup_mib_directory(), netsnmp_free_agent_request_info(), netsnmp_free_all_list_data(), netsnmp_free_cachemap(), netsnmp_free_delegated_cache(), netsnmp_free_list_data(), netsnmp_getenv(), netsnmp_handler_free(), netsnmp_handler_registration_free(), netsnmp_init_mib(), netsnmp_iterator_delete_table(), netsnmp_reassign_requests(), netsnmp_register_agent_nsap(), netsnmp_register_old_api(), netsnmp_remove_loghandler(), netsnmp_row_merge_helper_handler(), netsnmp_sess_log_error(), netsnmp_set_mib_directory(), netsnmp_set_row_column(), netsnmp_sprint_realloc_objid(), netsnmp_sprint_realloc_objid_tree(), netsnmp_subtree_free(), netsnmp_subtree_join(), netsnmp_subtree_split(), netsnmp_table_build_oid_from_index(), netsnmp_table_data_delete_row(), netsnmp_table_data_delete_table(), netsnmp_table_data_set_helper_handler(), netsnmp_table_dataset_delete_data(), netsnmp_tcontainer_create_table(), netsnmp_tcontainer_delete_table(), netsnmp_tdata_clone_row(), netsnmp_tdata_delete_row(), netsnmp_tdata_delete_table(), netsnmp_wrap_up_request(), parse_octet_hint(), read_objid(), shutdown_mib(), snmp_add_var(), snmp_free_pdu(), snmp_free_var(), snmp_sess_close(), snmp_unregister_callback(), snmpv3_make_report(), snmpv3_parse(), table_helper_handler(), unregister_all_config_handlers(), unregister_config_handler(), and unregister_mibs_by_session().
.SS "#define SNMP_MACRO_VAL_TO_STR(s) SNMP_MACRO_VAL_TO_STR_PRIV(s)"
.PP
-Expands to string with value of the s.
-.PP
-If s is macro, the resulting string is value of the macro. Example: define TEST 1234 \fBSNMP_MACRO_VAL_TO_STR(TEST)\fP expands to '1234' SNMP_MACRO_VAL_TO_STR(TEST+1) expands to '1234+1'
+Expands to string with value of the s. If s is macro, the resulting string is value of the macro. Example: define TEST 1234 \fBSNMP_MACRO_VAL_TO_STR(TEST)\fP expands to '1234' SNMP_MACRO_VAL_TO_STR(TEST+1) expands to '1234+1'
.PP
Definition at line 99 of file tools.h.
.SS "#define SNMP_MALLOC_STRUCT(s) (struct s *) calloc(1, sizeof(struct s))"
@@ -282,29 +266,21 @@
Mallocs memory of sizeof(struct s), zeros it and returns a pointer to it.
.PP
Definition at line 64 of file tools.h.
-.PP
-Referenced by netsnmp_config_remember_in_list(), netsnmp_create_subtree_cache(), netsnmp_register_callback(), snmp_alarm_register(), and snmp_alarm_register_hr().
.SS "#define SNMP_MALLOC_TYPEDEF(td) (td *) calloc(1, sizeof(td))"
.PP
Mallocs memory of sizeof(t), zeros it and returns a pointer to it.
.PP
Definition at line 68 of file tools.h.
-.PP
-Referenced by add_subtree(), get_context_lookup_cache(), init_agent_snmp_session(), netsnmp_baby_steps_handler_get(), netsnmp_cache_create(), netsnmp_container_get_null(), netsnmp_container_iterator_get(), netsnmp_container_table_handler_get(), netsnmp_create_data_list(), netsnmp_create_delegated_cache(), netsnmp_create_handler(), netsnmp_create_table_data(), netsnmp_create_table_data_row(), netsnmp_create_table_data_set(), netsnmp_create_watcher_info(), netsnmp_ds_register_config(), netsnmp_ds_register_premib(), netsnmp_get_new_stash_cache(), netsnmp_get_or_add_local_cachid(), netsnmp_get_scalar_group_handler(), netsnmp_handler_registration_create(), netsnmp_iterator_create_table(), netsnmp_mark_row_column_writable(), netsnmp_mode_end_call_add_mode_callback(), netsnmp_oid_stash_create_sized_node(), netsnmp_register_auto_data_table(), netsnmp_register_loghandler(), netsnmp_register_mib_table_row(), netsnmp_register_num_file_instance(), netsnmp_register_old_api(), netsnmp_register_save_list(), netsnmp_register_table_data_set(), netsnmp_row_merge_status_get(), netsnmp_set_row_column(), netsnmp_stash_to_next_helper(), netsnmp_table_container_register(), netsnmp_table_data_create_row(), netsnmp_table_data_set_create_newrowstash(), netsnmp_table_data_set_helper_handler(), netsnmp_table_iterator_helper_handler(), netsnmp_table_set_add_default_row(), netsnmp_tcontainer_create_table(), netsnmp_tdata_create_row(), netsnmp_tdata_create_table(), save_set_cache(), snmp_varlist_add_variable(), and table_helper_handler().
.SS "#define SNMP_MAX(a, b) ((a) > (b) ? (a) : (b))"
.PP
Computers the maximum of a and b.
.PP
Definition at line 85 of file tools.h.
-.PP
-Referenced by netsnmp_config_parse_table_set(), netsnmp_create_subtree_cache(), and netsnmp_register_table_data_set().
.SS "#define SNMP_MIN(a, b) ((a) > (b) ? (b) : (a))"
.PP
Computers the minimum of a and b.
.PP
Definition at line 89 of file tools.h.
-.PP
-Referenced by netsnmp_config_parse_table_set(), netsnmp_oid_find_prefix(), netsnmp_register_table_data_set(), netsnmp_scalar_group_helper_handler(), netsnmp_scalar_helper_handler(), netsnmp_stash_to_next_helper(), netsnmp_table_data_helper_handler(), and sprint_realloc_octet_string().
.SS "#define SNMP_SWIPE_MEM(n, s) do { if (n) free((void *)n); n = s; s=NULL; } while(0)"
.PP
Frees pointer n only if it is !NULL, sets n to s and sets s to NULL.
@@ -317,41 +293,29 @@
Definition at line 72 of file tools.h.
.SH "Function Documentation"
.PP
-.SS "long atime_diff (\fBmarker_t\fP first, \fBmarker_t\fP second)"
+.SS "long atime_diff (marker_t first, marker_t second)"
.PP
Returns the difference (in msec) between the two markers.
.PP
Definition at line 795 of file tools.c.
+.SS "marker_t atime_newMarker (void)"
.PP
-Referenced by atime_ready(), and marker_tticks().
-.SS "\fBmarker_t\fP atime_newMarker (void)"
-.PP
-create a new time marker.
-.PP
-NOTE: Caller must free time marker when no longer needed.
+create a new time marker. NOTE: Caller must free time marker when no longer needed.
.PP
Definition at line 771 of file tools.c.
-.PP
-Referenced by atime_ready(), marker_tticks(), and uatime_ready().
-.SS "int atime_ready (\fBmarker_t\fP pm, int deltaT)"
+.SS "int atime_ready (marker_t pm, int deltaT)"
.PP
Test: Has (marked time plus delta) exceeded current time (in msec) ? Returns 0 if test fails or cannot be tested (no marker).
.PP
Definition at line 850 of file tools.c.
-.PP
-References atime_diff(), and atime_newMarker().
-.PP
-Referenced by netsnmp_cache_check_expired().
-.SS "void atime_setMarker (\fBmarker_t\fP pm)"
+.SS "void atime_setMarker (marker_t pm)"
.PP
set a time marker.
.PP
Definition at line 782 of file tools.c.
.SS "u_int binary_to_hex (const u_char * input, size_t len, char ** output)"
.PP
-converts binary to hexidecimal
-.PP
-\fBParameters:\fP
+converts binary to hexidecimal \fBParameters:\fP
.RS 4
\fI*input\fP Binary data.
.br
@@ -368,15 +332,9 @@
FIX Is there already one of these in the UCD SNMP codebase? The old one should be used, or this one should be moved to \fBsnmplib/snmp_api.c\fP.
.PP
Definition at line 287 of file tools.c.
-.PP
-References VAL2HEX.
-.PP
-Referenced by dump_chunk().
.SS "void free_zero (void * buf, size_t size)"
.PP
-zeros memory before freeing it.
-.PP
-\fBParameters:\fP
+zeros memory before freeing it. \fBParameters:\fP
.RS 4
\fI*buf\fP Pointer at bytes to free.
.br
@@ -386,13 +344,9 @@
.PP
Definition at line 185 of file tools.c.
-.PP
-Referenced by hex_to_binary2(), and malloc_random().
.SS "int hex_to_binary2 (const u_char * input, size_t len, char ** output)"
.PP
-hex_to_binary2
-.PP
-\fBParameters:\fP
+hex_to_binary2 \fBParameters:\fP
.RS 4
\fI*input\fP Printable data in base16.
.br
@@ -411,13 +365,9 @@
FIX Another version of 'hex-to-binary' which takes odd length input strings. It also allocates the memory to hold the binary data. Should be integrated with the official hex_to_binary() function.
.PP
Definition at line 324 of file tools.c.
-.PP
-References free_zero(), HEX2VAL, and NULL.
.SS "u_char* malloc_random (size_t * size)"
.PP
-Returns pointer to allocaed & set buffer on success, size contains number of random bytes filled.
-.PP
-buf is NULL and *size set to KMT error value upon failure.
+Returns pointer to allocaed & set buffer on success, size contains number of random bytes filled. buf is NULL and *size set to KMT error value upon failure.
.PP
\fBParameters:\fP
.RS 4
@@ -432,22 +382,14 @@
.PP
Definition at line 205 of file tools.c.
-.PP
-References free_zero(), and NULL.
-.SS "int marker_tticks (\fBmarker_t\fP pm)"
+.SS "int marker_tticks (marker_t pm)"
.PP
Return the number of timeTicks since the given marker.
.PP
Definition at line 898 of file tools.c.
-.PP
-References atime_diff(), and atime_newMarker().
-.PP
-Referenced by timeval_tticks().
.SS "int memdup (u_char ** to, const u_char * from, size_t size)"
.PP
-Duplicates a memory block.
-.PP
-Copies a existing memory location from a pointer to another, newly malloced, pointer.
+Duplicates a memory block. Copies a existing memory location from a pointer to another, newly malloced, pointer.
.PP
\fBParameters:\fP
.RS 4
@@ -466,26 +408,14 @@
.PP
Definition at line 236 of file tools.c.
-.PP
-References NULL.
-.PP
-Referenced by convert_v2pdu_to_v1(), create_user_from_session(), netsnmp_handler_registration_create(), netsnmp_handler_registration_dup(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_num_file_handler(), netsnmp_instance_uint_handler(), netsnmp_instance_ulong_handler(), netsnmp_register_old_api(), netsnmp_set_row_column(), netsnmp_table_data_clone_row(), netsnmp_table_data_copy_row(), netsnmp_table_data_set_clone_row(), netsnmp_table_row_register(), netsnmp_table_set_add_default_row(), netsnmp_tdata_clone_row(), netsnmp_tdata_copy_row(), netsnmp_watcher_helper_handler(), send_trap_to_sess(), and snmpd_parse_config_trapsess().
.SS "char* netsnmp_getenv (const char * name)"
.PP
-Non Windows: Returns a pointer to the desired environment variable or NULL if the environment variable does not exist.
-.PP
-Windows: Returns a pointer to the desired environment variable if it exists. If it does not, the variable is looked up in the registry in HKCU\\Net-SNMP or HKLM\\Net-SNMP (whichever it finds first) and stores the result in the environment variable. It then returns a pointer to environment variable.
+Non Windows: Returns a pointer to the desired environment \fBvariable\fP or NULL if the environment \fBvariable\fP does not exist. Windows: Returns a pointer to the desired environment \fBvariable\fP if it exists. If it does not, the \fBvariable\fP is looked up in the registry in HKCU\\Net-SNMP or HKLM\\Net-SNMP (whichever it finds first) and stores the result in the environment \fBvariable\fP. It then returns a pointer to environment \fBvariable\fP.
.PP
Definition at line 926 of file tools.c.
-.PP
-References NULL, and SNMP_FREE.
-.PP
-Referenced by get_configuration_directory(), get_persistent_directory(), netsnmp_fixup_mib_directory(), netsnmp_get_mib_directory(), netsnmp_init_mib(), read_config_files(), and read_config_store().
.SS "int netsnmp_hex_to_binary (u_char ** buf, size_t * buf_len, size_t * offset, int allow_realloc, const char * hex, const char * delim)"
.PP
-convert an ASCII hex string (with specified delimiters) to binary
-.PP
-\fBParameters:\fP
+convert an ASCII hex string (with specified delimiters) to binary \fBParameters:\fP
.RS 4
\fIbuf\fP address of a pointer (pointer to pointer) for the output buffer. If allow_realloc is set, the buffer may be grown via snmp_realloc to accomodate the data.
.br
@@ -510,24 +440,14 @@
.PP
Definition at line 425 of file tools.c.
-.PP
-References NULL, and snmp_realloc().
-.PP
-Referenced by snmp_hex_to_binary().
.SS "char* netsnmp_strdup_and_null (const u_char * from, size_t from_len)"
.PP
copies a (possible) unterminated string of a given length into a new buffer and null terminates it as well (new buffer MAY be one byte longer to account for this
.PP
Definition at line 255 of file tools.c.
-.PP
-References NULL.
-.PP
-Referenced by netsnmp_table_data_set_helper_handler().
.SS "int snmp_hex_to_binary (u_char ** buf, size_t * buf_len, size_t * offset, int allow_realloc, const char * hex)"
.PP
-convert an ASCII hex string to binary
-.PP
-\fBNote:\fP
+convert an ASCII hex string to binary \fBNote:\fP
.RS 4
This is a wrapper which calls netsnmp_hex_to_binary with a delimiter string of ' '.
.RE
@@ -544,15 +464,9 @@
.PP
Definition at line 485 of file tools.c.
-.PP
-References netsnmp_hex_to_binary().
-.PP
-Referenced by create_user_from_session(), and snmp_add_var().
.SS "int snmp_realloc (u_char ** buf, size_t * buf_len)"
.PP
-This function increase the size of the buffer pointed at by *buf, which is initially of size *buf_len.
-.PP
-Contents are preserved **AT THE BOTTOM END OF THE BUFFER**. If memory can be (re-)allocated then it returns 1, else it returns 0.
+This function increase the size of the buffer pointed at by *buf, which is initially of size *buf_len. Contents are preserved **AT THE BOTTOM END OF THE BUFFER**. If memory can be (re-)allocated then it returns 1, else it returns 0.
.PP
\fBParameters:\fP
.RS 4
@@ -569,28 +483,21 @@
.PP
Definition at line 121 of file tools.c.
-.PP
-References NULL.
-.PP
-Referenced by _sprint_hexstring_line(), asn_realloc(), dump_realloc_oid_to_string(), netsnmp_hex_to_binary(), snmp_add_var(), snmp_decimal_to_binary(), snmp_strcat(), sprint_realloc_asciistring(), sprint_realloc_ipaddress(), sprint_realloc_networkaddress(), and sprint_realloc_octet_string().
-.SS "u_long uatime_diff (\fBmarker_t\fP first, \fBmarker_t\fP second)"
+.SS "u_long uatime_diff (marker_t first, marker_t second)"
.PP
Returns the difference (in u_long msec) between the two markers.
.PP
Definition at line 812 of file tools.c.
-.PP
-Referenced by uatime_ready().
-.SS "u_long uatime_hdiff (\fBmarker_t\fP first, \fBmarker_t\fP second)"
+.SS "u_long uatime_hdiff (marker_t first, marker_t second)"
.PP
Returns the difference (in u_long 1/100th secs) between the two markers (functionally this is what sysUpTime needs).
.PP
Definition at line 830 of file tools.c.
-.PP
-Referenced by netsnmp_marker_uptime().
-.SS "int uatime_ready (\fBmarker_t\fP pm, unsigned int deltaT)"
+.SS "int uatime_ready (marker_t pm, unsigned int deltaT)"
.PP
Test: Has (marked time plus delta) exceeded current time (in msec) ? Returns 0 if test fails or cannot be tested (no marker).
.PP
Definition at line 872 of file tools.c.
-.PP
-References atime_newMarker(), and uatime_diff().
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_utilities.3 b/man/netsnmp_utilities.3
index c960f00..67fadff 100644
--- a/man/netsnmp_utilities.3
+++ b/man/netsnmp_utilities.3
@@ -1,78 +1,74 @@
-.TH "utility_handlers" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "utility_handlers" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-utility_handlers \- Simplify request processing A group of handlers intended to simplify certain aspects of processing a request for a MIB object.
-
+utility_handlers \-
.PP
+Simplify request processing A group of handlers intended to simplify certain aspects of processing a request for a MIB object.
+
.SS "Modules"
.in +1c
.ti -1c
.RI "\fBbulk_to_next\fP"
.br
-.RI "\fIConvert GETBULK requests into GETNEXT requests for the handler. \fP"
.PP
-.in +1c
+.RI "\fIConvert GETBULK requests into GETNEXT requests for the handler. \fP"
.ti -1c
.RI "\fBcache_handler\fP"
.br
-.RI "\fIMaintains a cache of data for use by lower level handlers. \fP"
.PP
-.in +1c
+.RI "\fIMaintains a cache of data for use by lower level handlers. \fP"
.ti -1c
.RI "\fBdebug\fP"
.br
-.RI "\fIPrint out debugging information about the handler chain being called. \fP"
.PP
-.in +1c
+.RI "\fIPrint out debugging information about the handler chain being called. \fP"
.ti -1c
.RI "\fBmode_end_call\fP"
.br
-.RI "\fIAt the end of a series of requests, call another handler hook. \fP"
.PP
-.in +1c
+.RI "\fIAt the end of a series of requests, call another handler hook. \fP"
.ti -1c
.RI "\fBmultiplexer\fP"
.br
-.RI "\fISplits mode requests into calls to different handlers. \fP"
.PP
-.in +1c
+.RI "\fISplits mode requests into calls to different handlers. \fP"
.ti -1c
.RI "\fBread_only\fP"
.br
-.RI "\fIMake your handler read_only automatically The only purpose of this handler is to return an appropriate error for any requests passed to it in a SET mode. \fP"
.PP
-.in +1c
+.RI "\fIMake your handler read_only automatically The only purpose of this handler is to return an appropriate error for any requests passed to it in a SET mode. \fP"
.ti -1c
.RI "\fBrow_merge\fP"
.br
-.RI "\fICalls sub handlers with request for one row at a time. \fP"
.PP
-.in +1c
+.RI "\fICalls sub handlers with request for one row at a time. \fP"
.ti -1c
.RI "\fBserialize\fP"
.br
-.RI "\fICalls sub handlers one request at a time. \fP"
.PP
-.in +1c
+.RI "\fICalls sub handlers one request at a time. \fP"
.ti -1c
.RI "\fBstash_to_next\fP"
.br
-.RI "\fIConvert GET_STASH requests into GETNEXT requests for the handler. \fP"
.PP
+.RI "\fIConvert GET_STASH requests into GETNEXT requests for the handler. \fP"
.in -1c
.SH "Detailed Description"
.PP
Simplify request processing A group of handlers intended to simplify certain aspects of processing a request for a MIB object.
-.PP
+
These helpers do not implement any MIB objects themselves. Rather they handle specific generic situations, either returning an error, or passing a (possibly simpler) request down to lower level handlers.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
diff --git a/man/netsnmp_variable_list.3 b/man/netsnmp_variable_list.3
index 4cfbce5..89efa4b 100644
--- a/man/netsnmp_variable_list.3
+++ b/man/netsnmp_variable_list.3
@@ -1,26 +1,27 @@
-.TH "variable_list" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "variable_list" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-variable_list \- The netsnmp variable list binding structure, it's typedef'd to netsnmp_variable_list.
-
+variable_list \-
.PP
+The netsnmp \fBvariable\fP list binding structure, it's typedef'd to netsnmp_variable_list.
+
.SH SYNOPSIS
.br
.PP
-\fC#include <snmp_api.h>\fP
.PP
+\fC#include <snmp_api.h>\fP
.SS "Data Fields"
.in +1c
.ti -1c
-.RI "\fBvariable_list\fP * \fBnext_variable\fP"
+.RI "struct \fBvariable_list\fP * \fBnext_variable\fP"
.br
-.RI "\fINULL for last variable. \fP"
+.RI "\fINULL for last \fBvariable\fP. \fP"
.ti -1c
.RI "oid * \fBname\fP"
.br
-.RI "\fIObject identifier of variable. \fP"
+.RI "\fIObject identifier of \fBvariable\fP. \fP"
.ti -1c
.RI "size_t \fBname_length\fP"
.br
@@ -28,11 +29,11 @@
.ti -1c
.RI "u_char \fBtype\fP"
.br
-.RI "\fIASN type of variable. \fP"
+.RI "\fIASN type of \fBvariable\fP. \fP"
.ti -1c
.RI "\fBnetsnmp_vardata\fP \fBval\fP"
.br
-.RI "\fIvalue of variable \fP"
+.RI "\fIvalue of \fBvariable\fP \fP"
.ti -1c
.RI "size_t \fBval_len\fP"
.br
@@ -59,7 +60,7 @@
.in -1c
.SH "Detailed Description"
.PP
-The netsnmp variable list binding structure, it's typedef'd to netsnmp_variable_list.
+The netsnmp \fBvariable\fP list binding structure, it's typedef'd to netsnmp_variable_list.
.PP
\fBExamples: \fP
.in +1c
@@ -69,82 +70,62 @@
Definition at line 522 of file snmp_api.h.
.SH "Field Documentation"
.PP
-.SS "struct \fBvariable_list\fP* \fBvariable_list::next_variable\fP"
+.SS "u_char \fBvariable_list::buf\fP[40]"
.PP
-NULL for last variable.
+90 percentile < 40.
.PP
-Definition at line 524 of file snmp_api.h.
+Definition at line 538 of file snmp_api.h.
+.SS "void* \fBvariable_list::data\fP"
.PP
-Referenced by _fix_endofmibview(), _reorder_getbulk(), build_oid_noalloc(), check_acm(), convert_v1pdu_to_v2(), convert_v2pdu_to_v1(), count_varbinds(), count_varbinds_of_type(), find_varbind_in_list(), find_varbind_of_type(), handle_getnext_loop(), handle_pdu(), netsnmp_agent_check_parse(), netsnmp_bulk_to_next_fix_requests(), netsnmp_config_parse_add_row(), netsnmp_create_subtree_cache(), netsnmp_handle_request(), netsnmp_query_walk(), netsnmp_send_traps(), netsnmp_wrap_up_request(), parse_oid_indexes(), snmp_clone_var(), snmp_free_varbind(), snmp_pdu_build(), snmp_pdu_parse(), snmp_replace_var_types(), snmp_reset_var_buffers(), snmp_varbind_len(), snmp_varlist_add_variable(), and table_helper_handler().
+(Opaque) hook for additional data
+.PP
+Definition at line 540 of file snmp_api.h.
+.SS "void(* \fBvariable_list::dataFreeHook\fP)(void *)"
+.PP
+callback to free above
.SS "oid* \fBvariable_list::name\fP"
.PP
-Object identifier of variable.
+Object identifier of \fBvariable\fP.
.PP
Definition at line 526 of file snmp_api.h.
-.PP
-Referenced by _fix_endofmibview(), _reorder_getbulk(), build_oid_segment(), check_acm(), check_getnext_results(), convert_v2pdu_to_v1(), dump_idx_registry(), find_varbind_in_list(), netsnmp_add_varbind_to_cache(), netsnmp_agent_check_parse(), netsnmp_bulk_to_next_fix_requests(), netsnmp_bulk_to_next_helper(), netsnmp_check_getnext_reply(), netsnmp_create_subtree_cache(), netsnmp_instance_helper_handler(), netsnmp_old_api_helper(), netsnmp_query_walk(), netsnmp_row_merge_helper_handler(), netsnmp_scalar_group_helper_handler(), netsnmp_scalar_helper_handler(), netsnmp_send_traps(), netsnmp_stash_cache_helper(), netsnmp_stash_to_next_helper(), netsnmp_table_build_oid(), netsnmp_table_build_oid_from_index(), netsnmp_table_build_result(), netsnmp_table_data_set_helper_handler(), netsnmp_watched_spinlock_handler(), netsnmp_watched_timestamp_handler(), netsnmp_watcher_helper_handler(), netsnmp_wrap_up_request(), snmp_clone_var(), snmp_free_var(), snmp_pdu_build(), snmp_pdu_parse(), snmp_reset_var_buffers(), snmp_set_var_objid(), and snmpv3_get_report_type().
.SS "size_t \fBvariable_list::name_length\fP"
.PP
number of subid's in name
.PP
Definition at line 528 of file snmp_api.h.
+.SS "oid \fBvariable_list::name_loc\fP[MAX_OID_LEN]"
.PP
-Referenced by _fix_endofmibview(), _reorder_getbulk(), build_oid_segment(), check_acm(), check_getnext_results(), convert_v2pdu_to_v1(), dump_idx_registry(), find_varbind_in_list(), netsnmp_add_varbind_to_cache(), netsnmp_agent_check_parse(), netsnmp_bulk_to_next_fix_requests(), netsnmp_bulk_to_next_helper(), netsnmp_check_getnext_reply(), netsnmp_create_subtree_cache(), netsnmp_instance_helper_handler(), netsnmp_old_api_helper(), netsnmp_query_walk(), netsnmp_row_merge_helper_handler(), netsnmp_scalar_group_helper_handler(), netsnmp_scalar_helper_handler(), netsnmp_send_traps(), netsnmp_stash_cache_helper(), netsnmp_stash_to_next_helper(), netsnmp_table_build_oid(), netsnmp_table_build_oid_from_index(), netsnmp_table_data_set_helper_handler(), netsnmp_watched_spinlock_handler(), netsnmp_watched_timestamp_handler(), netsnmp_watcher_helper_handler(), netsnmp_wrap_up_request(), snmp_clone_var(), snmp_pdu_build(), snmp_pdu_parse(), snmp_reset_var_buffers(), snmp_set_var_objid(), and snmpv3_get_report_type().
+90 percentile < 24.
+.PP
+Definition at line 536 of file snmp_api.h.
+.SS "struct \fBvariable_list\fP* \fBvariable_list::next_variable\fP\fC [read]\fP"
+.PP
+NULL for last \fBvariable\fP.
+.PP
+Definition at line 524 of file snmp_api.h.
.SS "u_char \fBvariable_list::type\fP"
.PP
-ASN type of variable.
+ASN type of \fBvariable\fP.
.PP
\fBExamples: \fP
.in +1c
\fBdelayed_instance.c\fP.
.PP
Definition at line 530 of file snmp_api.h.
-.PP
-Referenced by _fix_endofmibview(), _request_set_error(), build_oid_segment(), check_acm(), check_getnext_results(), convert_v2pdu_to_v1(), count_varbinds_of_type(), dump_idx_registry(), find_varbind_of_type(), handle_pdu(), netsnmp_add_varbind_to_cache(), netsnmp_bulk_to_next_fix_requests(), netsnmp_check_getnext_reply(), netsnmp_config_parse_add_row(), netsnmp_create_subtree_cache(), netsnmp_instance_helper_handler(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_num_file_handler(), netsnmp_instance_uint_handler(), netsnmp_instance_ulong_handler(), netsnmp_reassign_requests(), netsnmp_scalar_group_helper_handler(), netsnmp_stash_cache_helper(), netsnmp_stash_to_next_helper(), netsnmp_table_data_set_helper_handler(), netsnmp_watcher_helper_handler(), netsnmp_wrap_up_request(), parse_one_oid_index(), snmp_pdu_build(), snmp_pdu_parse(), snmp_replace_var_types(), snmp_set_var_typed_integer(), snmp_set_var_typed_value(), snmp_set_var_value(), snmp_varlist_add_variable(), 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(), sprint_realloc_value(), sprint_realloc_variable(), and table_helper_handler().
.SS "\fBnetsnmp_vardata\fP \fBvariable_list::val\fP"
.PP
-value of variable
+value of \fBvariable\fP
.PP
\fBExamples: \fP
.in +1c
\fBdelayed_instance.c\fP.
.PP
Definition at line 532 of file snmp_api.h.
-.PP
-Referenced by build_oid_segment(), convert_v2pdu_to_v1(), dump_idx_registry(), netsnmp_check_getnext_reply(), netsnmp_instance_int_handler(), netsnmp_instance_long_handler(), netsnmp_instance_num_file_handler(), netsnmp_instance_uint_handler(), netsnmp_instance_ulong_handler(), netsnmp_send_traps(), netsnmp_stash_cache_helper(), netsnmp_table_data_set_helper_handler(), netsnmp_watcher_helper_handler(), parse_one_oid_index(), snmp_clone_var(), snmp_free_var(), snmp_pdu_build(), snmp_pdu_parse(), snmp_reset_var_buffers(), snmp_set_var_value(), 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_object_identifier(), sprint_realloc_octet_string(), sprint_realloc_opaque(), sprint_realloc_timeticks(), and sprint_realloc_uinteger().
.SS "size_t \fBvariable_list::val_len\fP"
.PP
the length of the value to be copied into buf
.PP
Definition at line 534 of file snmp_api.h.
-.PP
-Referenced by build_oid_segment(), convert_v2pdu_to_v1(), dump_idx_registry(), netsnmp_check_getnext_reply(), netsnmp_stash_cache_helper(), netsnmp_table_data_set_helper_handler(), netsnmp_watcher_helper_handler(), parse_one_oid_index(), snmp_clone_var(), snmp_pdu_build(), snmp_pdu_parse(), snmp_reset_var_buffers(), snmp_set_var_value(), sprint_realloc_bitstring(), sprint_realloc_networkaddress(), sprint_realloc_nsapaddress(), sprint_realloc_object_identifier(), sprint_realloc_octet_string(), and sprint_realloc_opaque().
-.SS "oid \fBvariable_list::name_loc\fP[MAX_OID_LEN]"
-.PP
-90 percentile < 24.
-.PP
-Definition at line 536 of file snmp_api.h.
-.PP
-Referenced by build_oid_segment(), netsnmp_table_build_oid_from_index(), netsnmp_table_build_result(), snmp_free_var(), snmp_reset_var_buffers(), and snmp_set_var_objid().
-.SS "u_char \fBvariable_list::buf\fP[40]"
-.PP
-90 percentile < 40.
-.PP
-Definition at line 538 of file snmp_api.h.
-.PP
-Referenced by snmp_clone_var(), snmp_free_var(), snmp_pdu_parse(), snmp_reset_var_buffers(), and snmp_set_var_value().
-.SS "void* \fBvariable_list::data\fP"
-.PP
-(Opaque) hook for additional data
-.PP
-Definition at line 540 of file snmp_api.h.
-.PP
-Referenced by snmp_clone_var(), snmp_free_var(), and snmp_pdu_parse().
-.SS "void(* \fBvariable_list::dataFreeHook\fP)(void *)"
-.PP
-callback to free above
-.PP
-Referenced by snmp_clone_var(), snmp_free_var(), and snmp_pdu_parse().
.SH "Author"
.PP
diff --git a/man/netsnmp_watcher.3 b/man/netsnmp_watcher.3
index 3637ed4..6464d8c 100644
--- a/man/netsnmp_watcher.3
+++ b/man/netsnmp_watcher.3
@@ -1,10 +1,11 @@
-.TH "watcher" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
+.TH "watcher" 3 "29 Oct 2009" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
.ad l
.nh
.SH NAME
-watcher \- Watch a specified variable and process it as an instance or scalar object.
-
+watcher \-
.PP
+Watch a specified \fBvariable\fP and process it as an instance or scalar object.
+
.SS "Functions"
.in +1c
@@ -27,10 +28,10 @@
.RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_get_watched_timestamp_handler\fP (void)"
.br
.ti -1c
-.RI "int \fBnetsnmp_watched_timestamp_register\fP (\fBnetsnmp_mib_handler\fP *whandler, \fBnetsnmp_handler_registration\fP *reginfo, \fBmarker_t\fP timestamp)"
+.RI "int \fBnetsnmp_watched_timestamp_register\fP (\fBnetsnmp_mib_handler\fP *whandler, \fBnetsnmp_handler_registration\fP *reginfo, marker_t timestamp)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_watched_timestamp\fP (\fBnetsnmp_handler_registration\fP *reginfo, \fBmarker_t\fP timestamp)"
+.RI "int \fBnetsnmp_register_watched_timestamp\fP (\fBnetsnmp_handler_registration\fP *reginfo, marker_t timestamp)"
.br
.ti -1c
.RI "int \fBnetsnmp_watched_timestamp_handler\fP (\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *requests)"
@@ -45,29 +46,30 @@
.RI "int \fBnetsnmp_watched_spinlock_handler\fP (\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *requests)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_ulong_scalar\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_ulong_scalar\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, Netsnmp_Node_Handler *subhandler)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_read_only_ulong_scalar\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_read_only_ulong_scalar\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, Netsnmp_Node_Handler *subhandler)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_long_scalar\fP (const char *name, oid *reg_oid, size_t reg_oid_len, long *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_long_scalar\fP (const char *name, oid *reg_oid, size_t reg_oid_len, long *it, Netsnmp_Node_Handler *subhandler)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_read_only_long_scalar\fP (const char *name, oid *reg_oid, size_t reg_oid_len, long *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_read_only_long_scalar\fP (const char *name, oid *reg_oid, size_t reg_oid_len, long *it, Netsnmp_Node_Handler *subhandler)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_int_scalar\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_int_scalar\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, Netsnmp_Node_Handler *subhandler)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_read_only_int_scalar\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_read_only_int_scalar\fP (const char *name, oid *reg_oid, size_t reg_oid_len, int *it, Netsnmp_Node_Handler *subhandler)"
.br
.ti -1c
-.RI "int \fBnetsnmp_register_read_only_counter32_scalar\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, \fBNetsnmp_Node_Handler\fP *subhandler)"
+.RI "int \fBnetsnmp_register_read_only_counter32_scalar\fP (const char *name, oid *reg_oid, size_t reg_oid_len, u_long *it, Netsnmp_Node_Handler *subhandler)"
.br
.in -1c
.SH "Detailed Description"
.PP
-Watch a specified variable and process it as an instance or scalar object.
-.PP
-
+Watch a specified \fBvariable\fP and process it as an instance or scalar object.
+.SH "Author"
+.PP
+Generated automatically by Doxygen for net-snmp from the source code.
