Move to explicitly included properties for the include and library path.

[shibboleth/cpp-xmltooling.git] / xmltooling / util / Threads.h

diff --git a/xmltooling/util/Threads.h b/xmltooling/util/Threads.h
index d184d5c..191cb15 100644 (file)
--- a/xmltooling/util/Threads.h
+++ b/xmltooling/util/Threads.h
@@ -1,23 +1,27 @@
-/*
- *  Copyright 2001-2010 Internet2
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
  *
- * 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
+ * UCAID licenses this file to you 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
+ * 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.
+ * 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.
  */
 
 /**
  * @file xmltooling/util/Threads.h
  *
- * Thread and locking wrappers
+ * Thread and locking wrappers.
  */
 
 #ifndef _xmltooling_threads_h
@@ -25,6 +29,8 @@
 
 #include <xmltooling/exceptions.h>
 
+#include <memory>
+#include <boost/scoped_ptr.hpp>
 #include <signal.h>
 
 namespace xmltooling
@@ -128,7 +134,7 @@ namespace xmltooling
         /**
          * Returns the value for a TLS key.
          *
-         * @return the value or NULL
+         * @return the value or nullptr
          */
         virtual void* getData() const=0;
 
@@ -292,13 +298,53 @@ namespace xmltooling
         }
 
         /**
-         * Unlocks the wrapped mutex.
+         * Locks and wraps the designated mutex.
+         *
+         * @param mtx mutex to lock
+         */
+        Lock(Mutex& mtx) : mutex(&mtx) {
+            mtx.lock();
+        }
+
+        /**
+         * Locks and wraps the designated mutex.
+         *
+         * @param mtx mutex to lock
+         */
+        Lock(const std::auto_ptr<Mutex>& mtx) : mutex(mtx.get()) {
+            if (mutex)
+                mutex->lock();
+        }
+
+        /**
+         * Locks and wraps the designated mutex.
+         *
+         * @param mtx mutex to lock
+         */
+        Lock(const boost::scoped_ptr<Mutex>& mtx) : mutex(mtx.get()) {
+            if (mutex)
+                mutex->lock();
+        }
+
+        /**
+         * Unlocks the wrapped mutex, if any.
          */
         ~Lock() {
             if (mutex)
                 mutex->unlock();
         }
 
+        /**
+         * Releases control of the original Mutex and returns it without unlocking it.
+         *
+         * @return the original, locked Mutex
+         */
+        Mutex* release() {
+            Mutex* ret = mutex;
+            mutex = nullptr;
+            return ret;
+        }
+
     private:
         Mutex* mutex;
     };
@@ -321,13 +367,46 @@ namespace xmltooling
         }
 
         /**
-         * Unlocks the wrapped shared lock.
+         * Locks and wraps the designated shared lock.
+         *
+         * @param lock      lock to acquire
+         * @param lockit    true if the lock should be acquired here, false if already acquired
+         */
+        SharedLock(const std::auto_ptr<RWLock>& lock, bool lockit=true) : rwlock(lock.get()) {
+            if (rwlock && lockit)
+                rwlock->rdlock();
+        }
+
+        /**
+         * Locks and wraps the designated shared lock.
+         *
+         * @param lock      lock to acquire
+         * @param lockit    true if the lock should be acquired here, false if already acquired
+         */
+        SharedLock(const boost::scoped_ptr<RWLock>& lock, bool lockit=true) : rwlock(lock.get()) {
+            if (rwlock && lockit)
+                rwlock->rdlock();
+        }
+
+        /**
+         * Unlocks the wrapped shared lock, if any.
          */
         ~SharedLock() {
             if (rwlock)
                 rwlock->unlock();
         }
 
+        /**
+         * Releases control of the original shared lock and returns it without unlocking it.
+         *
+         * @return the original shared lock
+         */
+        RWLock* release() {
+            RWLock* ret = rwlock;
+            rwlock = nullptr;
+            return ret;
+        }
+
     private:
         RWLock* rwlock;
     };