---

FileHandle_t.h

Go to the documentation of this file.

/****************** <VPR heading BEGIN do not edit this line> *****************
 *
 * VR Juggler Portable Runtime
 *
 * Original Authors:
 *   Allen Bierbaum, Patrick Hartling, Kevin Meinert, Carolina Cruz-Neira
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile: FileHandle_t.h,v $
 * Date modified: $Date: 2003/11/05 21:13:22 $
 * Version:       $Revision: 1.21 $
 * -----------------------------------------------------------------
 *
 ****************** <VPR heading END do not edit this line> ******************/

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2003 by Iowa State University
 *
 * Original Authors:
 *   Allen Bierbaum, Christopher Just,
 *   Patrick Hartling, Kevin Meinert,
 *   Carolina Cruz-Neira, Albert Baker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/

#ifndef _VPR_FILE_HANDLE_BRIDGE_H_
#define _VPR_FILE_HANDLE_BRIDGE_H_

#include <vpr/vprConfig.h>

#include <string>
#include <vector>

#include <vpr/IO/BlockIO.h>
#include <vpr/Util/Interval.h>
#include <vpr/Util/ReturnStatus.h>


namespace vpr
{

template<class RealFileHandleImpl>
class FileHandle_t : public BlockIO
{
public:
   FileHandle_t(const std::string& file_name)
      : BlockIO(file_name), mOpenMode(READ_WRITE), mHandleImpl(file_name)
   {
      /* Do nothing. */ ;
   }

   virtual ~FileHandle_t()
   {
      /* Do nothing. */ ;
   }

   virtual const std::string& getName() const
   {
      return mHandleImpl.getName();
   }

   virtual vpr::ReturnStatus open()
   {
      return mHandleImpl.open();
   }

   virtual vpr::ReturnStatus close()
   {
      return mHandleImpl.close();
   }

   virtual vpr::ReturnStatus setBlocking(bool blocking)
   {
      return mHandleImpl.setBlocking(blocking);
   }

   bool isBlocking() const
   {
      return mHandleImpl.isBlocking();
   }

   virtual IOSys::Handle getHandle() const
   {
      return mHandleImpl.getHandle();
   }

   // ========================================================================
   // vpr::FileHandle API extensions.
   // ========================================================================

   void setOpenReadOnly()
   {
      mHandleImpl.setOpenReadOnly();
   }

   void setOpenWriteOnly()
   {
      mHandleImpl.setOpenWriteOnly();
   }

   void setOpenReadWrite()
   {
      mHandleImpl.setOpenReadWrite();
   }

   vpr::ReturnStatus setAppend(bool flag)
   {
      return mHandleImpl.setAppend(flag);
   }

   vpr::ReturnStatus setSynchronousWrite(bool flag)
   {
      return mHandleImpl.setSynchronousWrite(flag);
   }

   bool isReadOnly() const
   {
      return mHandleImpl.isReadOnly();
   }

   bool isWriteOnly() const
   {
      return mHandleImpl.isWriteOnly();
   }

   bool isReadWrite() const
   {
      return mHandleImpl.isReadWrite();;
   }

protected:
   vpr::ReturnStatus read_i(void* buffer, const vpr::Uint32 length,
                            vpr::Uint32& bytes_read,
                            const vpr::Interval timeout = vpr::Interval::NoTimeout)
   {
      return mHandleImpl.read_i(buffer, length, bytes_read, timeout);
   }

   vpr::ReturnStatus readn_i(void* buffer, const vpr::Uint32 length,
                             vpr::Uint32& bytes_read,
                             const vpr::Interval timeout = vpr::Interval::NoTimeout)
   {
      return mHandleImpl.readn_i(buffer, length, bytes_read, timeout);
   }

   vpr::ReturnStatus write_i(const void* buffer, const vpr::Uint32 length,
                             vpr::Uint32& bytes_written,
                             const vpr::Interval timeout = vpr::Interval::NoTimeout)
   {
      return mHandleImpl.write_i(buffer, length, bytes_written, timeout);
   }

   RealFileHandleImpl mHandleImpl;
};

} // End of vpr namespace


#endif  /* _VPR_FILE_HANDLE_H_ */

---