---

FileHandleImplUNIX.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: FileHandleImplUNIX.h,v $
 * Date modified: $Date: 2003/11/05 21:13:24 $
 * Version:       $Revision: 1.41 $
 * -----------------------------------------------------------------
 *
 ****************** <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_IMPL_UNIX_H_
#define _VPR_FILE_HANDLE_IMPL_UNIX_H_

#include <vpr/vprConfig.h>

#include <string>
#include <vector>

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


namespace vpr
{

class FileHandleImplUNIX
{
public:
   FileHandleImplUNIX();

   FileHandleImplUNIX(const std::string& file_name);

   ~FileHandleImplUNIX();

   // ========================================================================
   // vpr::BlockIO basics.
   // ========================================================================

   const std::string& getName() const
   {
      return mName;
   }

   vpr::ReturnStatus open();

   vpr::ReturnStatus close();

   bool isOpen() const
   {
      return mOpen;
   }

   vpr::ReturnStatus setBlocking(bool blocking);

   vpr::IOSys::Handle getHandle() const;

   bool isBlocking() const
   {
      return mBlocking;
   }

   // ========================================================================
   // vpr::FileHandle implementation.
   // ========================================================================

   void setOpenReadOnly();

   void setOpenWriteOnly();

   void setOpenReadWrite();

   vpr::ReturnStatus setAppend(bool flag);

   vpr::ReturnStatus setSynchronousWrite(bool flag);

   bool isReadOnly() const;

   bool isWriteOnly() const;

   bool isReadWrite() const;

   vpr::ReturnStatus getReadBufferSize(vpr::Int32& buffer) const;

   vpr::ReturnStatus read_i(void* buffer, const vpr::Uint32 length,
                            vpr::Uint32& bytes_read,
                            const vpr::Interval timeout = vpr::Interval::NoTimeout);

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

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

   vpr::Uint32 availableBytes() const;

protected:
   // Friends.
   friend class SerialPortImplTermios;
   friend class SocketDatagramImplBSD;
   friend class SocketImplBSD;
   friend class SocketStreamImplBSD;

   int getFlags() const;

   int setFlags(const int flags);

   vpr::ReturnStatus isReadable(const vpr::Interval timeout) const;

   vpr::ReturnStatus isWriteable(const vpr::Interval timeout) const;

   std::string mName;           
   bool        mOpen;           
   bool        mOpenBlocking;
   bool        mBlocking;       
   int mFdesc;      
   int mOpenMode;   
};

} // End of vpr namespace


#endif  /* _VPR_FILE_HANDLE_IMPL_UNIX_H_ */

---