summaryrefslogtreecommitdiff
path: root/agent/mibgroup/tcp-mib/tcpListenerTable/tcpListenerTable.h
blob: 08a741ac170bac9b921819d63ab9ebd0b56ff45f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
/*
 * Note: this file originally auto-generated by mib2c using
 *       version : 1.48 $ of : mfd-top.m2c,v $
 *
 * $Id$
 */
#ifndef TCPLISTENERTABLE_H
#define TCPLISTENERTABLE_H

#ifdef __cplusplus
extern          "C" {
#endif


/** @addtogroup misc misc: Miscellaneous routines
 *
 * @{
 */
#include <net-snmp/library/asn1.h>
#include <net-snmp/data_access/tcpConn.h>

    /*
     * other required module components 
     */
    /* *INDENT-OFF*  */
config_require(tcp-mib/data_access/tcpConn)
config_require(tcp-mib/tcpListenerTable/tcpListenerTable_interface)
config_require(tcp-mib/tcpListenerTable/tcpListenerTable_data_access)
    /* *INDENT-ON*  */

    /*
     * OID, column number and enum definions for tcpListenerTable 
     */
#include "tcpListenerTable_constants.h"

    /*
     *********************************************************************
     * function declarations
     */
    void            init_tcpListenerTable(void);
    void            shutdown_tcpListenerTable(void);

    /*
     *********************************************************************
     * Table declarations
     */
/**********************************************************************
 **********************************************************************
 ***
 *** Table tcpListenerTable
 ***
 **********************************************************************
 **********************************************************************/
    /*
     * TCP-MIB::tcpListenerTable is subid 20 of tcp.
     * Its status is Current.
     * OID: .1.3.6.1.2.1.6.20, length: 8
     */
    /*
     *********************************************************************
     * When you register your mib, you get to provide a generic
     * pointer that will be passed back to you for most of the
     * functions calls.
     *
     * TODO:100:r: Review all context structures
     */
    /*
     * TODO:101:o: |-> Review tcpListenerTable registration context.
     */
    typedef struct tListenerT_user_ctx {

        void           *dummy;

    } tcpListenerTable_registration;

/**********************************************************************/
    /*
     * TODO:110:r: |-> Review tcpListenerTable data context structure.
     * This structure is used to represent the data for tcpListenerTable.
     */
    typedef netsnmp_tcpconn_entry tcpListenerTable_data;


    /*
     * TODO:120:r: |-> Review tcpListenerTable mib index.
     * This structure is used to represent the index for tcpListenerTable.
     */
    typedef struct tcpListenerTable_mib_index_s {

        /*
         * tcpListenerLocalAddressType(1)/InetAddressType/ASN_INTEGER/long(u_long)//l/a/w/E/r/d/h
         */
        u_long          tcpListenerLocalAddressType;

        /*
         * tcpListenerLocalAddress(2)/InetAddress/ASN_OCTET_STR/char(char)//L/a/w/e/R/d/h
         */
        /** 128 - 2(other indexes) - oid length(10) = 115 */
        char            tcpListenerLocalAddress[20];
        size_t          tcpListenerLocalAddress_len;

        /*
         * tcpListenerLocalPort(3)/InetPortNumber/ASN_UNSIGNED/u_long(u_long)//l/a/w/e/R/d/H
         */
        u_long          tcpListenerLocalPort;


    } tcpListenerTable_mib_index;

    /*
     * TODO:121:r: |   |-> Review tcpListenerTable max index length.
     * If you KNOW that your indexes will never exceed a certain
     * length, update this macro to that length.
     *
     * BE VERY CAREFUL TO TAKE INTO ACCOUNT THE MAXIMUM
     * POSSIBLE LENGHT FOR EVERY VARIABLE LENGTH INDEX!
     * Guessing 128 - col/entry(2)  - oid len(8)
     */
#define MAX_tcpListenerTable_IDX_LEN     22


    /*
     *********************************************************************
     * TODO:130:o: |-> Review tcpListenerTable Row request (rowreq) context.
     * When your functions are called, you will be passed a
     * tcpListenerTable_rowreq_ctx pointer.
     */
    typedef struct tcpListenerTable_rowreq_ctx_s {

    /** this must be first for container compare to work */
        netsnmp_index   oid_idx;
        oid             oid_tmp[MAX_tcpListenerTable_IDX_LEN];

        tcpListenerTable_mib_index tbl_idx;

        tcpListenerTable_data *data;

        /*
         * flags per row. Currently, the first (lower) 8 bits are reserved
         * for the user. See mfd.h for other flags.
         */
        u_int           rowreq_flags;

        /*
         * TODO:131:o: |   |-> Add useful data to tcpListenerTable rowreq context.
         */

        /*
         * storage for future expansion
         */
        netsnmp_data_list *tcpListenerTable_data_list;

    } tcpListenerTable_rowreq_ctx;

    typedef struct tcpListenerTable_ref_rowreq_ctx_s {
        tcpListenerTable_rowreq_ctx *rowreq_ctx;
    } tcpListenerTable_ref_rowreq_ctx;

    /*
     *********************************************************************
     * function prototypes
     */
    int
        tcpListenerTable_pre_request(tcpListenerTable_registration *
                                     user_context);
    int
        tcpListenerTable_post_request(tcpListenerTable_registration *
                                      user_context, int rc);

    int
        tcpListenerTable_rowreq_ctx_init(tcpListenerTable_rowreq_ctx *
                                         rowreq_ctx, void *user_init_ctx);
    void
        tcpListenerTable_rowreq_ctx_cleanup(tcpListenerTable_rowreq_ctx *
                                            rowreq_ctx);

    tcpListenerTable_data *tcpListenerTable_allocate_data(void);
    void            tcpListenerTable_release_data(tcpListenerTable_data *
                                                  data);

        tcpListenerTable_rowreq_ctx
        * tcpListenerTable_row_find_by_mib_index(tcpListenerTable_mib_index
                                                 * mib_idx);

    extern const oid      tcpListenerTable_oid[];
    extern const int      tcpListenerTable_oid_size;


#include "tcpListenerTable_interface.h"
#include "tcpListenerTable_data_access.h"
    /*
     *********************************************************************
     * GET function declarations
     */

    /*
     *********************************************************************
     * GET Table declarations
     */
/**********************************************************************
 **********************************************************************
 ***
 *** Table tcpListenerTable
 ***
 **********************************************************************
 **********************************************************************/
    /*
     * TCP-MIB::tcpListenerTable is subid 20 of tcp.
     * Its status is Current.
     * OID: .1.3.6.1.2.1.6.20, length: 8
     */
    /*
     * indexes
     */

    int             tcpListenerProcess_get(tcpListenerTable_rowreq_ctx *
                                           rowreq_ctx,
                                           u_long *
                                           tcpListenerProcess_val_ptr);


    int
        tcpListenerTable_indexes_set_tbl_idx(tcpListenerTable_mib_index *
                                             tbl_idx,
                                             u_long
                                             tcpListenerLocalAddressType_val,
                                             char
                                             *tcpListenerLocalAddress_val_ptr,
                                             size_t
                                             tcpListenerLocalAddress_val_ptr_len,
                                             u_long
                                             tcpListenerLocalPort_val);
    int
        tcpListenerTable_indexes_set(tcpListenerTable_rowreq_ctx *
                                     rowreq_ctx,
                                     u_long
                                     tcpListenerLocalAddressType_val,
                                     char *tcpListenerLocalAddress_val_ptr,
                                     size_t
                                     tcpListenerLocalAddress_val_ptr_len,
                                     u_long tcpListenerLocalPort_val);



    /*
     *********************************************************************
     * SET function declarations
     */

    /*
     *********************************************************************
     * SET Table declarations
     */


    /*
     * DUMMY markers, ignore
     *
     * TODO:099:x: *************************************************************
     * TODO:199:x: *************************************************************
     * TODO:299:x: *************************************************************
     * TODO:399:x: *************************************************************
     * TODO:499:x: *************************************************************
     */

#ifdef __cplusplus
}
#endif
#endif                          /* TCPLISTENERTABLE_H */
/**  @} */