-/*
- * Copyright 2001-2009 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
#define _xmltooling_threads_h
-#include <xmltooling/base.h>
#include <xmltooling/exceptions.h>
+#include <memory>
+#include <boost/scoped_ptr.hpp>
#include <signal.h>
namespace xmltooling
class XMLTOOL_API Thread
{
MAKE_NONCOPYABLE(Thread);
- public:
+ protected:
Thread() {}
+ public:
virtual ~Thread() {}
/**
*
* @param start_routine the function to execute on the thread
* @param arg a parameter for the start routine
+ * @param stacksize size of stack to use, or 0 for default
* @return the created and running thread object
*/
- static Thread* create(void* (*start_routine)(void*), void* arg);
+ static Thread* create(void* (*start_routine)(void*), void* arg, size_t stacksize=0);
/**
* Exits a thread gracefully.
class XMLTOOL_API ThreadKey
{
MAKE_NONCOPYABLE(ThreadKey);
- public:
+ protected:
ThreadKey() {}
+ public:
virtual ~ThreadKey() {}
/**
/**
* Returns the value for a TLS key.
*
- * @return the value or NULL
+ * @return the value or nullptr
*/
virtual void* getData() const=0;
class XMLTOOL_API Mutex
{
MAKE_NONCOPYABLE(Mutex);
- public:
+ protected:
Mutex() {}
+ public:
virtual ~Mutex() {}
/**
class XMLTOOL_API RWLock
{
MAKE_NONCOPYABLE(RWLock);
- public:
+ protected:
RWLock() {}
+ public:
virtual ~RWLock() {}
/**
class XMLTOOL_API CondWait
{
MAKE_NONCOPYABLE(CondWait);
- public:
+ protected:
CondWait() {}
+ public:
virtual ~CondWait() {}
/**
* @param mtx mutex to lock
*/
Lock(Mutex* mtx) : mutex(mtx) {
- mutex->lock();
+ if (mutex)
+ mutex->lock();
+ }
+
+ /**
+ * 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.
+ * Unlocks the wrapped mutex, if any.
*/
~Lock() {
- mutex->unlock();
+ 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:
* @param lockit true if the lock should be acquired here, false if already acquired
*/
SharedLock(RWLock* lock, bool lockit=true) : rwlock(lock) {
- if (lockit)
+ 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 std::auto_ptr<RWLock>& lock, bool lockit=true) : rwlock(lock.get()) {
+ if (rwlock && lockit)
rwlock->rdlock();
}
/**
- * 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 boost::scoped_ptr<RWLock>& lock, bool lockit=true) : rwlock(lock.get()) {
+ if (rwlock && lockit)
+ rwlock->rdlock();
+ }
+
+ /**
+ * Unlocks the wrapped shared lock, if any.
*/
~SharedLock() {
- rwlock->unlock();
+ 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:
projects / shibboleth / cpp-xmltooling.git / blobdiff