doclib/Glossary.dox

   1 // $Id$
   2 //
   3 // Copyright (C) 2008
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 //
  24 // Contributor(s):
  25 //   Stefan Bund <g0dil@berlios.de>
  26
  27
  28 /** \page glossary Glossary
  29
  30     <table class="glossary">
  31
  32     <tr><td>collection parser</td> <td>libPackets</td> <td>A packet parser which allows to repeat
  33     another parser or which uses some additional information to decide on the type or number of
  34     sub-parsers.</td></tr>
  35
  36     <tr><td>complete policy</td> <td>libSocket</td> <td>socket policy where each axis is specified
  37     completely</td></tr>
  38
  39     <tr><td>composite parser</td> <td>libPackets</td> <td>A packet parser providing access to named
  40     sub-fields which are parsers themselves.</td></tr>
  41
  42     <tr><td>incomplete policy</td> <td>libSocket</td> <td>socket policy, where at least one axis is
  43     not fully specified</td></tr>
  44
  45     <tr><td>packet interpreter</td> <td>libPackets</td> <td>Internal datastructure which represents
  46     one protocol or header in the chain of interpreters representing a complete packet</td></tr>
  47
  48     <tr><td>packet parser</td> <td>libPackets</td> <td>lightweight class to convert between byte
  49     representation and interpreted value. Derived from senf::PacketParserBase</td></tr>
  50
  51     <tr><td>policy axis</td> <td>libSocket</td> <td>one aspect defined in the socket policy, typedef
  52     and member of the senf::SocketPolicy template</td></tr>
  53
  54     <tr><td>policy class</td> <td>libSocket</td> <td>implementation of a single policy axis, class
  55     derived from the axis base class</td></tr>
  56
  57     <tr><td>policy interface</td> <td>libSocket</td> <td>interface directly provided by
  58     senf::ClientSocketHandle/senf::ServerSocketHandle and defined through the policy</td>
  59
  60     <tr><td>policy</td> <td>libSocket</td> <td>collection of policy classes, one for each policy
  61     axis, instantiation of the SocketPolicy template</td></tr>
  62
  63     <tr><td>protocol class</td> <td>libSocket</td> <td>definition of a protocol as a class, class
  64     inheriting from senf::ConcreteSocketProtocol.</td></tr>
  65
  66     <tr><td>protocol facet</td> <td>libSocket</td> <td>a class providing some subset of the protocol
  67     interface, class derived from senf:;SocketProtocol but not from
  68     senf::ConcreteSocketProtocol</td></tr>
  69
  70     <tr><td>protocol interface</td> <td>libSocket</td> <td>interface provided by the protocol class
  71     and accessible via the
  72     senf::ProtocolClientSocketHandle::protocol()/senf::ProtocolServerSocketHandle::protocol()
  73     member</td></tr>
  74
  75     <tr><td>protocol parser</td> <td>libPackets</td> <td>A composite parser which defines a network
  76     protocol.</td></tr>
  77
  78     <tr><td>socket policy</td> <td>libSocket</td> <td>another name for 'policy'</td></tr>
  79
  80     <tr><td>value parser</td> <td>libPackets</td> <td>A packet parser which parses a simple value
  81     like a number or network address.</td></tr>
  82
  83     </table>
  84  */
  85
  86 \f
  87 // Local Variables:
  88 // mode: c++
  89 // fill-column: 100
  90 // comment-column: 40
  91 // c-file-style: "senf"
  92 // indent-tabs-mode: nil
  93 // ispell-local-dictionary: "american"
  94 // compile-command: "scons -u doc"
  95 // mode: flyspell
  96 // mode: auto-fill
  97 // End: