api_docs_2025-0/LockGuard_8hpp_source.html

//

//  Copyright Phoenix Contact GmbH & Co. KG

//

#pragma once

#include "Arp/System/Core/Arp.h"


namespace Arp { namespace System { namespace Commons { namespace Threading

{


// forwards

class Mutex;


class LockGuard

{

public: // construction/destruction

    LockGuard(Mutex& mutex);

    LockGuard(const LockGuard& arg) = delete;

    LockGuard& operator=(const LockGuard& arg) = delete;

    ~LockGuard(void);


private: // fields

    Mutex& mutex;

};


}}}} // end of namespace Arp::System::Commons::Threading

Arp.h

Arp::System::Commons::Threading::LockGuard
Simple lock guard, acquiring lock on construction and release it on destruction.
Definition: LockGuard.hpp:17

Arp::System::Commons::Threading::LockGuard::~LockGuard
~LockGuard(void)
Destructs this instance and releases the lock.
Definition: LockGuard.cpp:22

Arp::System::Commons::Threading::LockGuard::operator=
LockGuard & operator=(const LockGuard &arg)=delete
Assignment operator.

Arp::System::Commons::Threading::LockGuard::LockGuard
LockGuard(Mutex &mutex)
Constructs an LockGuard instance and acquires the assgned lock.
Definition: LockGuard.cpp:15

Arp::System::Commons::Threading::LockGuard::LockGuard
LockGuard(const LockGuard &arg)=delete
Copy constructor.

Arp::System::Commons::Threading::Mutex
Mutual exclusion object to prevent data from concurrent modifications.
Definition: Mutex.hpp:27

Arp
Root namespace for the PLCnext API