tabledata:tHaebllpesdyaotua:imHpellepmsenytouaitmapblleemewnittha dtaatbalmeatwtietdh sdtaotraamgaet.t(e3d)storage.(3)

NAME
       netsnmptabledata - Helps you implement a table with datamatted
       storage.



   MMoodduulleess
       groupttaabblleeddaattaasseett:: HHeellppss yyoouu iimmpplleemmeenntt aa ttaabbllee wwiitthh aauuttoommaatttteedd
           ssttoorraaggee..
           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.



   FFuunnccttiioonnss
       void nneettssnnmmppttaabblleeddaattaaggeenneerraatteeiinnddeexxooiidd (netsnmptablerow *row)
           generates the index portion of an table oid from a varlist.
       int nneettssnnmmppttaabblleeddaattaaaaddddrrooww (netsnmptabledata *table,
           netsnmptablerow *row)
           Adds a row of data to a given table (stored in proper lexographical
           order).
       netsnmptablerow * nneettssnnmmppttaabblleeddaattaarreemmoovveerrooww (netsnmptabledata
           *table, netsnmptablerow *row)
           removes a row of data to a given table and returns it (no free's
           called)
       void * nneettssnnmmppttaabblleeddaattaaddeelleetteerrooww (netsnmptablerow *row)
           deletes a row's memory.
       void * nneettssnnmmppttaabblleeddaattaarreemmoovveeaannddddeelleetteerrooww (netsnmptabledata
           *table, netsnmptablerow *row)
           removes and frees a row of data to a given table and returns the
           void *
       NETSNMPINLINE void nneettssnnmmppttaabblleeddaattaarreeppllaacceerrooww (netsnmptabledata
           *table, netsnmptablerow *origrow, netsnmptablerow *newrow)
           swaps out origrow with newrow.
       netsnmptablerow * nneettssnnmmppttaabblleeddaattaaggeett (netsnmptabledata *table,
           nneettssnnmmppvvaarriiaabblleelliisstt *indexes)
           finds the data in 'datalist' stored at 'indexes'
       netsnmptablerow * nneettssnnmmppttaabblleeddaattaaggeettffrroommooiidd (netsnmptabledata
           *table, oid *searchfor, sizet searchforlen)
           finds the data in 'datalist' stored at the searchfor oid
       nneettssnnmmppmmiibbhhaannddlleerr * nneettssnnmmppggeettttaabblleeddaattaahhaannddlleerr
           (netsnmptabledata *table)
           Creates a tabledata handler and returns it.
       int nneettssnnmmpprreeggiisstteerrttaabblleeddaattaa (nneettssnnmmpphhaannddlleerrrreeggiissttrraattiioonn *reginfo,
           netsnmptabledata *table, nneettssnnmmppttaabblleerreeggiissttrraattiioonniinnffoo
           *tableinfo)
           registers a handler as a data table.
       int nneettssnnmmpprreeggiisstteerrrreeaaddoonnllyyttaabblleeddaattaa (nneettssnnmmpphhaannddlleerrrreeggiissttrraattiioonn
           *reginfo, netsnmptabledata *table,
           nneettssnnmmppttaabblleerreeggiissttrraattiioonniinnffoo *tableinfo)
           registers a handler as a read-only data table If tableinfo !=
           NULL, it registers it as a normal table too.
       int nneettssnnmmppttaabblleeddaattaahheellppeerrhhaannddlleerr (nneettssnnmmppmmiibbhhaannddlleerr *handler,
           nneettssnnmmpphhaannddlleerrrreeggiissttrraattiioonn *reginfo, nneettssnnmmppaaggeennttrreeqquueessttiinnffoo
           *reqinfo, nneettssnnmmpprreeqquueessttiinnffoo *requests)
           The helper handler that takes care of passing a specific row of
           data down to the lower handler(s).
       netsnmptabledata * nneettssnnmmppccrreeaatteettaabblleeddaattaa (const char *name)
           creates and returns a pointer to table data set
       netsnmptablerow * nneettssnnmmppccrreeaatteettaabblleeddaattaarrooww (void)
           creates and returns a pointer to table data set
       NETSNMPINLINE void nneettssnnmmppiinnsseerrttttaabblleerrooww (nneettssnnmmpprreeqquueessttiinnffoo
           *request, netsnmptablerow *row)
           inserts a newly created tabledata row into a request
       netsnmptablerow * nneettssnnmmppeexxttrraaccttttaabblleerrooww (nneettssnnmmpprreeqquueessttiinnffoo
           *request)
           extracts the row being accessed passed from the tabledata helper
       netsnmptabledata * nneettssnnmmppeexxttrraaccttttaabbllee (nneettssnnmmpprreeqquueessttiinnffoo
           *request)
           extracts the table being accessed passed from the tabledata helper
       void * nneettssnnmmppeexxttrraaccttttaabblleerroowwddaattaa (nneettssnnmmpprreeqquueessttiinnffoo *request)
           extracts the data from the row being accessed passed from the
           tabledata helper
       int nneettssnnmmppttaabblleeddaattaabbuuiillddrreessuulltt (nneettssnnmmpphhaannddlleerrrreeggiissttrraattiioonn
           *reginfo, nneettssnnmmppaaggeennttrreeqquueessttiinnffoo *reqinfo, nneettssnnmmpprreeqquueessttiinnffoo
           *request, netsnmptablerow *row, int column, uchar type, uchar
           *resultdata, sizet resultdatalen)
           builds a result given a row, a varbind to set and the data
       netsnmptablerow * nneettssnnmmppttaabblleeddaattaacclloonneerrooww (netsnmptablerow
           *row)
           clones a data row.
       int nneettssnnmmppttaabblleeddaattaannuummrroowwss (netsnmptabledata *table)

DDeettaaiilleedd DDeessccrriippttiioonn
       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.

FFuunnccttiioonn DDooccuummeennttaattiioonn
   nneettssnnmmppttaabblleeddaattaa** nneettssnnmmppccrreeaatteettaabblleeddaattaa ((ccoonnsstt cchhaarr ** nnaammee))
       creates and returns a pointer to table data set Definition at line 544
       of file tabledata.c.

       References SNMPMALLOCTYPEDEF.

       Referenced by netsnmpcreatetabledataset().

   nneettssnnmmppttaabblleerrooww** nneettssnnmmppccrreeaatteettaabblleeddaattaarrooww ((vvooiidd))
       creates and returns a pointer to table data set

       EExxaammpplleess::
           ddaattaasseett..cc.

       Definition at line 554 of file tabledata.c.

       References SNMPMALLOCTYPEDEF.

       Referenced by netsnmptabledatasetcreaterowfromdefaults().

   nneettssnnmmppttaabblleeddaattaa** nneettssnnmmppeexxttrraaccttttaabbllee ((nneettssnnmmpprreeqquueessttiinnffoo ** rreeqquueesstt))
       extracts the table being accessed passed from the tabledata helper
       Definition at line 635 of file tabledata.c.

       References netsnmprequestgetlistdata().

   nneettssnnmmppttaabblleerrooww** nneettssnnmmppeexxttrraaccttttaabblleerrooww ((nneettssnnmmpprreeqquueessttiinnffoo **
       rreeqquueesstt))
       extracts the row being accessed passed from the tabledata helper
       Definition at line 627 of file tabledata.c.

       References netsnmprequestgetlistdata().

       Referenced by netsnmpextracttablerowdata(), and
       netsnmptabledatasethelperhandler().

   vvooiidd** nneettssnnmmppeexxttrraaccttttaabblleerroowwddaattaa ((nneettssnnmmpprreeqquueessttiinnffoo ** rreeqquueesstt))
       extracts the data from the row being accessed passed from the
       tabledata helper Definition at line 644 of file tabledata.c.

       References netsnmpextracttablerow().

       Referenced by netsnmpextracttabledatasetcolumn().

   nneettssnnmmppmmiibbhhaannddlleerr** nneettssnnmmppggeettttaabblleeddaattaahhaannddlleerr ((nneettssnnmmppttaabblleeddaattaa **
       ttaabbllee))
       Creates a tabledata handler and returns it. Definition at line 263 of
       file tabledata.c.

       References netsnmpmibhandlers::flags, netsnmpmibhandlers::myvoid,
       netsnmpcreatehandler(), netsnmpmibhandler, and snmplog().

       Referenced by netsnmpregistertabledata().

   NNEETTSSNNMMPPIINNLLIINNEE vvooiidd nneettssnnmmppiinnsseerrttttaabblleerrooww ((nneettssnnmmpprreeqquueessttiinnffoo **
       rreeqquueesstt,, nneettssnnmmppttaabblleerrooww ** rrooww))
       inserts a newly created tabledata row into a request Definition at
       line 562 of file tabledata.c.

       References netsnmptablerequestinfos::indexes,
       netsnmpcreatedatalist(), netsnmpextracttableinfo(),
       netsnmprequestaddlistdata(), netsnmprequestinfos::next,
       netsnmprequestinfos::prev, and snmpoidcompare().

   iinntt nneettssnnmmpprreeggiisstteerrrreeaaddoonnllyyttaabblleeddaattaa ((nneettssnnmmpphhaannddlleerrrreeggiissttrraattiioonn **
       rreeggiinnffoo,, nneettssnnmmppttaabblleeddaattaa ** ttaabbllee,, nneettssnnmmppttaabblleerreeggiissttrraattiioonniinnffoo **
       ttaabblleeiinnffoo))
       registers a handler as a read-only data table If tableinfo != NULL, it
       registers it as a normal table too. Definition at line 297 of file
       tabledata.c.

       References netsnmpgetreadonlyhandler(),
       netsnmphandlerregistration, netsnmpinjecthandler(), and
       netsnmpregistertabledata().

   iinntt nneettssnnmmpprreeggiisstteerrttaabblleeddaattaa ((nneettssnnmmpphhaannddlleerrrreeggiissttrraattiioonn ** rreeggiinnffoo,,
       nneettssnnmmppttaabblleeddaattaa ** ttaabbllee,, nneettssnnmmppttaabblleerreeggiissttrraattiioonniinnffoo **
       ttaabblleeiinnffoo))
       registers a handler as a data table. If tableinfo != NULL, it
       registers it as a normal table too. Definition at line 286 of file
       tabledata.c.

       References netsnmpgettabledatahandler(),
       netsnmphandlerregistration, netsnmpinjecthandler(), and
       netsnmpregistertable().

       Referenced by netsnmpregisterreadonlytabledata(), and
       netsnmpregistertabledataset().

   iinntt nneettssnnmmppttaabblleeddaattaaaaddddrrooww ((nneettssnnmmppttaabblleeddaattaa ** ttaabbllee,,
       nneettssnnmmppttaabblleerrooww ** rrooww))
       Adds a row of data to a given table (stored in proper lexographical
       order). returns SNMPERRSUCCESS on successful addition. or
       SNMPERRGENERR on failure (E.G., indexes already existed) xxx-rks:
       remove invalid row? Definition at line 51 of file tabledata.c.

       References netsnmptabledatagenerateindexoid(), snmplog(), and
       snmpoidcompare().

       Referenced by netsnmptabledatareplacerow(), and
       netsnmptabledatasetaddrow().

   iinntt nneettssnnmmppttaabblleeddaattaabbuuiillddrreessuulltt ((nneettssnnmmpphhaannddlleerrrreeggiissttrraattiioonn **
       rreeggiinnffoo,, nneettssnnmmppaaggeennttrreeqquueessttiinnffoo ** rreeqqiinnffoo,, nneettssnnmmpprreeqquueessttiinnffoo **
       rreeqquueesstt,, nneettssnnmmppttaabblleerrooww ** rrooww,, iinntt ccoolluummnn,, uucchhaarr ttyyppee,, uucchhaarr **
       rreessuullttddaattaa,, ssiizzeett rreessuullttddaattaalleenn))
       builds a result given a row, a varbind to set and the data Definition
       at line 656 of file tabledata.c.

       References netsnmpagentrequestinfos::mode,
       netsnmphandlerregistration, netsnmprequestinfos::requestvb,
       netsnmphandlerregistrations::rootoid,
       netsnmphandlerregistrations::rootoidlen, and
       snmpsetvartypedvalue().

       Referenced by netsnmptabledatahelperhandler(), and
       netsnmptabledatasethelperhandler().

   nneettssnnmmppttaabblleerrooww** nneettssnnmmppttaabblleeddaattaacclloonneerrooww ((nneettssnnmmppttaabblleerrooww ** rrooww))
       clones a data row. DOES NOT CLONE THE CONTAINED DATA. Definition at
       line 690 of file tabledata.c.

       References memdup().

       Referenced by netsnmptabledatasetclonerow().

   vvooiidd** nneettssnnmmppttaabblleeddaattaaddeelleetteerrooww ((nneettssnnmmppttaabblleerrooww ** rrooww))
       deletes a row's memory. returns the void data that it doesn't know how
       to delete. Definition at line 177 of file tabledata.c.

       References SNMPFREE.

       Referenced by netsnmptabledataremoveanddeleterow(), and
       netsnmptabledatasetdeleterow().

   vvooiidd nneettssnnmmppttaabblleeddaattaaggeenneerraatteeiinnddeexxooiidd ((nneettssnnmmppttaabblleerrooww ** rrooww))
       generates the index portion of an table oid from a varlist. Definition
       at line 39 of file tabledata.c.

       References buildoid().

       Referenced by netsnmptabledataaddrow().

   nneettssnnmmppttaabblleerrooww** nneettssnnmmppttaabblleeddaattaaggeett ((nneettssnnmmppttaabblleeddaattaa ** ttaabbllee,,
       nneettssnnmmppvvaarriiaabblleelliisstt ** iinnddeexxeess))
       finds the data in 'datalist' stored at 'indexes' Definition at line 231
       of file tabledata.c.

       References netsnmptabledatagetfromoid().

   nneettssnnmmppttaabblleerrooww** nneettssnnmmppttaabblleeddaattaaggeettffrroommooiidd ((nneettssnnmmppttaabblleeddaattaa **
       ttaabbllee,, ooiidd ** sseeaarrcchhffoorr,, ssiizzeett sseeaarrcchhffoorrlleenn))
       finds the data in 'datalist' stored at the searchfor oid Definition at
       line 245 of file tabledata.c.

       References snmpoidcompare().

       Referenced by netsnmptabledataget(), and
       netsnmptabledatahelperhandler().

   iinntt nneettssnnmmppttaabblleeddaattaahheellppeerrhhaannddlleerr ((nneettssnnmmppmmiibbhhaannddlleerr ** hhaannddlleerr,,
       nneettssnnmmpphhaannddlleerrrreeggiissttrraattiioonn ** rreeggiinnffoo,, nneettssnnmmppaaggeennttrreeqquueessttiinnffoo **
       rreeqqiinnffoo,, nneettssnnmmpprreeqquueessttiinnffoo ** rreeqquueessttss))
       The helper handler that takes care of passing a specific row of data
       down to the lower handler(s). It sets request->processed if the request
       should not be handled. Definition at line 313 of file tabledata.c.

       References netsnmptablerequestinfos::colnum,
       netsnmpmibhandlers::flags,
       netsnmptableregistrationinfos::maxcolumn,
       netsnmptableregistrationinfos::mincolumn,
       netsnmpagentrequestinfos::mode, netsnmpmibhandlers::myvoid,
       variablelist::name, variablelist::namelength,
       netsnmpcallnexthandler(), netsnmpcreatedatalist(),
       netsnmpextracttableinfo(), netsnmpfindtableregistrationinfo(),
       netsnmphandlerregistration, netsnmpmibhandler,
       netsnmprequestaddlistdata(), netsnmpsetrequesterror(),
       netsnmptabledatabuildresult(), netsnmptabledatagetfromoid(),
       netsnmprequestinfos::next, netsnmprequestinfos::processed,
       netsnmprequestinfos::requestvb,
       netsnmphandlerregistrations::rootoid,
       netsnmphandlerregistrations::rootoidlen, SNMPMIN,
       snmpoidcompare(), and variablelist::type.

   vvooiidd** nneettssnnmmppttaabblleeddaattaarreemmoovveeaannddddeelleetteerrooww ((nneettssnnmmppttaabblleeddaattaa ** ttaabbllee,,
       nneettssnnmmppttaabblleerrooww ** rrooww))
       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) Definition at line 206 of file tabledata.c.

       References netsnmptabledatadeleterow(), and
       netsnmptabledataremoverow().

       Referenced by netsnmptabledatasetremoveanddeleterow(), and
       netsnmptabledatasetremoverow().

   nneettssnnmmppttaabblleerrooww** nneettssnnmmppttaabblleeddaattaarreemmoovveerrooww ((nneettssnnmmppttaabblleeddaattaa **
       ttaabbllee,, nneettssnnmmppttaabblleerrooww ** rrooww))
       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) Definition at line 155 of file tabledata.c.

       Referenced by netsnmptabledataremoveanddeleterow(), and
       netsnmptabledatareplacerow().

   NNEETTSSNNMMPPIINNLLIINNEE vvooiidd nneettssnnmmppttaabblleeddaattaarreeppllaacceerrooww ((nneettssnnmmppttaabblleeddaattaa **
       ttaabbllee,, nneettssnnmmppttaabblleerrooww ** oorriiggrrooww,, nneettssnnmmppttaabblleerrooww ** nneewwrrooww))
       swaps out origrow with newrow. This does *not* delete/free anything!
       Definition at line 221 of file tabledata.c.

       References netsnmptabledataaddrow(), and
       netsnmptabledataremoverow().

       Referenced by netsnmptabledatasetreplacerow().



net-snmp   tabledata: Helps you i2m4plJeamnen2t00a5table with datamatted storage.(3)