blob: e33290bfbab4f2feb68ea542e1e7b33a72a85f55 [file] [log] [blame]
Dave Shield4530d872011-06-24 12:08:23 +00001.TH "table_data" 3 "24 Jun 2011" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
Wes Hardaker27ff28a2002-04-20 00:29:28 +00002.ad l
3.nh
4.SH NAME
Dave Shield3f6f5332009-10-29 10:30:23 +00005table_data \-
Robert Story2254d872004-09-02 05:57:42 +00006.PP
Dave Shield3f6f5332009-10-29 10:30:23 +00007Helps you implement a table with datamatted storage.
8
Wes Hardaker27ff28a2002-04-20 00:29:28 +00009.SS "Modules"
10
11.in +1c
12.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000013.RI "\fBtable_dataset\fP"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000014.br
Wes Hardaker27ff28a2002-04-20 00:29:28 +000015.PP
16
Dave Shield3f6f5332009-10-29 10:30:23 +000017.RI "\fIHelps you implement a table with automatted storage. \fP"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000018.in -1c
19.SS "Functions"
20
21.in +1c
22.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000023.RI "void \fBnetsnmp_table_data_generate_index_oid\fP (\fBnetsnmp_table_row\fP *row)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000024.br
Wes Hardaker27ff28a2002-04-20 00:29:28 +000025.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000026.RI "\fBnetsnmp_table_data\fP * \fBnetsnmp_create_table_data\fP (const char *name)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000027.br
Robert Story6fbe1942005-10-31 09:27:14 +000028.RI "\fIcreates and returns a pointer to table data set \fP"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000029.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000030.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_create_table_data_row\fP (void)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000031.br
Robert Story6fbe1942005-10-31 09:27:14 +000032.RI "\fIcreates and returns a pointer to table data set \fP"
33.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000034.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_table_data_clone_row\fP (\fBnetsnmp_table_row\fP *row)"
Robert Story6fbe1942005-10-31 09:27:14 +000035.br
36.RI "\fIclones a data row. \fP"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000037.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000038.RI "void * \fBnetsnmp_table_data_delete_row\fP (\fBnetsnmp_table_row\fP *row)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000039.br
Robert Story2254d872004-09-02 05:57:42 +000040.RI "\fIdeletes a row's memory. \fP"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000041.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000042.RI "int \fBnetsnmp_table_data_add_row\fP (\fBnetsnmp_table_data\fP *table, \fBnetsnmp_table_row\fP *row)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000043.br
Robert Story6fbe1942005-10-31 09:27:14 +000044.RI "\fIAdds a row of data to a given table (stored in proper lexographical order). \fP"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000045.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000046.RI "NETSNMP_INLINE void \fBnetsnmp_table_data_replace_row\fP (\fBnetsnmp_table_data\fP *table, \fBnetsnmp_table_row\fP *origrow, \fBnetsnmp_table_row\fP *newrow)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000047.br
Robert Story2254d872004-09-02 05:57:42 +000048.RI "\fIswaps out origrow with newrow. \fP"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000049.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000050.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_table_data_remove_row\fP (\fBnetsnmp_table_data\fP *table, \fBnetsnmp_table_row\fP *row)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000051.br
Robert Story6fbe1942005-10-31 09:27:14 +000052.RI "\fIremoves a row of data to a given table and returns it (no free's called) \fP"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000053.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000054.RI "void * \fBnetsnmp_table_data_remove_and_delete_row\fP (\fBnetsnmp_table_data\fP *table, \fBnetsnmp_table_row\fP *row)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000055.br
Robert Story6fbe1942005-10-31 09:27:14 +000056.RI "\fIremoves and frees a row of data to a given table and returns the void * \fP"
57.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000058.RI "\fBnetsnmp_table_data\fP * \fBnetsnmp_table_data_create_table\fP (const char *name, long flags)"
Robert Story6fbe1942005-10-31 09:27:14 +000059.br
60.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000061.RI "void \fBnetsnmp_table_data_delete_table\fP (\fBnetsnmp_table_data\fP *table)"
Robert Story6fbe1942005-10-31 09:27:14 +000062.br
63.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000064.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_table_data_create_row\fP (void *entry)"
Robert Story6fbe1942005-10-31 09:27:14 +000065.br
66.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000067.RI "int \fBnetsnmp_table_data_copy_row\fP (\fBnetsnmp_table_row\fP *old_row, \fBnetsnmp_table_row\fP *new_row)"
Robert Story6fbe1942005-10-31 09:27:14 +000068.br
69.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000070.RI "void * \fBnetsnmp_table_data_remove_delete_row\fP (\fBnetsnmp_table_data\fP *table, \fBnetsnmp_table_row\fP *row)"
Robert Story6fbe1942005-10-31 09:27:14 +000071.br
Wes Hardaker27ff28a2002-04-20 00:29:28 +000072.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000073.RI "\fBnetsnmp_mib_handler\fP * \fBnetsnmp_get_table_data_handler\fP (\fBnetsnmp_table_data\fP *table)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000074.br
Robert Story2254d872004-09-02 05:57:42 +000075.RI "\fICreates a table_data handler and returns it. \fP"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000076.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000077.RI "int \fBnetsnmp_register_table_data\fP (\fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_table_data\fP *table, \fBnetsnmp_table_registration_info\fP *table_info)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000078.br
Robert Story2254d872004-09-02 05:57:42 +000079.RI "\fIregisters a handler as a data table. \fP"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000080.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000081.RI "int \fBnetsnmp_register_read_only_table_data\fP (\fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_table_data\fP *table, \fBnetsnmp_table_registration_info\fP *table_info)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000082.br
Robert Story2254d872004-09-02 05:57:42 +000083.RI "\fIregisters a handler as a read-only data table If table_info != NULL, it registers it as a normal table too. \fP"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000084.ti -1c
Robert Story2254d872004-09-02 05:57:42 +000085.RI "int \fBnetsnmp_table_data_helper_handler\fP (\fBnetsnmp_mib_handler\fP *handler, \fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *requests)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000086.br
Wes Hardaker27ff28a2002-04-20 00:29:28 +000087.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000088.RI "\fBnetsnmp_table_data\fP * \fBnetsnmp_extract_table\fP (\fBnetsnmp_request_info\fP *request)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +000089.br
Robert Story2254d872004-09-02 05:57:42 +000090.RI "\fIextracts the table being accessed passed from the table_data helper \fP"
91.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +000092.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_extract_table_row\fP (\fBnetsnmp_request_info\fP *request)"
Robert Story6fbe1942005-10-31 09:27:14 +000093.br
94.RI "\fIextracts the row being accessed passed from the table_data helper \fP"
95.ti -1c
Robert Story2254d872004-09-02 05:57:42 +000096.RI "void * \fBnetsnmp_extract_table_row_data\fP (\fBnetsnmp_request_info\fP *request)"
97.br
98.RI "\fIextracts the data from the row being accessed passed from the table_data helper \fP"
99.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000100.RI "NETSNMP_INLINE void \fBnetsnmp_insert_table_row\fP (\fBnetsnmp_request_info\fP *request, \fBnetsnmp_table_row\fP *row)"
Robert Story6fbe1942005-10-31 09:27:14 +0000101.br
102.RI "\fIinserts a newly created table_data row into a request \fP"
103.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000104.RI "int \fBnetsnmp_table_data_build_result\fP (\fBnetsnmp_handler_registration\fP *reginfo, \fBnetsnmp_agent_request_info\fP *reqinfo, \fBnetsnmp_request_info\fP *request, \fBnetsnmp_table_row\fP *row, int column, u_char type, u_char *result_data, size_t result_data_len)"
Robert Story2254d872004-09-02 05:57:42 +0000105.br
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000106.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000107.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_table_data_get_first_row\fP (\fBnetsnmp_table_data\fP *table)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000108.br
Robert Story6fbe1942005-10-31 09:27:14 +0000109.RI "\fIreturns the first row in the table \fP"
110.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000111.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_table_data_get_next_row\fP (\fBnetsnmp_table_data\fP *table, \fBnetsnmp_table_row\fP *row)"
Robert Story6fbe1942005-10-31 09:27:14 +0000112.br
113.RI "\fIreturns the next row in the table \fP"
114.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000115.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_table_data_get\fP (\fBnetsnmp_table_data\fP *table, \fBnetsnmp_variable_list\fP *indexes)"
Robert Story6fbe1942005-10-31 09:27:14 +0000116.br
117.RI "\fIfinds the data in 'datalist' stored at 'indexes' \fP"
118.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000119.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_table_data_get_from_oid\fP (\fBnetsnmp_table_data\fP *table, oid *searchfor, size_t searchfor_len)"
Robert Story6fbe1942005-10-31 09:27:14 +0000120.br
121.RI "\fIfinds the data in 'datalist' stored at the searchfor oid \fP"
Robert Story2254d872004-09-02 05:57:42 +0000122.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000123.RI "int \fBnetsnmp_table_data_num_rows\fP (\fBnetsnmp_table_data\fP *table)"
Robert Story2254d872004-09-02 05:57:42 +0000124.br
Robert Story6fbe1942005-10-31 09:27:14 +0000125.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000126.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_table_data_row_first\fP (\fBnetsnmp_table_data\fP *table)"
Robert Story6fbe1942005-10-31 09:27:14 +0000127.br
128.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000129.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_table_data_row_get\fP (\fBnetsnmp_table_data\fP *table, \fBnetsnmp_table_row\fP *row)"
Robert Story6fbe1942005-10-31 09:27:14 +0000130.br
131.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000132.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_table_data_row_next\fP (\fBnetsnmp_table_data\fP *table, \fBnetsnmp_table_row\fP *row)"
Robert Story6fbe1942005-10-31 09:27:14 +0000133.br
134.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000135.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_table_data_row_get_byoid\fP (\fBnetsnmp_table_data\fP *table, oid *instance, size_t len)"
Robert Story6fbe1942005-10-31 09:27:14 +0000136.br
137.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000138.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_table_data_row_next_byoid\fP (\fBnetsnmp_table_data\fP *table, oid *instance, size_t len)"
Robert Story6fbe1942005-10-31 09:27:14 +0000139.br
140.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000141.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_table_data_row_get_byidx\fP (\fBnetsnmp_table_data\fP *table, \fBnetsnmp_variable_list\fP *indexes)"
Robert Story6fbe1942005-10-31 09:27:14 +0000142.br
143.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000144.RI "\fBnetsnmp_table_row\fP * \fBnetsnmp_table_data_row_next_byidx\fP (\fBnetsnmp_table_data\fP *table, \fBnetsnmp_variable_list\fP *indexes)"
Robert Story6fbe1942005-10-31 09:27:14 +0000145.br
146.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000147.RI "int \fBnetsnmp_table_data_row_count\fP (\fBnetsnmp_table_data\fP *table)"
Robert Story6fbe1942005-10-31 09:27:14 +0000148.br
149.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000150.RI "void * \fBnetsnmp_table_data_entry_first\fP (\fBnetsnmp_table_data\fP *table)"
Robert Story6fbe1942005-10-31 09:27:14 +0000151.br
152.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000153.RI "void * \fBnetsnmp_table_data_entry_get\fP (\fBnetsnmp_table_data\fP *table, \fBnetsnmp_table_row\fP *row)"
Robert Story6fbe1942005-10-31 09:27:14 +0000154.br
155.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000156.RI "void * \fBnetsnmp_table_data_entry_next\fP (\fBnetsnmp_table_data\fP *table, \fBnetsnmp_table_row\fP *row)"
Robert Story6fbe1942005-10-31 09:27:14 +0000157.br
158.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000159.RI "void * \fBnetsnmp_table_data_entry_get_byidx\fP (\fBnetsnmp_table_data\fP *table, \fBnetsnmp_variable_list\fP *indexes)"
Robert Story6fbe1942005-10-31 09:27:14 +0000160.br
161.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000162.RI "void * \fBnetsnmp_table_data_entry_next_byidx\fP (\fBnetsnmp_table_data\fP *table, \fBnetsnmp_variable_list\fP *indexes)"
Robert Story6fbe1942005-10-31 09:27:14 +0000163.br
164.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000165.RI "void * \fBnetsnmp_table_data_entry_get_byoid\fP (\fBnetsnmp_table_data\fP *table, oid *instance, size_t len)"
Robert Story6fbe1942005-10-31 09:27:14 +0000166.br
167.ti -1c
Wes Hardakerfdd56482006-09-20 00:29:56 +0000168.RI "void * \fBnetsnmp_table_data_entry_next_byoid\fP (\fBnetsnmp_table_data\fP *table, oid *instance, size_t len)"
Robert Story6fbe1942005-10-31 09:27:14 +0000169.br
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000170.in -1c
Robert Story2254d872004-09-02 05:57:42 +0000171.SH "Detailed Description"
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000172.PP
Wes Hardakerfdd56482006-09-20 00:29:56 +0000173Helps you implement a table with datamatted storage.
Dave Shield3f6f5332009-10-29 10:30:23 +0000174
Dave Shieldcac11a92011-06-01 15:08:51 +0000175This helper is obsolete. If you are writing a new \fBmodule\fP, please consider using the table_tdata helper instead.
Robert Story6fbe1942005-10-31 09:27:14 +0000176.PP
Robert Story2254d872004-09-02 05:57:42 +0000177This 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.
178.SH "Function Documentation"
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000179.PP
Dave Shieldcac11a92011-06-01 15:08:51 +0000180.SS "\fBnetsnmp_table_data\fP* netsnmp_create_table_data (const char * name)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000181.PP
Wes Hardakerfdd56482006-09-20 00:29:56 +0000182creates and returns a pointer to table data set
Wes Hardakercb5885f2003-11-14 02:42:44 +0000183.PP
Wes Hardakerfdd56482006-09-20 00:29:56 +0000184Definition at line 52 of file table_data.c.
Wes Hardakerfdd56482006-09-20 00:29:56 +0000185.SS "\fBnetsnmp_table_row\fP* netsnmp_create_table_data_row (void)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000186.PP
Robert Story2254d872004-09-02 05:57:42 +0000187creates and returns a pointer to table data set
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000188.PP
189\fBExamples: \fP
190.in +1c
191\fBdata_set.c\fP.
192.PP
Dave Shield15796262006-01-09 15:06:32 +0000193Definition at line 62 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000194.SS "\fBnetsnmp_table_data\fP* netsnmp_extract_table (\fBnetsnmp_request_info\fP * request)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000195.PP
Wes Hardakerfdd56482006-09-20 00:29:56 +0000196extracts the table being accessed passed from the table_data helper
197.PP
Dave Shield8080a812011-05-06 17:22:14 +0000198Definition at line 656 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000199.SS "\fBnetsnmp_table_row\fP* netsnmp_extract_table_row (\fBnetsnmp_request_info\fP * request)"
Robert Story2254d872004-09-02 05:57:42 +0000200.PP
Wes Hardakerfdd56482006-09-20 00:29:56 +0000201extracts the row being accessed passed from the table_data helper
202.PP
Dave Shield8080a812011-05-06 17:22:14 +0000203Definition at line 664 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000204.SS "void* netsnmp_extract_table_row_data (\fBnetsnmp_request_info\fP * request)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000205.PP
Wes Hardakerfdd56482006-09-20 00:29:56 +0000206extracts the data from the row being accessed passed from the table_data helper
Wes Hardakercb5885f2003-11-14 02:42:44 +0000207.PP
Dave Shield8080a812011-05-06 17:22:14 +0000208Definition at line 673 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000209.SS "\fBnetsnmp_mib_handler\fP* netsnmp_get_table_data_handler (\fBnetsnmp_table_data\fP * table)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000210.PP
Wes Hardakerfdd56482006-09-20 00:29:56 +0000211Creates a table_data handler and returns it.
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000212.PP
Dave Shield8080a812011-05-06 17:22:14 +0000213Definition at line 378 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000214.SS "NETSNMP_INLINE void netsnmp_insert_table_row (\fBnetsnmp_request_info\fP * request, \fBnetsnmp_table_row\fP * row)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000215.PP
Wes Hardakerfdd56482006-09-20 00:29:56 +0000216inserts a newly created table_data row into a request
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000217.PP
Dave Shield8080a812011-05-06 17:22:14 +0000218Definition at line 685 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000219.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)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000220.PP
Wes Hardakerfdd56482006-09-20 00:29:56 +0000221registers a handler as a read-only data table If table_info != NULL, it registers it as a normal table too.
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000222.PP
Dave Shield8080a812011-05-06 17:22:14 +0000223Definition at line 412 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000224.SS "int netsnmp_register_table_data (\fBnetsnmp_handler_registration\fP * reginfo, \fBnetsnmp_table_data\fP * table, \fBnetsnmp_table_registration_info\fP * table_info)"
Wes Hardakerfdd56482006-09-20 00:29:56 +0000225.PP
Dave Shield3f6f5332009-10-29 10:30:23 +0000226registers a handler as a data table. If table_info != NULL, it registers it as a normal table too.
Wes Hardakerfdd56482006-09-20 00:29:56 +0000227.PP
Dave Shield8080a812011-05-06 17:22:14 +0000228Definition at line 401 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000229.SS "int netsnmp_table_data_add_row (\fBnetsnmp_table_data\fP * table, \fBnetsnmp_table_row\fP * row)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000230.PP
Dave Shield3f6f5332009-10-29 10:30:23 +0000231Adds 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)
Wes Hardakercb5885f2003-11-14 02:42:44 +0000232.PP
Wes Hardakerfdd56482006-09-20 00:29:56 +0000233xxx-rks: remove invalid row?
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000234.PP
Dave Shield3f6f5332009-10-29 10:30:23 +0000235Definition at line 134 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000236.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_clone_row (\fBnetsnmp_table_row\fP * row)"
Wes Hardakerfdd56482006-09-20 00:29:56 +0000237.PP
Dave Shield3f6f5332009-10-29 10:30:23 +0000238clones a data row. DOES NOT CLONE THE CONTAINED DATA.
Wes Hardakerfdd56482006-09-20 00:29:56 +0000239.PP
240Definition at line 70 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000241.SS "void* netsnmp_table_data_delete_row (\fBnetsnmp_table_row\fP * row)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000242.PP
Dave Shield3f6f5332009-10-29 10:30:23 +0000243deletes a row's memory. returns the void data that it doesn't know how to delete.
Wes Hardakercb5885f2003-11-14 02:42:44 +0000244.PP
Dave Shield3f6f5332009-10-29 10:30:23 +0000245Definition at line 105 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000246.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_get (\fBnetsnmp_table_data\fP * table, \fBnetsnmp_variable_list\fP * indexes)"
Robert Story6fbe1942005-10-31 09:27:14 +0000247.PP
Wes Hardakerfdd56482006-09-20 00:29:56 +0000248finds the data in 'datalist' stored at 'indexes'
Robert Story6fbe1942005-10-31 09:27:14 +0000249.PP
Dave Shield8080a812011-05-06 17:22:14 +0000250Definition at line 811 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000251.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_get_first_row (\fBnetsnmp_table_data\fP * table)"
Wes Hardakercb5885f2003-11-14 02:42:44 +0000252.PP
Wes Hardakerfdd56482006-09-20 00:29:56 +0000253returns the first row in the table
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000254.PP
Dave Shield8080a812011-05-06 17:22:14 +0000255Definition at line 792 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000256.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_get_from_oid (\fBnetsnmp_table_data\fP * table, oid * searchfor, size_t searchfor_len)"
Wes Hardakercb5885f2003-11-14 02:42:44 +0000257.PP
Wes Hardakerfdd56482006-09-20 00:29:56 +0000258finds the data in 'datalist' stored at the searchfor oid
Wes Hardakercb5885f2003-11-14 02:42:44 +0000259.PP
Dave Shield8080a812011-05-06 17:22:14 +0000260Definition at line 825 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000261.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_get_next_row (\fBnetsnmp_table_data\fP * table, \fBnetsnmp_table_row\fP * row)"
Wes Hardakerfdd56482006-09-20 00:29:56 +0000262.PP
263returns the next row in the table
264.PP
Dave Shield8080a812011-05-06 17:22:14 +0000265Definition at line 801 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000266.SS "void* netsnmp_table_data_remove_and_delete_row (\fBnetsnmp_table_data\fP * table, \fBnetsnmp_table_row\fP * row)"
Wes Hardakerfdd56482006-09-20 00:29:56 +0000267.PP
Dave Shield3f6f5332009-10-29 10:30:23 +0000268removes 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)
Wes Hardakerfdd56482006-09-20 00:29:56 +0000269.PP
Dave Shield3f6f5332009-10-29 10:30:23 +0000270Definition at line 274 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000271.SS "\fBnetsnmp_table_row\fP* netsnmp_table_data_remove_row (\fBnetsnmp_table_data\fP * table, \fBnetsnmp_table_row\fP * row)"
Wes Hardakerfdd56482006-09-20 00:29:56 +0000272.PP
Dave Shield3f6f5332009-10-29 10:30:23 +0000273removes 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)
Wes Hardakerfdd56482006-09-20 00:29:56 +0000274.PP
Dave Shield3f6f5332009-10-29 10:30:23 +0000275Definition at line 248 of file table_data.c.
Dave Shieldcac11a92011-06-01 15:08:51 +0000276.SS "NETSNMP_INLINE void netsnmp_table_data_replace_row (\fBnetsnmp_table_data\fP * table, \fBnetsnmp_table_row\fP * origrow, \fBnetsnmp_table_row\fP * newrow)"
Wes Hardaker27ff28a2002-04-20 00:29:28 +0000277.PP
Dave Shield3f6f5332009-10-29 10:30:23 +0000278swaps out origrow with newrow. This does *not* delete/free anything!
Wes Hardakerfdd56482006-09-20 00:29:56 +0000279.PP
Dave Shield3f6f5332009-10-29 10:30:23 +0000280Definition at line 233 of file table_data.c.
281.SH "Author"
282.PP
283Generated automatically by Doxygen for net-snmp from the source code.