From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/classNLMISC_1_1CSharedMemory.html | 270 +++++++++++++++++++++ 1 file changed, 270 insertions(+) create mode 100644 docs/doxygen/nel/classNLMISC_1_1CSharedMemory.html (limited to 'docs/doxygen/nel/classNLMISC_1_1CSharedMemory.html') diff --git a/docs/doxygen/nel/classNLMISC_1_1CSharedMemory.html b/docs/doxygen/nel/classNLMISC_1_1CSharedMemory.html new file mode 100644 index 00000000..fe9cae18 --- /dev/null +++ b/docs/doxygen/nel/classNLMISC_1_1CSharedMemory.html @@ -0,0 +1,270 @@ + + + + nevrax.org : docs + + + + + + + + + + + + + + +
# Home   # nevrax.com   
+ + + + +
Nevrax
+ + + + + + + + + + +
+ + +
+ Nevrax.org
+ + + + + + + +
#News
#Mailing-list
#Documentation
#CVS
#Bugs
#License
+
+ + + 		+ + +
+Docs + +
+  + + + + + +
Documentation 
+ +
+Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages   Search  
+

NLMISC::CSharedMemory Class Reference

Encapsulation of shared memory APIs. +More... +

+#include <shared_memory.h> +

+List of all members. + + + + + + + + + +

Static Public Methods

void * createSharedMemory (TSharedMemId sharedMemId, uint32 size)
 Create a shared memory segment and get access to it. More...

void * accessSharedMemory (TSharedMemId sharedMemId)
 Get access to an existing shared memory segment. More...

bool closeSharedMemory (void *accessAddress)
 Close a shared memory segment, given the address returned by createSharedMemory() or accessSharedMemory(). More...

void destroySharedMemory (TSharedMemId sharedMemId, bool force=false)
 Destroy a shared memory segment (must be call by the process that created the segment, not by the accessors). More...

+

Detailed Description

+Encapsulation of shared memory APIs. +

+Using file mapping under Windows, System V shared memory (shm) under Linux. +

+Note: under Linux, an option could be added to prevent a segment to be swapped out. +

+

+Author:
+Olivier Cado , Nevrax France
+Date:
+2002
+

+ +

+Definition at line 68 of file shared_memory.h.

Member Function Documentation

+

+ + + + +
+ + + + + + + + + + +
void * NLMISC::CSharedMemory::accessSharedMemory ( TSharedMemId   sharedMemId )  [static]
+
+ + + + + +
+   + + +

+Get access to an existing shared memory segment. +

+The id must be used.

+Returns:
+Access address of the segment. Its size was determined at the creation.
+

+Definition at line 90 of file shared_memory.cpp. +

+References NLMISC::TSharedMemId.

+

+ + + + +
+ + + + + + + + + + +
bool NLMISC::CSharedMemory::closeSharedMemory ( void *   accessAddress )  [static]
+
+ + + + + +
+   + + +

+Close a shared memory segment, given the address returned by createSharedMemory() or accessSharedMemory(). +

+Must be called by each process that called createSharedMemory() or accessSharedMemory(). +

+Definition at line 125 of file shared_memory.cpp.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void * NLMISC::CSharedMemory::createSharedMemory ( TSharedMemId   sharedMemId,
uint32   size
)  [static]
+
+ + + + + +
+   + + +

+Create a shared memory segment and get access to it. +

+The id must not be used. The id 0x3a732235 is used by the NeL memory manager.

+Returns:
+Access address of the segment of the choosen size
+

+Definition at line 55 of file shared_memory.cpp. +

+References NLMISC::SharedMemIdsToShmids, and NLMISC::TSharedMemId.

+

+ + + + +
+ + + + + + + + + + + + + + + + + + + +
void NLMISC::CSharedMemory::destroySharedMemory ( TSharedMemId   sharedMemId,
bool   force = false
)  [static]
+
+ + + + + +
+   + + +

+Destroy a shared memory segment (must be call by the process that created the segment, not by the accessors). +

+"Rescue feature": set "force" to true if a segment was created and left out of control (meaning a new createSharedMemory() with the same sharedMemId fails), but before, make sure the segment really belongs to you! +

+Note: this method does nothing under Windows, destroying is automatic. +

+Definition at line 159 of file shared_memory.cpp. +

+References NLMISC::SharedMemIdsToShmids, and NLMISC::TSharedMemId.

+

The documentation for this class was generated from the following files: + + + +
                                                                                                                                                                    +
+ + -- cgit v1.2.1