Synchronisation Control Shims
[Synchronisation Library, Shims]

---

Detailed Description

These shims control the behaviour of synchronisation objects.

Functions
void	lock_instance (stlsoft::null_mutex &mx)
	This control shim aquires a lock on the given mutex.
void	unlock_instance (stlsoft::null_mutex &mx)
	This control shim releases a lock on the given mutex.
void	lock_instance (unixstl_ns_qual(process_mutex)&mx)
	This control shim aquires a lock on the given mutex.
void	unlock_instance (unixstl_ns_qual(process_mutex)&mx)
	This control shim releases a lock on the given mutex.
void	lock_instance (unixstl_ns_qual(semaphore)&sem)
	This control shim aquires a lock on the given semaphore.
void	unlock_instance (unixstl_ns_qual(semaphore)&sem)
	This control shim releases a lock on the given semaphore.
template<typename SP>
void	lock_instance (unixstl_ns_qual(spin_mutex_base)< SP > &mx)
	This control shim aquires a lock on the given mutex.
template<typename SP>
void	unlock_instance (unixstl_ns_qual(spin_mutex_base)< SP > &mx)
	This control shim releases a lock on the given mutex.
void	lock_instance (unixstl_ns_qual(thread_mutex)&mx)
	This control shim aquires a lock on the given mutex.
void	unlock_instance (unixstl_ns_qual(thread_mutex)&mx)
	This control shim releases a lock on the given mutex.
void	lock_instance (winstl_ns_qual(process_mutex)&mx)
	This control shim aquires a lock on the given mutex.
void	unlock_instance (winstl_ns_qual(process_mutex)&mx)
	This control shim releases a lock on the given mutex.
void	lock_instance (winstl_ns_qual(semaphore)&sem)
	This control shim aquires a lock on the given semaphore.
void	unlock_instance (winstl_ns_qual(semaphore)&sem)
	This control shim releases a lock on the given semaphore.
template<typename SP>
void	lock_instance (winstl_ns_qual(spin_mutex_base)< SP > &mx)
	This control shim aquires a lock on the given mutex.
template<typename SP>
void	unlock_instance (winstl_ns_qual(spin_mutex_base)< SP > &mx)
	This control shim releases a lock on the given mutex.
void	lock_instance (winstl_ns_qual(thread_mutex)&mx)
	This control shim aquires a lock on the given mutex.
void	unlock_instance (winstl_ns_qual(thread_mutex)&mx)
	This control shim releases a lock on the given mutex.

---

Function Documentation

void lock_instance

(

winstl_ns_qual(thread_mutex)&

mx

)

[inline]

This control shim aquires a lock on the given mutex.

Parameters:

mx

The mutex on which to aquire the lock.

void lock_instance

(

winstl_ns_qual(spin_mutex_base)< SP > &

mx

)

[inline]

This control shim aquires a lock on the given mutex.

Parameters:

mx

The mutex on which to aquire the lock.

void lock_instance

(

winstl_ns_qual(semaphore)&

sem

)

[inline]

This control shim aquires a lock on the given semaphore.

Parameters:

sem

The semaphore on which to aquire the lock.

void lock_instance

(

winstl_ns_qual(process_mutex)&

mx

)

[inline]

This control shim aquires a lock on the given mutex.

Parameters:

mx

The mutex on which to aquire the lock.

void lock_instance

(

unixstl_ns_qual(thread_mutex)&

mx

)

[inline]

This control shim aquires a lock on the given mutex.

Parameters:

mx

The mutex on which to aquire the lock.

void lock_instance

(

unixstl_ns_qual(spin_mutex_base)< SP > &

mx

)

[inline]

This control shim aquires a lock on the given mutex.

Parameters:

mx

The mutex on which to aquire the lock.

void lock_instance

(

unixstl_ns_qual(semaphore)&

sem

)

[inline]

This control shim aquires a lock on the given semaphore.

Parameters:

sem

The semaphore on which to aquire the lock.

void lock_instance

(

unixstl_ns_qual(process_mutex)&

mx

)

[inline]

This control shim aquires a lock on the given mutex.

Parameters:

mx

The mutex on which to aquire the lock.

Referenced by thread_mutex_lock_traits::lock(), spin_mutex_lock_traits::lock(), semaphore_lock_traits::lock(), and process_mutex_lock_traits::lock().

void stlsoft::lock_instance

(

stlsoft::null_mutex &

mx

)

[inline]

This control shim aquires a lock on the given mutex.

Parameters:

mx

The mutex on which to aquire the lock.

References STLSOFT_SUPPRESS_UNUSED.

Referenced by lock_traits::lock(), and lock_invert_traits::unlock().

void unlock_instance

(

winstl_ns_qual(thread_mutex)&

mx

)

[inline]

This control shim releases a lock on the given mutex.

Parameters:

mx

The mutex on which to release the lock

void unlock_instance

(

winstl_ns_qual(spin_mutex_base)< SP > &

mx

)

[inline]

This control shim releases a lock on the given mutex.

Parameters:

mx

The mutex on which to release the lock

void unlock_instance

(

winstl_ns_qual(semaphore)&

sem

)

[inline]

This control shim releases a lock on the given semaphore.

Parameters:

sem

The semaphore on which to release the lock

void unlock_instance

(

winstl_ns_qual(process_mutex)&

mx

)

[inline]

This control shim releases a lock on the given mutex.

Parameters:

mx

The mutex on which to release the lock

void unlock_instance

(

unixstl_ns_qual(thread_mutex)&

mx

)

[inline]

This control shim releases a lock on the given mutex.

Parameters:

mx

The mutex on which to release the lock

void unlock_instance

(

unixstl_ns_qual(spin_mutex_base)< SP > &

mx

)

[inline]

This control shim releases a lock on the given mutex.

Parameters:

mx

The mutex on which to release the lock

void unlock_instance

(

unixstl_ns_qual(semaphore)&

sem

)

[inline]

This control shim releases a lock on the given semaphore.

Parameters:

sem

The semaphore on which to release the lock

void unlock_instance

(

unixstl_ns_qual(process_mutex)&

mx

)

[inline]

This control shim releases a lock on the given mutex.

Parameters:

mx

The mutex on which to release the lock

Referenced by thread_mutex_lock_traits::unlock(), spin_mutex_lock_traits::unlock(), semaphore_lock_traits::unlock(), and process_mutex_lock_traits::unlock().

void stlsoft::unlock_instance

(

stlsoft::null_mutex &

mx

)

[inline]

This control shim releases a lock on the given mutex.

Parameters:

mx

The mutex on which to release the lock

References STLSOFT_SUPPRESS_UNUSED.

Referenced by lock_invert_traits::lock(), and lock_traits::unlock().