VEXcode Doxygen
Public Member Functions | List of all members
vex::mutex Class Reference

Use this class to create and control mutexes. More...

#include <vex_thread.h>

Public Member Functions

void lock ()
 Locks the mutex and blocks if the mutex is not available. More...
 
bool try_lock ()
 Try to lock the mutex and returns if the mutex is not available. More...
 
void unlock ()
 Unlocks the mutex. More...
 

Detailed Description

Use this class to create and control mutexes.

@prog_lang{pro}

Member Function Documentation

◆ lock()

void vex::mutex::lock ( )

Locks the mutex and blocks if the mutex is not available.

@prog_lang{pro} @drawer_cat{action|none}

◆ try_lock()

bool vex::mutex::try_lock ( )

Try to lock the mutex and returns if the mutex is not available.

@prog_lang{pro} @drawer_cat{action|none}

Returns
Returns true if successful and false if the mutex is owned by another thread.

◆ unlock()

void vex::mutex::unlock ( )

Unlocks the mutex.

@prog_lang{pro} @drawer_cat{action|none}


The documentation for this class was generated from the following file: