libbase/noseek_fd_adapter.h

   1 //
   2 //   Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 Free Software
   3 //   Foundation, Inc
   4 //
   5 // This program is free software; you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation; either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software
  17 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18
  19
  20 #ifndef STDIN_ADAPTER_H
  21 #define STDIN_ADAPTER_H
  22
  23 #include "dsodefs.h"
  24
  25
  26
  27 namespace gnash {
  28 class IOChannel;
  29
  30
  31 /// Code to use volatile (non-back-seekable) streams as IOChannel
  32 /// objects (which are seekable by definition) by storing read bytes
  33 /// in a temporary file.
  34 namespace noseek_fd_adapter {
  35
  36 /// \brief
  37 /// Returns a read-only IOChannel that fetches data
  38 /// from an file descriptor open for read.
  39 //
  40 /// The caller owns the returned IOChannel.
  41 ///
  42 /// Specify a cachefilename if you want to be able to access
  43 /// the full cache after deletion of the returned IOChannel.
  44 ///
  45 DSOEXPORT IOChannel* make_stream(int fd, const char* cachefilename = 0);
  46
  47 } // namespace gnash::noseek_fd_adapter
  48 } // namespace gnash
  49
  50
  51 #endif // STDIN_ADAPTER_H
  52
  53 // Local Variables:
  54 // mode: C++
  55 // indent-tabs-mode: t
  56 // End: