satnogs::comms::scoped_lock Class Reference

Implements a scoped lock utilizing the Zephyr mutex. More...

#include <scoped_lock.hpp>

Public Member Functions
	scoped_lock (struct k_mutex *mutex)
	Creates a scoped lock.
	scoped_lock (struct k_mutex &mutex)
	Creates a scoped lock.
	~scoped_lock ()
	Upon destruction, the mutex is released.

Detailed Description

Implements a scoped lock utilizing the Zephyr mutex.

Definition at line 33 of file scoped_lock.hpp.

Constructor & Destructor Documentation

scoped_lock() [1/2]

satnogs::comms::scoped_lock::scoped_lock ( struct k_mutex * mutex )

inline

Creates a scoped lock.

Parameters

mutex

a valid and initialized mutex

Definition at line 41 of file scoped_lock.hpp.

scoped_lock() [2/2]

satnogs::comms::scoped_lock::scoped_lock ( struct k_mutex & mutex )

inline

Creates a scoped lock.

Parameters

mutex

a valid and initialized mutex

Definition at line 51 of file scoped_lock.hpp.

~scoped_lock()

satnogs::comms::scoped_lock::~scoped_lock ( )

inline

Upon destruction, the mutex is released.

Definition at line 60 of file scoped_lock.hpp.

---

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

• src/scoped_lock.hpp