cygnal/serverSO.h

   1 //
   2 //   Copyright (C) 2009, 2010 Free Software Foundation, Inc.
   3 //
   4 // This program is free software; you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation; either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with this program; if not, write to the Free Software
  16 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17
  18 #ifndef __SERVERSO_H__
  19 #define __SERVERSO_H__
  20
  21 #include <iostream>
  22
  23 #include "sol.h"
  24 #include "element.h"
  25
  26 /// \namespace cygnal
  27 ///
  28 /// This namespace is for all the Cygnal specific classes not used by
  29 /// anything else in Gnash.
  30 namespace cygnal {
  31
  32 /// \class cygnal::ServerSO
  33 ///     This class handles storing SharedObject on the server side.
  34 ///     The SOL class is used to optionally read and write a disk
  35 ///     file similar to the client side.
  36 class DSOEXPORT ServerSO : public cygnal::SOL
  37 {
  38 public:
  39     ServerSO();
  40     ~ServerSO();
  41
  42     /// \brief Dump the internal data of this class in a human readable form.
  43     /// @remarks This should only be used for debugging purposes.
  44     void dump() const { dump(std::cerr); }
  45
  46     /// \overload dump(std::ostream& os) const
  47     void dump(std::ostream& os) const;
  48
  49 };
  50
  51 /// \brief Dump to the specified output stream.
  52 inline std::ostream& operator << (std::ostream& os, const ServerSO &so)
  53 {
  54     so.dump(os);
  55     return os;
  56 }
  57
  58 // End of gnash namespace
  59 }
  60
  61 // __SERVERSO_H__
  62 #endif
  63
  64
  65 // local Variables:
  66 // mode: C++
  67 // indent-tabs-mode: t
  68 // End: