Home Libraries Author Links

StmSharedMemorySampleMboxTypeDoc.h File Reference


Detailed Description

Documentation of the abstract shared memory type StmSharedMemorySampleMboxType.

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

Definition in file StmSharedMemorySampleMboxTypeDoc.h.

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

Go to the source code of this file.

StmSharedMemorySampleMboxType Representation

An object of abstract data type StmSharedMemorySampleMboxType is represented as a pointer to its implementation structure.

Valid objects of type StmSharedMemorySampleMboxType can be achieved only as return values of stmSharedMemorySampleMboxTypeCreate(). Moreover, variables of type StmSharedMemorySampleMboxType may have the value NULL meaning invalid or undefined.

typedef struct
StmSharedMemorySampleMboxTypeImpl_ * 
StmSharedMemorySampleMboxType
 Pointer to implementation.
typedef struct
StmSharedMemorySampleMboxTypeImpl_ * 
ConstStmSharedMemorySampleMboxType
 Pointer to constant implementation.

StmSharedMemorySampleMboxType Creation and Destruction

static
StmSharedMemorySampleMboxType 
stmSharedMemorySampleMboxTypeCreate (const char *name, unsigned int flags, void *data)
 Creation of a new StmSharedMemorySampleMboxType object.
static int stmSharedMemorySampleMboxTypeDestroy (StmSharedMemorySampleMboxType shm)
 Destruction of the StmSharedMemorySampleMboxType object shm.

StmSharedMemorySampleMboxType Method Functions

static int stmSharedMemorySampleMboxTypeInitStatus (StmSharedMemorySampleMboxType shm)
 Get the initialization status of the shared memory SampleMboxType object.
static int stmSharedMemorySampleMboxTypeAdjustChild (StmSharedMemorySampleMboxType shm)
 Adjust the shared memory SampleMboxType object after a fork system call.
static const char * stmSharedMemorySampleMboxTypeName (StmSharedMemorySampleMboxType shm)
 Get the name of the shared memory SampleMboxType object.
static SampleMboxType stmSharedMemorySampleMboxTypeItem (StmSharedMemorySampleMboxType shm)
 Get the shared memory SampleMboxType object.
static SampleMboxType stmSharedMemorySampleMboxTypeLock (StmSharedMemorySampleMboxType shm)
 Lock and get the shared memory SampleMboxType object.
static SampleMboxType stmSharedMemorySampleMboxTypeTryLock (StmSharedMemorySampleMboxType shm)
 Try to lock and get the shared memory SampleMboxType object.
static SampleMboxType stmSharedMemorySampleMboxTypeTimedLock (StmSharedMemorySampleMboxType shm, StmInt64 absTimeMs)
 Try to lock and get the shared memory SampleMboxType object till the number absTimeMs of milliseconds elapsed since the Epoch (1970-01-01).
static int stmSharedMemorySampleMboxTypeUnlock (StmSharedMemorySampleMboxType shm)
 Unlock the shared memory SampleMboxType 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).