nevrax.org : docs

00001 
00007 /* Copyright, 2000-2002 Nevrax Ltd.
00008  *
00009  * This file is part of NEVRAX NEL.
00010  * NEVRAX NEL is free software; you can redistribute it and/or modify
00011  * it under the terms of the GNU General Public License as published by
00012  * the Free Software Foundation; either version 2, or (at your option)
00013  * any later version.
00014 
00015  * NEVRAX NEL is distributed in the hope that it will be useful, but
00016  * WITHOUT ANY WARRANTY; without even the implied warranty of
00017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
00018  * General Public License for more details.
00019 
00020  * You should have received a copy of the GNU General Public License
00021  * along with NEVRAX NEL; see the file COPYING. If not, write to the
00022  * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
00023  * MA 02111-1307, USA.
00024  */
00025 
00026 #ifndef NL_SHARED_MEMORY_H
00027 #define NL_SHARED_MEMORY_H
00028 
00029 #include "nel/misc/types_nl.h"
00030 
00031 #ifdef NL_OS_WINDOWS
00032 #include <map>
00033 #endif
00034 
00035 namespace NLMISC {
00036 
00037 
00038 #ifdef NL_OS_WINDOWS
00039 typedef const char *TSharedMemId;
00040 #else
00041 typedef key_t TSharedMemId;
00042 #endif
00043 
00044 
00045 /* Helpers:
00046  * toSharedMemId: converts an integer to TSharedMemId
00047  * NL_SMID: format type used for printf syntax. Ex: nldebug( "Segment %"NL_SMID" was created", sharedMemId );
00048  */
00049 #ifdef NL_OS_WINDOWS
00050 #define toSharedMemId( id ) toString( "%d", id ).c_str()
00051 #define NL_SMID "s"
00052 #else
00053 #define toSharedMemId( id ) (id)
00054 #define NL_SMID "d"
00055 #endif
00056 
00057 
00068 class CSharedMemory
00069 {
00070 public:
00071 
00072         // Constructor
00073         //CSharedMemory();
00074 
00079         static void *           createSharedMemory( TSharedMemId sharedMemId, uint32 size );
00080 
00084         static void *           accessSharedMemory( TSharedMemId sharedMemId );
00085 
00090         static bool                     closeSharedMemory( void * accessAddress );
00091 
00102   static void destroySharedMemory( TSharedMemId sharedMemId, bool force=false );
00103 };
00104 
00105 
00106 } // NLMISC
00107 
00108 
00109 #endif // NL_SHARED_MEMORY_H
00110 
00111 /* End of shared_memory.h */