Home

Libraries

Author

Links

---

system.h

Go to the documentation of this file.

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the SysToMath C Libraries package (LibStmC).
 *
 * The Initial Developer of the Original Code is
 * Tom Michaelis, SysToMath.
 * Portions created by the Initial Developer are Copyright (C) 1994-2006
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

/******************************************************************************
 *                       First Release 1994-07-20
 ******************************************************************************/


#ifndef STM_SYSTEM_H
#define STM_SYSTEM_H


/* Include header files and macro definitions. */
#include <stm/internal/_system.h>


#ifdef __cplusplus
    extern "C" {
#endif


StmDllSpec
int stmGetkey (int fd);


StmDllSpec
StmInt64 stmGetMsTime (void);


StmDllSpec
StmInt64 stmGetMsCount (void);


StmDllSpec
void stmSleepMs (StmDword msecs);


StmDllSpec
int stmAtExit (void (*routine) (void));


StmDllSpec
pid_t stmProcessSpawn
(
    const char *path,
    char *const argv [],
    StmBool usePath
);


StmDllSpec
int stmProcessWait (pid_t pid, int *result);


/* Include StmOnce, StmProcessSemaphore and StmSemaphore implementation types. */
#include <stm/internal/_system.h>


typedef StmOnceImpl_ StmOnce;


#define StmOnceInit StmOnceInitImpl_


StmDllSpec
stm_inline int stmOnce (StmOnce *once, void (*routine) (void));


StmAbstractTypeDefine (StmProcessSemaphore)  /* ProcessSemaphore */



StmDllSpec
StmProcessSemaphore stmProcessSemaphoreCreate (unsigned int value);


StmDllSpec
int stmProcessSemaphoreDestroy (StmProcessSemaphore semaphore);


StmDllSpec
int stmProcessSemaphoreAcquire (StmProcessSemaphore semaphore);


StmDllSpec
int stmProcessSemaphoreTryAcquire (StmProcessSemaphore semaphore);


StmDllSpec
int stmProcessSemaphoreTimedAcquire
(
    StmProcessSemaphore semaphore,
    StmInt64 absTimeMs
);


StmDllSpec
int stmProcessSemaphoreRelease (StmProcessSemaphore semaphore);


enum StmSystemFlags
{
    StmNoSystemFlag   = 0x0000,

    StmAttachExisting = 0x0010,

    StmAttachCreated  = 0x0020,

    StmAttach         = StmAttachExisting | StmAttachCreated,

    StmAttachMask     = StmAttach,

    StmKeepLocked     = 0x0040
};


StmAbstractTypeDefine (StmSemaphore)  /* Semaphore */



StmDllSpec
StmSemaphore stmSemaphoreCreate
(
    const char *name,
    unsigned int value,
    unsigned int attach
);


StmDllSpec
int stmSemaphoreDestroy (StmSemaphore semaphore);


StmDllSpec
int stmSemaphoreAdjustChild (StmSemaphore semaphore);


StmDllSpec
const char *stmSemaphoreName (StmSemaphore semaphore);


StmDllSpec
int stmSemaphoreAcquire (StmSemaphore semaphore);


StmDllSpec
int stmSemaphoreTryAcquire (StmSemaphore semaphore);


StmDllSpec
int stmSemaphoreTimedAcquire
(
    StmSemaphore semaphore,
    StmInt64 absTimeMs
);


StmDllSpec
int stmSemaphoreRelease (StmSemaphore semaphore);


/* Include StmSharedMemory implementation types. */
#include <stm/internal/_system.h>


#define StmSharedMemoryItemDefine(ItemType, TimeoutMs)                         \
StmSharedMemoryItemImpl_ (ItemType, TimeoutMs)


/* Include StmMutex, StmNamedMutex, StmCondition, StmNamedCondition, StmThread
 * and StmThreadSpecific implementation types. */
#include <stm/internal/_system.h>


StmAbstractTypeDefine (StmMutex)  /* Mutex */



StmDllSpec
stm_inline StmMutex stmMutexCreate (StmBool recursive);


StmDllSpec
stm_inline int stmMutexDestroy (StmMutex mutex);


StmDllSpec
stm_inline int stmMutexLock (StmMutex mutex);


StmDllSpec
stm_inline int stmMutexTryLock (StmMutex mutex);


StmDllSpec
stm_inline int stmMutexTimedLock (StmMutex mutex, StmInt64 absTimeMs);


StmDllSpec
stm_inline int stmMutexUnlock (StmMutex mutex);


StmAbstractTypeDefine (StmNamedMutex)  /* NamedMutex */


StmDllSpec
StmNamedMutex stmNamedMutexCreate
(
    const char *name,
    StmBool recursive,
    unsigned int attach
);


StmDllSpec
int stmNamedMutexDestroy (StmNamedMutex mutex);


StmDllSpec
int stmNamedMutexAdjustChild (StmNamedMutex mutex);


StmDllSpec
const char *stmNamedMutexName (StmNamedMutex mutex);


StmDllSpec
int stmNamedMutexLock (StmNamedMutex mutex);


StmDllSpec
int stmNamedMutexTryLock (StmNamedMutex mutex);


StmDllSpec
int stmNamedMutexTimedLock (StmNamedMutex mutex, StmInt64 absTimeMs);


StmDllSpec
int stmNamedMutexUnlock (StmNamedMutex mutex);


StmAbstractTypeDefine (StmCondition)  /* Condition */


StmDllSpec
stm_inline StmCondition stmConditionCreate (void);


StmDllSpec
stm_inline int stmConditionDestroy (StmCondition cond);


StmDllSpec
stm_inline int stmConditionSignal (StmCondition cond);


StmDllSpec
stm_inline int stmConditionBroadcast (StmCondition cond);


StmDllSpec
stm_inline int stmConditionWait
(
    StmCondition cond,
    StmMutex mutex
);


StmDllSpec
stm_inline int stmConditionTimedWait
(
    StmCondition cond,
    StmMutex mutex,
    StmInt64 absTimeMs
);


StmAbstractTypeDefine (StmNamedCondition)  /* NamedCondition */


StmDllSpec
StmNamedCondition stmNamedConditionCreate (const char *name);


StmDllSpec
int stmNamedConditionDestroy (StmNamedCondition cond);


StmDllSpec
int stmNamedConditionAdjustChild (StmNamedCondition cond);


StmDllSpec
const char *stmNamedConditionName (StmNamedCondition cond);


StmDllSpec
int stmNamedConditionSignal (StmNamedCondition cond);


StmDllSpec
int stmNamedConditionBroadcast (StmNamedCondition cond);


StmDllSpec
int stmNamedConditionWait
(
    StmNamedCondition cond,
    StmNamedMutex mutex
);


StmDllSpec
int stmNamedConditionTimedWait
(
    StmNamedCondition cond,
    StmNamedMutex mutex,
    StmInt64 absTimeMs
);


StmAbstractTypeDefine (StmThread)  /* Thread */


StmDllSpec
StmThread stmThreadCreate
(
    void * (*routine) (void *),
    void *arg
);


StmDllSpec
stm_inline int stmThreadDestroy (StmThread thread);


StmDllSpec
int stmThreadAtExit (void (*routine) (void));


StmDllSpec
stm_inline StmThread stmThreadSelf (void);


StmDllSpec
stm_inline int stmThreadCmp (StmThread thread1, StmThread thread2);


StmDllSpec
stm_inline int stmThreadJoin (StmThread thread, void **pResult);


StmAbstractTypeDefine (StmThreadSpecific)  /* ThreadSpecific */


StmDllSpec
stm_inline StmThreadSpecific stmThreadSpecificCreate
(
    void (*destructor) (void *)
);


StmDllSpec
stm_inline int stmThreadSpecificDestroy (StmThreadSpecific threadSpecific);


StmDllSpec
stm_inline void *stmThreadSpecificGet (StmThreadSpecific threadSpecific);


StmDllSpec
stm_inline int stmThreadSpecificSet
(
    StmThreadSpecific threadSpecific,
    const void *value
);


#ifdef __cplusplus
}
#endif


/* Include inline implementation. */
#include <stm/internal/_system.h>


#endif

---

© Copyright Tom Michaelis 2002-2007

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