diff options
Diffstat (limited to 'webrtc/system_wrappers/include/critical_section_wrapper.h')
-rw-r--r-- | webrtc/system_wrappers/include/critical_section_wrapper.h | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/webrtc/system_wrappers/include/critical_section_wrapper.h b/webrtc/system_wrappers/include/critical_section_wrapper.h new file mode 100644 index 0000000000..e93a249e25 --- /dev/null +++ b/webrtc/system_wrappers/include/critical_section_wrapper.h @@ -0,0 +1,54 @@ +/* + * Copyright (c) 2011 The WebRTC project authors. All Rights Reserved. + * + * Use of this source code is governed by a BSD-style license + * that can be found in the LICENSE file in the root of the source + * tree. An additional intellectual property rights grant can be found + * in the file PATENTS. All contributing project authors may + * be found in the AUTHORS file in the root of the source tree. + */ + +#ifndef WEBRTC_SYSTEM_WRAPPERS_INTERFACE_CRITICAL_SECTION_WRAPPER_H_ +#define WEBRTC_SYSTEM_WRAPPERS_INTERFACE_CRITICAL_SECTION_WRAPPER_H_ + +// If the critical section is heavily contended it may be beneficial to use +// read/write locks instead. + +#include "webrtc/base/thread_annotations.h" +#include "webrtc/common_types.h" + +namespace webrtc { +class LOCKABLE CriticalSectionWrapper { + public: + // Factory method, constructor disabled + static CriticalSectionWrapper* CreateCriticalSection(); + + virtual ~CriticalSectionWrapper() {} + + // Tries to grab lock, beginning of a critical section. Will wait for the + // lock to become available if the grab failed. + virtual void Enter() EXCLUSIVE_LOCK_FUNCTION() = 0; + + // Returns a grabbed lock, end of critical section. + virtual void Leave() UNLOCK_FUNCTION() = 0; +}; + +// RAII extension of the critical section. Prevents Enter/Leave mismatches and +// provides more compact critical section syntax. +class SCOPED_LOCKABLE CriticalSectionScoped { + public: + explicit CriticalSectionScoped(CriticalSectionWrapper* critsec) + EXCLUSIVE_LOCK_FUNCTION(critsec) + : ptr_crit_sec_(critsec) { + ptr_crit_sec_->Enter(); + } + + ~CriticalSectionScoped() UNLOCK_FUNCTION() { ptr_crit_sec_->Leave(); } + + private: + CriticalSectionWrapper* ptr_crit_sec_; +}; + +} // namespace webrtc + +#endif // WEBRTC_SYSTEM_WRAPPERS_INTERFACE_CRITICAL_SECTION_WRAPPER_H_ |