docs/cppthread/mutex_8h_source.html

// Copyright (c) 2013-2025  Made to Order Software Corp.  All Rights Reserved

//

// https://snapwebsites.org/project/cppthread

// contact@m2osw.com

//

// This program is free software; you can redistribute it and/or modify

// it under the terms of the GNU General Public License as published by

// the Free Software Foundation; either version 2 of the License, or

// (at your option) any later version.

//

// This program is distributed in the hope that it will be useful,

// but WITHOUT ANY WARRANTY; without even the implied warranty of

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

// GNU General Public License for more details.

//

// You should have received a copy of the GNU General Public License along

// with this program; if not, write to the Free Software Foundation, Inc.,

// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

#pragma once


// C++

//

#include    <cstdint>

#include    <memory>

#include    <vector>


namespace cppthread

{


namespace detail

{

class mutex_impl;

}


// a mutex to ensure single threaded work

//


class mutex

{

public:

    typedef std::shared_ptr<mutex>     pointer_t;

    typedef std::vector<pointer_t>     vector_t;

    typedef std::vector<mutex>         direct_vector_t;


                        mutex();

                        mutex(mutex const & rhs) = delete;

                        ~mutex();


    mutex &             operator = (mutex const & rhs) = delete;


    void                lock();

    bool                try_lock();

    void                unlock();

    void                wait();

    bool                timed_wait(std::uint64_t const usec);

    bool                timed_wait(timespec const & nsec);

    bool                dated_wait(std::uint64_t const date);

    bool                dated_wait(timespec const & date);

    void                signal();

    void                safe_signal();

    void                broadcast();

    void                safe_broadcast();


private:

    std::shared_ptr<detail::mutex_impl>

                        f_impl;


    std::uint32_t       f_reference_count = 0;

};


extern mutex *          g_system_mutex;


} // namespace cppthread

// vim: ts=4 sw=4 et

cppthread::mutex
A mutex object to ensures atomicity.
Definition mutex.h:55

cppthread::mutex::vector_t
std::vector< pointer_t > vector_t
A vector of mutexes.
Definition mutex.h:58

cppthread::mutex::lock
void lock()
Lock a mutex.
Definition mutex.cpp:369

cppthread::mutex::pointer_t
std::shared_ptr< mutex > pointer_t
Shared pointer to a mutex.
Definition mutex.h:57

cppthread::mutex::direct_vector_t
std::vector< mutex > direct_vector_t
A vector of mutexes.
Definition mutex.h:59

cppthread::mutex::dated_wait
bool dated_wait(std::uint64_t const date)
Wait on a mutex until the specified date.
Definition mutex.cpp:642

cppthread::mutex::timed_wait
bool timed_wait(std::uint64_t const usec)
Wait on a mutex condition with a time limit.
Definition mutex.cpp:549

cppthread::mutex::wait
void wait()
Wait on a mutex condition.
Definition mutex.cpp:494

cppthread::mutex::safe_signal
void safe_signal()
Signal a mutex.
Definition mutex.cpp:765

cppthread::mutex::mutex
mutex()
An inter-thread mutex to ensure unicity of execution.
Definition mutex.cpp:229

cppthread::mutex::unlock
void unlock()
Unlock a mutex.
Definition mutex.cpp:443

cppthread::mutex::signal
void signal()
Signal at least one mutex.
Definition mutex.cpp:737

cppthread::mutex::f_impl
std::shared_ptr< detail::mutex_impl > f_impl
The pthread mutex implementation.
Definition mutex.h:82

cppthread::mutex::f_reference_count
std::uint32_t f_reference_count
The lock reference count.
Definition mutex.h:84

cppthread::mutex::broadcast
void broadcast()
Broadcast a mutex signal.
Definition mutex.cpp:838

cppthread::mutex::safe_broadcast
void safe_broadcast()
Broadcast a mutex signal.
Definition mutex.cpp:799

cppthread::mutex::try_lock
bool try_lock()
Try locking the mutex.
Definition mutex.cpp:400

cppthread::mutex::~mutex
~mutex()
Clean up a mutex object.
Definition mutex.cpp:319

cppthread::g_system_mutex
mutex * g_system_mutex
The system mutex.
Definition mutex.cpp:888