EventBuffer::lock

Acquires a lock on buffer

Description

public void EventBuffer::lock ( void )

Acquires a lock on buffer. Can be used in pair with EventBuffer::unlock to make a set of operations atomic, i.e. thread-safe. Note, it is not needed to lock buffers for individual operations. When locking is enabled(see EventBuffer::enableLocking ), individual operations on event buffers are already atomic.

Parameters

This function has no parameters.

Return Values

Returns TRUE on success. Otherwise FALSE.

See Also

  • EventBuffer::unlock