X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2FPacketParser.hh;h=c6a38e82a4844f23915aa838f9a91e4362572ead;hb=a18d131c38ffe7178ea4736ed3f584125e9903ae;hp=1b8c21432cfcffac5e9d79fc1ee00267c666dac5;hpb=8d2d26f114d3df0a60c5c516fcf40671b1e55558;p=senf.git diff --git a/Packets/PacketParser.hh b/Packets/PacketParser.hh index 1b8c214..c6a38e8 100644 --- a/Packets/PacketParser.hh +++ b/Packets/PacketParser.hh @@ -63,13 +63,13 @@ Parsers can be grouped into several categories. These categories are not all defined rigorously but are nevertheless helpful when working with the parsers: - \li Value parsers provide the lowest level parsers (e.g. senf::Parse_UInt16 which + \li \ref parserimpl_value provide the lowest level parsers (e.g. senf::Parse_UInt16 which returns an integer value). - \li Collection parsers are parsers which model a collection of sub-elements like + \li \ref parserimpl_collection are parsers which model a collection of sub-elements like senf::Parse_List or senf::Parse_Vector. - \li Composite parsers collect several fields of arbitrary type into a new + \li \ref parserimpl_composite collect several fields of arbitrary type into a new parser. Parsers defined using the \ref packetparsermacros fall under this category. - \li Packet parsers are used to define a packet type. + \li \ref parserimpl_packet are used to define a packet type. \warning Parsers are like iterators: They are invalidated whenever the size of the packet's data is changed. You should not store a parser anywhere. If you want to keep a parser @@ -118,7 +118,7 @@ You will probably only very seldom need to implement a completely new collection parser. Instead, you can rely on senf::Parse_Vector or senf::Parse_List and implement new - polcies. + policies. \subsection parserimpl_composite Composite parsers @@ -140,7 +140,8 @@ interface. These members may access the packet data in any way. You just need to ensure, that the integration into the packet-type is correct (the senf::PacketTypeMixin will by default use senf::bytes() to find the end of the header). - + +