const_lock.h File Reference

Scope-based const-locking utility for mutex-like synchronization primitives. More...

#include "jh/conceptual/mutex_like.h"

Go to the source code of this file.

Classes
class	jh::sync::const_lock< Mutex >
	Scope-based immutability barrier for mutex_like types. More...

Namespaces
namespace	jh::sync
	Aggregated entry point for synchronization and coordination facilities.

Detailed Description

Scope-based const-locking utility for mutex-like synchronization primitives.

Copyright

Copyright 2025 JeongHan-Bae <mastropseudo@gmail.com>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Full license: GitHub

Author

JeongHan-Bae <mastropseudo@gmail.com>

This header defines jh::sync::const_lock, a lightweight RAII-style synchronization helper that enforces immutability barriers for shared or exclusive access. It provides a unified locking abstraction compatible with all types satisfying jh::concepts::mutex_like.

When constructed, const_lock automatically acquires the appropriate lock:

• If the mutex type satisfies shared_lockable, it uses lock_shared().
• Otherwise, it falls back to exclusive lock().

Upon destruction, it symmetrically releases the held lock.

If the supplied mutex is jh::typed::null_mutex_t, all operations are completely no-op, producing zero runtime overhead. This enables seamless single-threaded or thread-local use cases without conditional compilation.

Typical usage:

std::shared_mutex sm;
jh::sync::const_lock guard(sm);  // Acquires shared lock automatically
 
std::mutex m;
jh::sync::const_lock exclusive_guard(m);  // Acquires exclusive lock
 
jh::sync::const_lock dummy(jh::typed::null_mutex);  // No-op

Version

1.3.x

Date

2025