Guard.h

Go to the documentation of this file.

/*
* Copyright Onix Solutions Limited [OnixS]. All rights reserved.
*
* This software owned by Onix Solutions Limited [OnixS] and is protected by copyright law
* and international copyright treaties.
*
* Access to and use of the software is governed by the terms of the applicable OnixS Software
* Services Agreement (the Agreement) and Customer end user license agreements granting
* a non-assignable, non-transferable and non-exclusive license to use the software
* for it's own data processing purposes under the terms defined in the Agreement.
*
* Except as otherwise granted within the terms of the Agreement, copying or reproduction of any part
* of this source code or associated reference material to any other location for further reproduction
* or redistribution, and any amendments to this copyright notice, are expressly prohibited.
*
* Any reproduction or redistribution for sale or hiring of the Software not in accordance with
* the terms of the Agreement is a violation of copyright law.
*/

#pragma once

#include <OnixS/B3/BOE/threading/Mutex.h>
#include <OnixS/B3/BOE/threading/Semaphore.h>

namespace OnixS {
namespace B3 {
namespace BOE {
namespace Threading {

/// Performs automatic acquisition and release of a synchronization object.
template<class Acquirable> class Guard
{
public:
    /// Acquires the given synchronization object upon initialization.
    Guard(Acquirable & acquirable)
        : acquirable_(acquirable)
    {
        acquirable_.acquire();
    }

    /// Releases the synchronization object upon destruction.
    ~Guard() {
        acquirable_.release();
    }

private:
    Acquirable & acquirable_;

    Guard(const Guard &);
    Guard & operator = (const Guard &);
};

// Aliases for guards for known synchronization objects.

typedef Guard<Mutex> MutexGuard;
typedef Guard<Semaphore> SemaphoreGuard;
}
}
}
}