doclib/Glossary.dox

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \page glossary Glossary
  24
  25     <table class="glossary">
  26
  27     <tr><td>collection parser</td> <td>libPackets</td> <td>A packet parser which allows to repeat
  28     another parser or which uses some additional information to decide on the type or number of
  29     sub-parsers.</td></tr>
  30
  31     <tr><td>complete policy</td> <td>libSocket</td> <td>socket policy where each axis is specified
  32     completely</td></tr>
  33
  34     <tr><td>composite parser</td> <td>libPackets</td> <td>A packet parser providing access to named
  35     sub-fields which are parsers themselves.</td></tr>
  36
  37     <tr><td>incomplete policy</td> <td>libSocket</td> <td>socket policy, where at least one axis is
  38     not fully specified</td></tr>
  39
  40     <tr><td>packet interpreter</td> <td>libPackets</td> <td>Internal datastructure which represents
  41     one protocol or header in the chain of interpreters representing a complete packet</td></tr>
  42
  43     <tr><td>packet parser</td> <td>libPackets</td> <td>lightweight class to convert between byte
  44     representation and interpreted value. Derived from senf::PacketParserBase</td></tr>
  45
  46     <tr><td>policy axis</td> <td>libSocket</td> <td>one aspect defined in the socket policy, typedef
  47     and member of the senf::SocketPolicy template</td></tr>
  48
  49     <tr><td>policy class</td> <td>libSocket</td> <td>implementation of a single policy axis, class
  50     derived from the axis base class</td></tr>
  51
  52     <tr><td>policy interface</td> <td>libSocket</td> <td>interface directly provided by
  53     senf::ClientSocketHandle/senf::ServerSocketHandle and defined through the policy</td>
  54
  55     <tr><td>policy</td> <td>libSocket</td> <td>collection of policy classes, one for each policy
  56     axis, instantiation of the SocketPolicy template</td></tr>
  57
  58     <tr><td>protocol class</td> <td>libSocket</td> <td>definition of a protocol as a class, class
  59     inheriting from senf::ConcreteSocketProtocol.</td></tr>
  60
  61     <tr><td>protocol facet</td> <td>libSocket</td> <td>a class providing some subset of the protocol
  62     interface, class derived from senf:;SocketProtocol but not from
  63     senf::ConcreteSocketProtocol</td></tr>
  64
  65     <tr><td>protocol interface</td> <td>libSocket</td> <td>interface provided by the protocol class
  66     and accessible via the
  67     senf::ProtocolClientSocketHandle::protocol()/senf::ProtocolServerSocketHandle::protocol()
  68     member</td></tr>
  69
  70     <tr><td>protocol parser</td> <td>libPackets</td> <td>A composite parser which defines a network
  71     protocol.</td></tr>
  72
  73     <tr><td>socket policy</td> <td>libSocket</td> <td>another name for 'policy'</td></tr>
  74
  75     <tr><td>value parser</td> <td>libPackets</td> <td>A packet parser which parses a simple value
  76     like a number or network address.</td></tr>
  77
  78     </table>
  79  */
  80
  81 \f
  82 // Local Variables:
  83 // mode: c++
  84 // fill-column: 100
  85 // comment-column: 40
  86 // c-file-style: "senf"
  87 // indent-tabs-mode: nil
  88 // ispell-local-dictionary: "american"
  89 // compile-command: "scons -u doc"
  90 // mode: flyspell
  91 // mode: auto-fill
  92 // End: