blob: 0731ad203c5f597667fd5df9aa00ac640c70e76c [file] [log] [blame]
Dave Shield4530d872011-06-24 12:08:23 +00001.TH "netsnmp_handler_registration_s" 3 "24 Jun 2011" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
Robert Story5bd779b2004-09-02 05:52:44 +00002.ad l
3.nh
4.SH NAME
Dave Shield3f6f5332009-10-29 10:30:23 +00005netsnmp_handler_registration_s \-
Robert Story5bd779b2004-09-02 05:52:44 +00006.PP
Dave Shield3f6f5332009-10-29 10:30:23 +00007Root registration info.
8
Robert Story5bd779b2004-09-02 05:52:44 +00009.SH SYNOPSIS
10.br
11.PP
Robert Story5bd779b2004-09-02 05:52:44 +000012.PP
Dave Shield3f6f5332009-10-29 10:30:23 +000013\fC#include <agent_handler.h>\fP
Robert Story5bd779b2004-09-02 05:52:44 +000014.SS "Data Fields"
15
16.in +1c
17.ti -1c
18.RI "char * \fBhandlerName\fP"
19.br
20.RI "\fIfor mrTable listings, and other uses \fP"
21.ti -1c
22.RI "char * \fBcontextName\fP"
23.br
24.RI "\fINULL = default context. \fP"
25.ti -1c
26.RI "oid * \fBrootoid\fP"
27.br
28.RI "\fIwhere are we registered at? \fP"
29.ti -1c
30.RI "size_t \fBrootoid_len\fP"
31.br
32.ti -1c
33.RI "\fBnetsnmp_mib_handler\fP * \fBhandler\fP"
34.br
35.RI "\fIhandler details \fP"
36.ti -1c
37.RI "int \fBmodes\fP"
38.br
39.ti -1c
40.RI "int \fBpriority\fP"
41.br
42.RI "\fImore optional stuff \fP"
43.ti -1c
44.RI "int \fBrange_subid\fP"
45.br
46.ti -1c
47.RI "oid \fBrange_ubound\fP"
48.br
49.ti -1c
50.RI "int \fBtimeout\fP"
51.br
52.ti -1c
53.RI "int \fBglobal_cacheid\fP"
54.br
55.ti -1c
56.RI "void * \fBmy_reg_void\fP"
57.br
58.RI "\fIvoid ptr for registeree \fP"
59.in -1c
60.SH "Detailed Description"
61.PP
62Root registration info.
63
64The variables handlerName, contextName, and rootoid need to be allocated on the heap, when the registration structure is unregistered using \fBunregister_mib_context()\fP the code attempts to free them.
65.PP
66\fBExamples: \fP
67.in +1c
68.PP
Robert Story6fbe1942005-10-31 09:27:14 +000069\fBdelayed_instance.c\fP, and \fBwatched.c\fP.
Robert Story5bd779b2004-09-02 05:52:44 +000070.PP
Dave Shield3f6f5332009-10-29 10:30:23 +000071Definition at line 95 of file agent_handler.h.
Robert Story5bd779b2004-09-02 05:52:44 +000072.SH "Field Documentation"
73.PP
Wes Hardakera7e42af2007-05-21 23:51:45 +000074.SS "char* \fBnetsnmp_handler_registration_s::contextName\fP"
Robert Story5bd779b2004-09-02 05:52:44 +000075.PP
Wes Hardakera7e42af2007-05-21 23:51:45 +000076NULL = default context.
Wes Hardakerfdd56482006-09-20 00:29:56 +000077.PP
Dave Shield3f6f5332009-10-29 10:30:23 +000078Definition at line 100 of file agent_handler.h.
Wes Hardakera7e42af2007-05-21 23:51:45 +000079.SS "\fBnetsnmp_mib_handler\fP* \fBnetsnmp_handler_registration_s::handler\fP"
80.PP
81handler details
82.PP
Dave Shield3f6f5332009-10-29 10:30:23 +000083Definition at line 111 of file agent_handler.h.
84.SS "char* \fBnetsnmp_handler_registration_s::handlerName\fP"
Wes Hardakera7e42af2007-05-21 23:51:45 +000085.PP
Dave Shield3f6f5332009-10-29 10:30:23 +000086for mrTable listings, and other uses
Wes Hardakera7e42af2007-05-21 23:51:45 +000087.PP
Dave Shield3f6f5332009-10-29 10:30:23 +000088Definition at line 98 of file agent_handler.h.
Wes Hardakera7e42af2007-05-21 23:51:45 +000089.SS "void* \fBnetsnmp_handler_registration_s::my_reg_void\fP"
90.PP
91void ptr for registeree
92.PP
Dave Shield3f6f5332009-10-29 10:30:23 +000093Definition at line 126 of file agent_handler.h.
94.SS "int \fBnetsnmp_handler_registration_s::priority\fP"
95.PP
96more optional stuff
97.PP
98Definition at line 117 of file agent_handler.h.
99.SS "oid* \fBnetsnmp_handler_registration_s::rootoid\fP"
100.PP
101where are we registered at?
102.PP
103Definition at line 105 of file agent_handler.h.
Robert Story5bd779b2004-09-02 05:52:44 +0000104
105.SH "Author"
106.PP
107Generated automatically by Doxygen for net-snmp from the source code.