Thread.bitTrylock

Sets the indicated @lock_bit in @address, returning %TRUE if successful. If the bit is already set, returns %FALSE immediately.

Attempting to lock on two different bits within the same integer is not supported.

The value of the bit that is set is (1u << @bit). If @bit is not between 0 and 31 then the result is undefined.

This function accesses @address atomically. All other accesses to @address must be atomic in order for this function to work reliably.

class Thread
static
bool
bitTrylock
(
int* address
,)

Parameters

address int*

a pointer to an integer

lockBit int

a bit value between 0 and 31

Return Value

Type: bool

%TRUE if the lock was acquired

Meta

Since

2.24