mirror of https://gitee.com/bigwinds/arangodb
140 lines
5.2 KiB
C++
140 lines
5.2 KiB
C++
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief write locker
|
|
///
|
|
/// @file
|
|
///
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2014 ArangoDB GmbH, Cologne, Germany
|
|
/// Copyright 2004-2014 triAGENS GmbH, Cologne, Germany
|
|
///
|
|
/// 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
|
|
///
|
|
/// 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.
|
|
///
|
|
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
|
|
///
|
|
/// @author Frank Celler
|
|
/// @author Achim Brandt
|
|
/// @author Copyright 2014, ArangoDB GmbH, Cologne, Germany
|
|
/// @author Copyright 2010-2013, triAGENS GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGODB_BASICS_WRITE_LOCKER_H
|
|
#define ARANGODB_BASICS_WRITE_LOCKER_H 1
|
|
|
|
#include "Basics/Common.h"
|
|
|
|
#include "Basics/ReadWriteLock.h"
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- public macros
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief construct locker with file and line information
|
|
///
|
|
/// Ones needs to use macros twice to get a unique variable based on the line
|
|
/// number.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#define WRITE_LOCKER_VAR_A(a) _write_lock_variable ## a
|
|
#define WRITE_LOCKER_VAR_B(a) WRITE_LOCKER_VAR_A(a)
|
|
|
|
#define WRITE_LOCKER(b) \
|
|
triagens::basics::WriteLocker WRITE_LOCKER_VAR_B(__LINE__)(&b, __FILE__, __LINE__)
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- class WriteLocker
|
|
// -----------------------------------------------------------------------------
|
|
|
|
namespace triagens {
|
|
namespace basics {
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief write locker
|
|
///
|
|
/// A WriteLocker write-locks a read-write lock during its lifetime and unlocks
|
|
/// the lock when it is destroyed.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
class WriteLocker {
|
|
WriteLocker (WriteLocker const&);
|
|
WriteLocker& operator= (WriteLocker const&);
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- constructors and destructors
|
|
// -----------------------------------------------------------------------------
|
|
|
|
public:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief aquires a write-lock
|
|
///
|
|
/// The constructors aquires a write lock, the destructors unlocks the lock.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
explicit
|
|
WriteLocker (ReadWriteLock* readWriteLock);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief aquires a write-lock
|
|
///
|
|
/// The constructors aquires a write lock, the destructors unlocks the lock.
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
explicit
|
|
WriteLocker (ReadWriteLock* readWriteLock, char const* file, int line);
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief releases the write-lock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
~WriteLocker ();
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- private variables
|
|
// -----------------------------------------------------------------------------
|
|
|
|
private:
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief the read-write lock
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
ReadWriteLock* _readWriteLock;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief file
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
char const* _file;
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief line number
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
int _line;
|
|
};
|
|
}
|
|
}
|
|
|
|
#endif
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- END-OF-FILE
|
|
// -----------------------------------------------------------------------------
|
|
|
|
// Local Variables:
|
|
// mode: outline-minor
|
|
// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}"
|
|
// End:
|