curl::utils::shared_mutex Class Reference

#include <shared_mutex.hpp>

Collaboration diagram for curl::utils::shared_mutex:

Public Member Functions
	shared_mutex () noexcept
	shared_mutex (const shared_mutex &)=delete
	shared_mutex (shared_mutex &&)=delete
shared_mutex &	operator= (const shared_mutex &)=delete
shared_mutex &	operator= (shared_mutex &&)=delete
void	lock () noexcept
void	lock_shared () noexcept
void	unlock () noexcept

Detailed Description

C++ RAII wrapper for pthread_rwlock_t.

To use this interface, you'd have to add -lpthread to LDFLAGS of your project.

This class is designed specifically for curl::Share, which requires a std::shared_mutex like interface, but have to be able to unlock shared lock/normal lock with a single function.

Definition at line 18 of file shared_mutex.hpp.

Constructor & Destructor Documentation

shared_mutex()

curl::utils::shared_mutex::shared_mutex ( )

noexcept

On failure, call err to terminate the program.

Definition at line 14 of file shared_mutex.cc.

{
    pthread_rwlockattr_t attr;
 
    CHECK(pthread_rwlockattr_init(&attr));
    pthread_rwlockattr_setkind_np(&attr, PTHREAD_RWLOCK_PREFER_WRITER_NONRECURSIVE_NP);
 
    CHECK(pthread_rwlock_init(&rwlock, &attr));
 
    pthread_rwlockattr_destroy(&attr);
}

Member Function Documentation

lock()

void curl::utils::shared_mutex::lock ( )

noexcept

Undefined behavior if deadlocks.

Definition at line 30 of file shared_mutex.cc.

{
    pthread_rwlock_wrlock(&rwlock);
}

lock_shared()

void curl::utils::shared_mutex::lock_shared ( )

noexcept

Undefined behavior if deadlocks.

Definition at line 34 of file shared_mutex.cc.

{
    int ret;
    do {
        ret = pthread_rwlock_rdlock(&rwlock);
    } while (ret != 0 && errno == EAGAIN);
}

unlock()

void curl::utils::shared_mutex::unlock ( )

noexcept

One unlock function for lock()/lock_shared().

Definition at line 42 of file shared_mutex.cc.

{
    pthread_rwlock_unlock(&rwlock);
}

---

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

• utils/shared_mutex.hpp
• utils/shared_mutex.cc