the_Foundation 1.0
Loading...
Searching...
No Matches
Data Structures | Macros | Enumerations | Functions
mutex.h File Reference
#include "time.h"
#include "stdthreads.h"

Data Structures

struct  iMutex
 
struct  iCondition
 

Macros

#define iDeclareLockableObject(typeName)
 
#define iDefineLockableObject(typeName)
 
#define iLock(d)   lock_Mutex((d)->mutex)
 
#define iUnlock(d)   unlock_Mutex((d)->mutex)
 
#define iGuard(d, stmt)   {iLock(d); stmt; iUnlock(d);}
 
#define iGuardMutex(d, stmt)
 

Enumerations

enum  iMutexType { nonRecursive_MutexType = 0 , recursive_MutexType = 1 }
 

Functions

iMutex * new_Mutex (void)
 
void delete_Mutex (iMutex *)
 
void init_Mutex (iMutex *)
 
void deinit_Mutex (iMutex *)
 
iMutex * newType_Mutex (enum iMutexType type)
 
iBool lock_Mutex (iMutex *)
 
iBool tryLock_Mutex (iMutex *)
 
void unlock_Mutex (iMutex *)
 
iCondition * new_Condition (void)
 
void delete_Condition (iCondition *)
 
void init_Condition (iCondition *)
 
void deinit_Condition (iCondition *)
 

Detailed Description

Mutual exclusion.

Authors
Copyright (c) 2017 Jaakko Keränen jaakk.nosp@m.o.ke.nosp@m.ranen.nosp@m.@iki.nosp@m..fi
License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

◆ iDeclareLockableObject

#define iDeclareLockableObject (   typeName)
Value:
iDeclareType(Lockable##typeName) \
struct Impl_Lockable##typeName { \
iMutex *mutex; \
i##typeName *value; \
}; \
iDeclareTypeConstruction(Lockable##typeName)

Defines a lockable object type. In practice, this is an object paired with a mutex. Both the objcet and the mutex are created when the lockable object is initialized.

Parameters
typeNameType of the value object.

◆ iDefineLockableObject

#define iDefineLockableObject (   typeName)
Value:
iDefineTypeConstruction(Lockable##typeName) \
void init_Lockable##typeName(iLockable##typeName *d) { \
d->mutex = new_Mutex(); \
d->value = new_##typeName(); \
} \
void deinit_Lockable##typeName(iLockable##typeName *d) { \
delete_Mutex(d->mutex); \
deref_Object(d->value); \
}

◆ iGuardMutex

#define iGuardMutex (   d,
  stmt 
)
Value:
{lock_Mutex (iConstCast(iMutex *, d)); stmt; \
unlock_Mutex(iConstCast(iMutex *, d));}