X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Packets%2FMainpage.dox;h=f5416601f96483ab6af6cdb1fb1d1cd605095219;hb=81ffa1c459b96dd44472bcef37e1e373934ee138;hp=f62651fd32c59af40ca2949f873401c7f4928ca0;hpb=2d6585ff852e9d282c17003ba1db0b73eb3a8500;p=senf.git diff --git a/Packets/Mainpage.dox b/Packets/Mainpage.dox index f62651f..f541660 100644 --- a/Packets/Mainpage.dox +++ b/Packets/Mainpage.dox @@ -128,6 +128,27 @@ a detailed discussion see the respective reference documentation. */ +/** \defgroup protocolbundles Protocol Bundles + + Each protocol bundle provides a collection of related concrete packet classes for a group of + related protocols: + + \li DefaultBundle: Some basic + default protocols: Ethernet, Ip, TCP, UDP + \li MPEGDVBBundle: MPEG and DVB + protocols + + There are two ways to link with a bundle + + \li If you only work with known packets which you explicitly reference you may just link with + the corresponding library. + \li If you need to parse unknown packets and want those to be parsed as complete as possible + without explicitly referencing the packet type, you will need to link against the combined + object file built for every bundle. This way, all packets defined in the bundle will be + included whether they are explicitly referenced or not (and they will all automatically be + registered). + */ + // Local Variables: // mode: c++ @@ -139,8 +160,3 @@ // compile-command: "scons -u doc" // End: -// LocalWords: mainpage SENF packetparser protocolbundles protocolbundle IPv4 -// LocalWords: udp endcode li senf EthernetPacket eth IpV createAfter ip std -// LocalWords: ethernet UDPPacket DataPacket ttl INet MACAddress nothrow prev -// LocalWords: PacketSocketHandle InvalidPacketChainException findNext noinit -// LocalWords: tt TruncatedPacketException const cerr Ooops hh