Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
rp::hal::Locker Class Reference

#include <locker.h>

Public Types

enum  LOCK_STATUS { LOCK_OK = 1, LOCK_TIMEOUT = -1, LOCK_FAILED = 0 }
 

Public Member Functions

pthread_mutex_t * getLockHandle ()
 
Locker::LOCK_STATUS lock (unsigned long timeout=0xFFFFFFFF)
 
 Locker (bool recusive=false)
 
void unlock ()
 
 ~Locker ()
 

Protected Member Functions

void init (bool recusive)
 
void release ()
 

Protected Attributes

pthread_mutex_t _lock
 

Detailed Description

Definition at line 38 of file locker.h.

Member Enumeration Documentation

◆ LOCK_STATUS

Enumerator
LOCK_OK 
LOCK_TIMEOUT 
LOCK_FAILED 

Definition at line 41 of file locker.h.

Constructor & Destructor Documentation

◆ Locker()

rp::hal::Locker::Locker ( bool  recusive = false)
inline

Definition at line 48 of file locker.h.

◆ ~Locker()

rp::hal::Locker::~Locker ( )
inline

Definition at line 55 of file locker.h.

Member Function Documentation

◆ getLockHandle()

pthread_mutex_t* rp::hal::Locker::getLockHandle ( )
inline

Definition at line 136 of file locker.h.

◆ init()

void rp::hal::Locker::init ( bool  recusive)
inlineprotected

Definition at line 145 of file locker.h.

◆ lock()

Locker::LOCK_STATUS rp::hal::Locker::lock ( unsigned long  timeout = 0xFFFFFFFF)
inline

Definition at line 60 of file locker.h.

◆ release()

void rp::hal::Locker::release ( )
inlineprotected

Definition at line 167 of file locker.h.

◆ unlock()

void rp::hal::Locker::unlock ( )
inline

Definition at line 117 of file locker.h.

Member Data Documentation

◆ _lock

pthread_mutex_t rp::hal::Locker::_lock
protected

Definition at line 183 of file locker.h.


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


rplidar_ros
Author(s):
autogenerated on Fri Aug 2 2024 08:42:14