Home

Libraries

Author

Links

---

StmSharedMemorySampleItemTypeDoc.h File Reference

---

Detailed Description

Documentation of the abstract shared memory type StmSharedMemorySampleItemType.

This C header is generated automatically by the AWK script mksystemtypedoc.awk, which expands the variables ShmGroup, ItemType and TimeoutMs.

Definition in file StmSharedMemorySampleItemTypeDoc.h.

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

StmSharedMemorySampleItemType Representation
An object of abstract data type StmSharedMemorySampleItemType is represented as a pointer to its implementation structure. Valid objects of type StmSharedMemorySampleItemType can be achieved only as return values of stmSharedMemorySampleItemTypeCreate(). Moreover, variables of type StmSharedMemorySampleItemType may have the value NULL meaning invalid or undefined.
typedef struct StmSharedMemorySampleItemTypeImpl_ *	StmSharedMemorySampleItemType
	Pointer to implementation.
typedef struct StmSharedMemorySampleItemTypeImpl_ *	ConstStmSharedMemorySampleItemType
	Pointer to constant implementation.
StmSharedMemorySampleItemType Creation and Destruction
static StmSharedMemorySampleItemType	stmSharedMemorySampleItemTypeCreate (const char *name, unsigned int flags, void *data)
	Creation of a new StmSharedMemorySampleItemType object.
static int	stmSharedMemorySampleItemTypeDestroy (StmSharedMemorySampleItemType shm)
	Destruction of the StmSharedMemorySampleItemType object shm.
StmSharedMemorySampleItemType Method Functions
static int	stmSharedMemorySampleItemTypeInitStatus (StmSharedMemorySampleItemType shm)
	Get the initialization status of the shared memory SampleItemType object.
static int	stmSharedMemorySampleItemTypeAdjustChild (StmSharedMemorySampleItemType shm)
	Adjust the shared memory SampleItemType object after a fork system call.
static const char *	stmSharedMemorySampleItemTypeName (StmSharedMemorySampleItemType shm)
	Get the name of the shared memory SampleItemType object.
static SampleItemType	stmSharedMemorySampleItemTypeItem (StmSharedMemorySampleItemType shm)
	Get the shared memory SampleItemType object.
static SampleItemType	stmSharedMemorySampleItemTypeLock (StmSharedMemorySampleItemType shm)
	Lock and get the shared memory SampleItemType object.
static SampleItemType	stmSharedMemorySampleItemTypeTryLock (StmSharedMemorySampleItemType shm)
	Try to lock and get the shared memory SampleItemType object.
static SampleItemType	stmSharedMemorySampleItemTypeTimedLock (StmSharedMemorySampleItemType shm, StmInt64 absTimeMs)
	Try to lock and get the shared memory SampleItemType object till the number absTimeMs of milliseconds elapsed since the Epoch (1970-01-01).
static int	stmSharedMemorySampleItemTypeUnlock (StmSharedMemorySampleItemType shm)
	Unlock the shared memory SampleItemType object.

---

© Copyright Tom Michaelis 2002-2007

Distributed under the SysToMath Software License (See the accompanying file license.txt or a copy at www.SysToMath.com).