Macro RTSPINLOCK

RTSPINLOCK statically initializes a spinlock:

typedef struct RTSpinlock; 
RTSpinlock RTSPINLOCK(DWORD Flags, const char * Name);

Parameters

Flags

Zero or a combination of the following values. Please note that these flags are only evaluated by RTLockSpinlock and RTReleaseSpinlock. RTLockSpinlockFast and RTReleaseSpinlockFast always assume that no flags are set.

Value	Meaning
RT_SPIN_RECURSIVE	Nested locking/releasing of the spinlock is supported. The deepest supported nesting level is 255.
RT_SPIN_NO_INTS_DISABLE	RTLockSpinlock shall not disable interrupts.
RT_SPIN_FAIL_TIMEOUT	RTLockSpinlock shall return failure when it times out. By default, RTLockSpinlock retries the operation indefinitely.
RT_SPIN_NO_MSG	RTLockSpinlock and RTReleaseSpinlockFast shall not call the RTSpinlockError handler on error.

Name

A string containing the name of the spinlock. Only a pointer to this string is maintained by the spinlock, so the string must not be deallocated. It is used for diagnostics purposes only.

return value

This macro returns a static spinlock structure which can be assigned to a spinlock when it is declared.

Example:

RTSpinlock MySpin = RTSPINLOCK(RT_SPIN_FAIL_TIMEOUT, "My Spinlock"); 

int main(void) 
{ 
   ... 
   if (!RTLockSpinlock(&MySpin, 0)) 
      return 1; // failed; error message was displayed already 
   ...

Down Macro RT_INIT_SPINLOCK