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>complete policy</td> <td>libSocket</td> <td>socket policy where each axis is specified
  28     completely</td></tr>
  29
  30     <tr><td>incomplete policy</td> <td>libSocket</td> <td>socket policy, where at least one axis is
  31     not fully specified</td></tr>
  32
  33     <tr><td>policy axis</td> <td>libSocket</td> <td>one aspect defined in the socket policy, typedef
  34     and member of the senf::SocketPolicy template</td></tr>
  35
  36     <tr><td>policy class</td> <td>libSocket</td> <td>implementation of a single policy axis, class
  37     derived from the axis base class</td></tr>
  38
  39     <tr><td>policy interface</td> <td>libSocket</td> <td>interface directly provided by
  40     senf::ClientSocketHandle/senf::ServerSocketHandle and defined through the policy</td>
  41
  42     <tr><td>policy</td> <td>libSocket</td> <td>collection of policy classes, one for each policy
  43     axis, instantiation of the SocketPolicy template</td></tr>
  44
  45     <tr><td>protocol class</td> <td>libSocket</td> <td>definition of a protocol as a class, class
  46     inheriting from senf::ConcreteSocketProtocol.</td></tr>
  47
  48     <tr><td>protocol facet</td> <td>libSocket</td> <td>a class providing some subset of the protocol
  49     interface, class derived from senf:;SocketProtocol but not from
  50     senf::ConcreteSocketProtocol</td></tr>
  51
  52     <tr><td>protocol interface</td> <td>libSocket</td> <td>interface provided by the protocol class
  53     and accessible via the
  54     senf::ProtocolClientSocketHandle::protocol()/senf::ProtocolServerSocketHandle::protocol()
  55     member</td></tr>
  56
  57     <tr><td>socket policy</td> <td>libSocket</td> <td>another name for 'policy'</td></tr>
  58
  59     </table>
  60  */
  61
  62 \f
  63 // Local Variables:
  64 // mode: c++
  65 // fill-column: 100
  66 // comment-column: 40
  67 // c-file-style: "senf"
  68 // indent-tabs-mode: nil
  69 // ispell-local-dictionary: "american"
  70 // compile-command: "scons -u test"
  71 // mode: flyspell
  72 // mode: auto-fill
  73 // End: