← Back to branch summary

~ubuntu-branches/ubuntu/wily/net-snmp/wily-proposed

« back to all changes in this revision

Viewing changes to man/netsnmp_table_maintenance.3

  • Committer: Bazaar Package Importer
  • Author(s): Chuck Short
  • Date: 2010-06-28 14:59:36 UTC
  • mfrom: (1.2.3 upstream) (1.1.12 sid)
  • Revision ID: james.westby@ubuntu.com-20100628145936-cbiallic69pn044g
Tags: 5.4.3~dfsg-1ubuntu1
https://launchpad.net/bugs/104738
https://launchpad.net/bugs/254261
https://launchpad.net/bugs/250459
https://launchpad.net/bugs/589056
https://launchpad.net/bugs/573391
https://launchpad.net/bugs/533603
* Merge from debian unstable.  Remaining changes:
  - Set Ubuntu maintainer address.
  - net-snmp-config: Use bash. (LP: #104738)
  - Removed multiuser option when calling update-rc.d. (LP: #254261)
  - debian/snmpd.init: LSBify the init script.
  - debian/patches/52_fix_snmpcmd_1_typo.patch: Adjust a typo in snmpcmd.1
    (LP: #250459)
  - debian/snmpd.postinst: source debconf before doing work, LP: #589056
  - debian/snmp.preinst, debian/snmp.prerm: kill any/all processes owned by
    snmp user before install/uninstall, LP: #573391
  - Add apport hook (LP: #533603):
  - debian/{snmp,snmpd}.apport: Added.
  - debian/control: Build-depends on dh-apport.
  - debian/rules: 
    + Add --with apport.
    + override_dh_apport to install hook on snmpd package only.
 * Dropped patches:
   - debian/patches/99-fix-ubuntu-div0.patch: Fix dvision by zero.. 

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/netsnmp_table_maintenance.3
1
 
.TH "table_maintenance" 3 "5 Sep 2008" "Version 5.4.2" "net-snmp" \" -*- nroff -*-
 
1
.TH "table_maintenance" 3 "23 May 2010" "Version 5.4.3.pre1" "net-snmp" \" -*- nroff -*-
2
2
.ad l
3
3
.nh
4
4
.SH NAME
5
 
table_maintenance \- Routines for maintaining the contents of a table.  
 
5
table_maintenance \- 
 
6
.PP
 
7
Routines for maintaining the contents of a table.  
6
8
 
7
 
.PP
8
9
.SS "Functions"
9
10
 
10
11
.in +1c
52
53
.SH "Detailed Description"
53
54
.PP 
54
55
Routines for maintaining the contents of a table. 
55
 
.PP
 
56
 
56
57
This would typically be part of implementing an SNMP MIB, but could potentially also be used for a standalone table.
57
58
.PP
58
59
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
71
Definition at line 82 of file table_generic.c.
71
72
.SS "int netsnmp_generic_copy_row (void * dst_row, void * src_row)"
72
73
.PP
73
 
Copy the contents of one row into another. 
74
 
.PP
75
 
The destination row structure should be created before this routine is called. 
 
74
Copy the contents of one row into another. The destination row structure should be created before this routine is called. 
76
75
.PP
77
76
Definition at line 90 of file table_generic.c.
78
77
.SS "void* netsnmp_generic_create_row (void)"
79
78
.PP
80
 
Create a new row structure suitable for this style of table. 
81
 
.PP
82
 
Note that this would typically be a 'standalone' row, and would not automatically be inserted into an actual table. 
 
79
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. 
83
80
.PP
84
81
Definition at line 76 of file table_generic.c.
85
82
.SS "void* netsnmp_generic_create_table (const char * name, int flags)"
86
83
.PP
87
 
Create a structure to represent the table. 
88
 
.PP
89
 
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.
 
84
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.
90
85
.PP
91
86
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. 
92
87
.PP
93
88
Definition at line 60 of file table_generic.c.
94
89
.SS "void netsnmp_generic_delete_row (void * row)"
95
90
.PP
96
 
Delete a row data structure. 
97
 
.PP
98
 
The row should be removed from any relevant table(s) before this routine is called. 
 
91
Delete a row data structure. The row should be removed from any relevant table(s) before this routine is called. 
99
92
.PP
100
93
Definition at line 98 of file table_generic.c.
101
94
.SS "void netsnmp_generic_delete_table (void * table)"
102
95
.PP
103
 
Release the structure representing a table. 
104
 
.PP
105
 
Any rows still contained within the table should also be removed and deleted. 
 
96
Release the structure representing a table. Any rows still contained within the table should also be removed and deleted. 
106
97
.PP
107
98
Definition at line 68 of file table_generic.c.
108
99
.SS "void netsnmp_generic_remove_delete_row (void * table, void * row)"
112
103
Definition at line 127 of file table_generic.c.
113
104
.SS "void* netsnmp_generic_remove_row (void * table, void * row)"
114
105
.PP
115
 
Remove a row from the table. 
116
 
.PP
117
 
The data structure for the row should not be released, and would be the return value of this routine. 
 
106
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. 
118
107
.PP
119
108
Definition at line 121 of file table_generic.c.
120
109
.SS "int netsnmp_generic_replace_row (void * table, void * old_row, void * new_row)"
121
110
.PP
122
 
Replace one row with another in the table. 
123
 
.PP
124
 
This will typically (but not necessarily) involve two rows sharing the same index information (e.g. to implement update/restore-style SET behaviour). 
 
111
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). 
125
112
.PP
126
113
Definition at line 113 of file table_generic.c.
 
114
.SH "Author"
 
115
.PP 
 
116
Generated automatically by Doxygen for net-snmp from the source code.