00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039
00040
00047 #ifndef WINSTL_INCL_WINSTL_SYNCH_HPP_PROCESS_MUTEX
00048 #define WINSTL_INCL_WINSTL_SYNCH_HPP_PROCESS_MUTEX
00049
00050 #ifndef STLSOFT_DOCUMENTATION_SKIP_SECTION
00051 # define WINSTL_VER_WINSTL_SYNCH_HPP_PROCESS_MUTEX_MAJOR 4
00052 # define WINSTL_VER_WINSTL_SYNCH_HPP_PROCESS_MUTEX_MINOR 3
00053 # define WINSTL_VER_WINSTL_SYNCH_HPP_PROCESS_MUTEX_REVISION 1
00054 # define WINSTL_VER_WINSTL_SYNCH_HPP_PROCESS_MUTEX_EDIT 61
00055 #endif
00056
00057
00058
00059
00060
00061 #ifndef WINSTL_INCL_WINSTL_H_WINSTL
00062 # include <winstl/winstl.h>
00063 #endif
00064 #ifndef STLSOFT_INCL_STLSOFT_SYNCH_HPP_CONCEPTS
00065 # include <stlsoft/synch/concepts.hpp>
00066 #endif
00067 #ifndef WINSTL_INCL_WINSTL_SYNCH_ERROR_HPP_EXCEPTIONS
00068 # include <winstl/synch/error/exceptions.hpp>
00069 #endif
00070
00071
00072
00073
00074
00075 #ifndef _WINSTL_NO_NAMESPACE
00076 # if defined(_STLSOFT_NO_NAMESPACE) || \
00077 defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00078
00079 namespace winstl
00080 {
00081 # else
00082
00083
00084 namespace stlsoft
00085 {
00086
00087 namespace winstl_project
00088 {
00089
00090 # endif
00091 #endif
00092
00093
00094
00095
00096
00097
00103 class process_mutex
00104 : public stlsoft_ns_qual(critical_section)< STLSOFT_CRITICAL_SECTION_IS_RECURSIVE
00105 , STLSOFT_CRITICAL_SECTION_IS_TRYABLE
00106 >
00107 , public stlsoft_ns_qual(synchronisable_object_tag)
00108 {
00111 public:
00113 typedef process_mutex class_type;
00114 typedef HANDLE synch_handle_type;
00115
00116 typedef HANDLE resource_type;
00118
00121 public:
00123 process_mutex()
00124 : m_mx(create_mutex_(NULL, false, static_cast<ws_char_a_t const*>(0), m_bCreated))
00125 , m_bOwnHandle(true)
00126 , m_bAbandoned(false)
00127 {}
00129 process_mutex(HANDLE mx, ws_bool_t bTakeOwnership)
00130 : m_mx(mx)
00131 , m_bOwnHandle(bTakeOwnership)
00132 , m_bCreated(false)
00133 , m_bAbandoned(false)
00134 {
00135 WINSTL_ASSERT(NULL != mx);
00136 }
00138 ss_explicit_k process_mutex(ws_char_a_t const* name)
00139 : m_mx(create_mutex_(NULL, false, name, m_bCreated))
00140 , m_bOwnHandle(true)
00141 , m_bAbandoned(false)
00142 {}
00144 ss_explicit_k process_mutex(ws_char_w_t const* name)
00145 : m_mx(create_mutex_(NULL, false, name, m_bCreated))
00146 , m_bOwnHandle(true)
00147 , m_bAbandoned(false)
00148 {}
00150 ss_explicit_k process_mutex(ws_bool_t bInitialOwer)
00151 : m_mx(create_mutex_(NULL, bInitialOwer, static_cast<ws_char_a_t const*>(0), m_bCreated))
00152 , m_bOwnHandle(true)
00153 , m_bAbandoned(false)
00154 {}
00156 ss_explicit_k process_mutex(ws_char_a_t const* name, ws_bool_t bInitialOwer)
00157 : m_mx(create_mutex_(NULL, bInitialOwer, name, m_bCreated))
00158 , m_bOwnHandle(true)
00159 , m_bAbandoned(false)
00160 {}
00162 ss_explicit_k process_mutex(ws_char_w_t const* name, ws_bool_t bInitialOwer)
00163 : m_mx(create_mutex_(NULL, bInitialOwer, name, m_bCreated))
00164 , m_bOwnHandle(true)
00165 , m_bAbandoned(false)
00166 {}
00168 ss_explicit_k process_mutex(ws_char_a_t const* name, ws_bool_t bInitialOwer, LPSECURITY_ATTRIBUTES psa)
00169 : m_mx(create_mutex_(psa, bInitialOwer, name, m_bCreated))
00170 , m_bOwnHandle(true)
00171 , m_bAbandoned(false)
00172 {}
00174 ss_explicit_k process_mutex(ws_char_w_t const* name, ws_bool_t bInitialOwer, LPSECURITY_ATTRIBUTES psa)
00175 : m_mx(create_mutex_(psa, bInitialOwer, name, m_bCreated))
00176 , m_bOwnHandle(true)
00177 , m_bAbandoned(false)
00178 {}
00179
00181 ~process_mutex() stlsoft_throw_0()
00182 {
00183 if( NULL != m_mx &&
00184 m_bOwnHandle)
00185 {
00186 ::CloseHandle(m_mx);
00187 }
00188 }
00190
00193 public:
00195 void lock()
00196 {
00197 WINSTL_ASSERT(NULL != m_mx);
00198
00199 DWORD dwRes = ::WaitForSingleObject(m_mx, INFINITE);
00200
00201 if(WAIT_ABANDONED == dwRes)
00202 {
00203 m_bAbandoned = true;
00204 }
00205 else
00206 {
00207 m_bAbandoned = false;
00208
00209 if(WAIT_OBJECT_0 != dwRes)
00210 {
00211 #ifdef STLSOFT_CF_EXCEPTION_SUPPORT
00212 STLSOFT_THROW_X(synchronisation_exception("mutex wait failed", ::GetLastError()));
00213 #endif
00214 }
00215 }
00216 }
00218 ws_bool_t lock(ws_dword_t wait)
00219 {
00220 WINSTL_ASSERT(NULL != m_mx);
00221
00222 DWORD dwRes = ::WaitForSingleObject(m_mx, wait);
00223
00224 if(WAIT_ABANDONED == dwRes)
00225 {
00226 m_bAbandoned = true;
00227
00228 return true;
00229 }
00230 else
00231 {
00232 m_bAbandoned = false;
00233
00234 if(WAIT_TIMEOUT == dwRes)
00235 {
00236 return false;
00237 }
00238 else
00239 {
00240 if(WAIT_OBJECT_0 != dwRes)
00241 {
00242 #ifdef STLSOFT_CF_EXCEPTION_SUPPORT
00243 STLSOFT_THROW_X(synchronisation_exception("mutex wait failed", ::GetLastError()));
00244 #endif
00245 }
00246
00247 return true;
00248 }
00249 }
00250 }
00254 ws_bool_t try_lock()
00255 {
00256 return lock(0);
00257 }
00259 void unlock()
00260 {
00261 WINSTL_ASSERT(NULL != m_mx);
00262
00263 if(!::ReleaseMutex(m_mx))
00264 {
00265 #ifdef STLSOFT_CF_EXCEPTION_SUPPORT
00266 STLSOFT_THROW_X(synchronisation_exception("mutex release failed", ::GetLastError()));
00267 #endif
00268 }
00269 }
00271
00274 public:
00276 HANDLE handle()
00277 {
00278 return m_mx;
00279 }
00281 HANDLE get()
00282 {
00283 return m_mx;
00284 }
00286
00289 public:
00295 ws_bool_t created() const
00296 {
00297 return m_bCreated;
00298 }
00299
00306 ws_bool_t abandoned() const
00307 {
00308 return m_bAbandoned;
00309 }
00311
00312
00313 private:
00314 static HANDLE create_mutex_(LPSECURITY_ATTRIBUTES psa, ws_bool_t bInitialOwner, ws_char_a_t const* name, ws_bool_t &bCreated)
00315 {
00316 HANDLE mx = ::CreateMutexA(psa, bInitialOwner, name);
00317
00318 if(NULL == mx)
00319 {
00320 #ifdef STLSOFT_CF_EXCEPTION_SUPPORT
00321 STLSOFT_THROW_X(synchronisation_exception("Failed to create kernel mutex object", ::GetLastError()));
00322 #endif
00323 }
00324
00325 bCreated = (mx != NULL && ::GetLastError() != ERROR_ALREADY_EXISTS);
00326
00327 return mx;
00328 }
00329 static HANDLE create_mutex_(LPSECURITY_ATTRIBUTES psa, ws_bool_t bInitialOwner, ws_char_w_t const* name, ws_bool_t &bCreated)
00330 {
00331 HANDLE mx = ::CreateMutexW(psa, bInitialOwner, name);
00332
00333 if(NULL == mx)
00334 {
00335 #ifdef STLSOFT_CF_EXCEPTION_SUPPORT
00336 STLSOFT_THROW_X(synchronisation_exception("Failed to create kernel mutex object", ::GetLastError()));
00337 #endif
00338 }
00339
00340 bCreated = (mx != NULL && ::GetLastError() != ERROR_ALREADY_EXISTS);
00341
00342 return mx;
00343 }
00344 static HANDLE open_mutex_(ws_dword_t access, ws_bool_t bInheritHandle, ws_char_a_t const* name, ws_bool_t &bCreated)
00345 {
00346 HANDLE mx = ::OpenMutexA(access, bInheritHandle, name);
00347
00348 if(NULL == mx)
00349 {
00350 #ifdef STLSOFT_CF_EXCEPTION_SUPPORT
00351 STLSOFT_THROW_X(synchronisation_exception("Failed to open kernel mutex object", ::GetLastError()));
00352 #endif
00353 }
00354
00355 bCreated = (mx != NULL && ::GetLastError() != ERROR_ALREADY_EXISTS);
00356
00357 return mx;
00358 }
00359 static HANDLE open_mutex_(ws_dword_t access, ws_bool_t bInheritHandle, ws_char_w_t const* name, ws_bool_t &bCreated)
00360 {
00361 HANDLE mx = ::OpenMutexW(access, bInheritHandle, name);
00362
00363 if(NULL == mx)
00364 {
00365 #ifdef STLSOFT_CF_EXCEPTION_SUPPORT
00366 STLSOFT_THROW_X(synchronisation_exception("Failed to open kernel mutex object", ::GetLastError()));
00367 #endif
00368 }
00369
00370 bCreated = (mx != NULL && ::GetLastError() != ERROR_ALREADY_EXISTS);
00371
00372 return mx;
00373 }
00374
00375
00376 private:
00377 HANDLE m_mx;
00378 const ws_bool_t m_bOwnHandle;
00379 ws_bool_t m_bCreated;
00380 ws_bool_t m_bAbandoned;
00381
00382
00383 private:
00384 process_mutex(class_type const& rhs);
00385 process_mutex& operator =(class_type const& rhs);
00386 };
00387
00388
00389
00390
00391
00399 inline HANDLE get_synch_handle(process_mutex &mx)
00400 {
00401 return mx.get();
00402 }
00403
00413 inline HANDLE get_kernel_handle(process_mutex &mx)
00414 {
00415 return mx.get();
00416 }
00417
00418
00419 #ifndef _WINSTL_NO_NAMESPACE
00420 # if defined(_STLSOFT_NO_NAMESPACE) || \
00421 defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00422 }
00423 # else
00424 }
00425 # endif
00426 #endif
00427
00434 inline void lock_instance(winstl_ns_qual(process_mutex) &mx)
00435 {
00436 mx.lock();
00437 }
00438
00445 inline void unlock_instance(winstl_ns_qual(process_mutex) &mx)
00446 {
00447 mx.unlock();
00448 }
00449
00450
00451 #ifndef _WINSTL_NO_NAMESPACE
00452 # if defined(_STLSOFT_NO_NAMESPACE) || \
00453 defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00454 namespace winstl {
00455 # else
00456 namespace winstl_project {
00457 # if defined(STLSOFT_COMPILER_IS_BORLAND)
00458 using ::stlsoft::lock_instance;
00459 using ::stlsoft::unlock_instance;
00460 # endif
00461 # endif
00462 #endif
00463
00464
00465
00466
00467
00468
00473 struct process_mutex_lock_traits
00474 {
00475 public:
00477 typedef process_mutex lock_type;
00479 typedef process_mutex_lock_traits class_type;
00480
00481
00482 public:
00484 static void lock(process_mutex &c)
00485 {
00486 lock_instance(c);
00487 }
00488
00490 static void unlock(process_mutex &c)
00491 {
00492 unlock_instance(c);
00493 }
00494 };
00495
00497
00498
00499 #ifdef STLSOFT_UNITTEST
00500 # include "./unittest/process_mutex_unittest_.h"
00501 #endif
00502
00503
00504
00505 #ifndef _WINSTL_NO_NAMESPACE
00506 # if defined(_STLSOFT_NO_NAMESPACE) || \
00507 defined(STLSOFT_DOCUMENTATION_SKIP_SECTION)
00508 }
00509 # else
00510 }
00511 }
00512 # endif
00513 #endif
00514
00515
00516
00517 #endif
00518
00519