X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2FListParser.hh;h=8807578ed0217016cb1450891e082a42b5dcea05;hb=81f84badf27b66dbadec9890646ca1193e998505;hp=817ba4827777607bfbf4a9431edb6b0feebf9e80;hpb=518642ccd4fafcbc944cd09512d9f3ea37097427;p=senf.git diff --git a/Packets/ListParser.hh b/Packets/ListParser.hh index 817ba48..8807578 100644 --- a/Packets/ListParser.hh +++ b/Packets/ListParser.hh @@ -58,7 +58,16 @@ namespace senf { You will normally not instantiate ListParser directly, you will use the \ref SENF_PARSER_LIST() helper macro. - \see ExampleListPolicy + Some basic list access methods are defined as parser members. To access the complete list + API however you will need to instantiate a container wrapper for the list. See \ref + packet_usage_fields_collection. + + \see + \ref How to access \ref packet_usage_fields_collection + SENF_PARSER_LIST() macro used to define list fields \n + ListParser_Container list container wrapper API \n + ExampleListPolicy + \ingroup parsecollection */ template @@ -244,6 +253,9 @@ namespace senf { \c bytes(\a size)\a size gives the size of the list in bytes not the number of contained elements + \c packetSize()Use the size of the packet to get the list size. The + list will occupy all space up to the end of the packet. + \c transform(\a transform, \a size)The \a transform is applied to the \a size value, the value is not used directly @@ -285,6 +297,11 @@ namespace senf { \param[in] size name of field giving the list size \param[in] elt_type list element type + \see + How to use \ref packet_usage_fields_collection \n + senf::ListParser the list parser API for list field access + senf::ListParser_Container the list parser container API for list field access + \hideinitializer \ingroup packetparsermacros */