X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2FPacketParser.hh;h=59124e3c87d0b1954aa01fb6a9fb4dc1f8ee9af2;hb=f1b6be637cef2c9693aab9be3c2b33b67bc22b76;hp=9be6b2915a90c568be1906329111a81b3d4a1070;hpb=43ebe17b77586542dff65f2535815a19812e4316;p=senf.git diff --git a/Packets/PacketParser.hh b/Packets/PacketParser.hh index 9be6b29..59124e3 100644 --- a/Packets/PacketParser.hh +++ b/Packets/PacketParser.hh @@ -136,16 +136,16 @@ parsers). When defining composite parsers without the help of the \ref packetparsermacros, you should provide those same members. - \subsection parserimpl_packet Packet parsers - - Packet parsers are composite parsers with relaxed requirements. Since a packet parser will never - be used as a sub-parser (it will not be used within another composite parser or as value type in - a collection parser), the value returned by senf::bytes for this parser must not necessarily - cover the complete packet (e.g. if the packet has a trailer, the trailer will live outside the - range given by senf::bytes). You may define any member you want to have in your packets field - 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). + \subsection parserimpl_packet Protocol parsers + + Protocol parsers are composite parsers with relaxed requirements. Since a Protocol parser will + never be used as a sub-parser (it will not be used within another composite parser or as value + type in a collection parser), the value returned by senf::bytes for this parser must not + necessarily cover the complete packet (e.g. if the packet has a trailer, the trailer will live + outside the range given by senf::bytes). You may define any member you want to have in your + packets field 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).
*/