gml_SharedMemorySegment.h File Reference

Detailed Description

Cross-platform C shared memory regions.


Functions
GML_EXTERN_C gml_TError	gml_SharedMemorySegment_Attach (void *handle, UInt32 size, UInt32 *name)
	Map a named shared memory segment into process memory, possibly creating it in the process.
GML_EXTERN_C gml_TError	gml_SharedMemorySegment_Detach (void *handle)
	Unmap the segment mapped at handle from memory.

GML_EXTERN_C gml_TError gml_SharedMemorySegment_Attach	(	void **	handle,
		UInt32 *	size,
		UInt32 *	name
	)

Map a named shared memory segment into process memory, possibly creating it in the process.

If the calling thread terminates without calling gml_SharedMemorySegment_Detach, the segment will be unmapped automatically.

Parameters:

handle	on return, pointer to the first byte of the shared segment
size	size of the segment to map
name	segment name (system-wide namespace)

GML_EXTERN_C gml_TError gml_SharedMemorySegment_Detach ( void * handle )

Unmap the segment mapped at handle from memory.

If the segment was created by this process, also remove it from the segment namespace.