Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members

FXMemoryMappedStream.h

Go to the documentation of this file.
00001 /********************************************************************************
00002 *                                                                               *
00003 *                  Memory Mapped File Stream                                    *
00004 *                                                                               *
00005 *********************************************************************************
00006 * Copyright (C) 2003 by Mathew Robertson.   All Rights Reserved.                *
00007 *********************************************************************************
00008 * This library is free software; you can redistribute it and/or                 *
00009 * modify it under the terms of the GNU Lesser General Public                    *
00010 * License as published by the Free Software Foundation; either                  *
00011 * version 2.1 of the License, or (at your option) any later version.            *
00012 *                                                                               *
00013 * This library is distributed in the hope that it will be useful,               *
00014 * but WITHOUT ANY WARRANTY; without even the implied warranty of                *
00015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU             *
00016 * Lesser General Public License for more details.                               *
00017 *                                                                               *
00018 * You should have received a copy of the GNU Lesser General Public              *
00019 * License along with this library; if not, write to the Free Software           *
00020 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.    *
00021 ********************************************************************************/
00022 #ifndef FXMEMORYMAPPEDSTREAM_H
00023 #define FXMEMORYMAPPEDSTREAM_H
00024 
00025 #ifndef FXSTREAM_H
00026 #include "FXStream.h"
00027 #endif
00028 namespace FXEX {
00029 
00030 /**
00031  * Allows you to serailise/deserialise an FXStream from a file which has been memory mapped.
00032  */
00033 class FXAPI FXMemoryMappedStream : public FXStream {
00034 private:
00035   FXuchar      *region;   // memory mapped region
00036   unsigned long space;    // region size
00037 protected:
00038   virtual void saveItems(const void *buf,unsigned long n);
00039   virtual void loadItems(void *buf,unsigned long n);
00040 
00041 public:
00042   /// Create stream to bind to memory mapped region of file
00043   FXMemoryMappedStream(const FXObject* cont=NULL);
00044 
00045   /// Open file store
00046   FXbool open(void* region,unsigned long size,FXStreamDirection save_or_load);
00047 
00048   /// Close file store
00049   FXbool close();
00050 
00051   /// Move to position
00052   virtual FXbool position(unsigned long p);
00053 
00054   /// Save to stream
00055   virtual FXStream& operator<<(const FXuchar& v);
00056   virtual FXStream& operator<<(const FXchar& v);
00057 
00058   /// Load from stream
00059   virtual FXStream& operator>>(FXuchar& v);
00060   virtual FXStream& operator>>(FXchar& v);
00061 
00062   /// Destructor
00063   virtual ~FXMemoryMappedStream();
00064   };
00065 
00066 } // namespace FXEX
00067 #endif // FXMEMORYMAPPEDSTREAM_H