1
0
Fork 0
arangodb/arangod/Utils/CollectionReadLock.h

124 lines
4.4 KiB
C++

////////////////////////////////////////////////////////////////////////////////
/// @brief "safe" collection read lock
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2004-2012 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 triAGENS GmbH, Cologne, Germany
///
/// @author Jan Steemann
/// @author Copyright 2011-2012, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////
#ifndef TRIAGENS_UTILS_COLLECTION_READ_LOCK_H
#define TRIAGENS_UTILS_COLLECTION_READ_LOCK_H 1
#include "VocBase/primary-collection.h"
using namespace std;
namespace triagens {
namespace arango {
// -----------------------------------------------------------------------------
// --SECTION-- class CollectionReadLock
// -----------------------------------------------------------------------------
class CollectionReadLock {
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup ArangoDB
/// @{
////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////
/// @brief CollectionReadLock
////////////////////////////////////////////////////////////////////////////////
private:
CollectionReadLock (const CollectionReadLock&);
CollectionReadLock& operator= (const CollectionReadLock&);
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- constructors and destructors
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup ArangoDB
/// @{
////////////////////////////////////////////////////////////////////////////////
public:
////////////////////////////////////////////////////////////////////////////////
/// @brief create the lock
////////////////////////////////////////////////////////////////////////////////
CollectionReadLock (TRI_primary_collection_t* primary) : _primary(primary) {
_primary->beginRead(_primary);
}
////////////////////////////////////////////////////////////////////////////////
/// @brief destroy the lock
////////////////////////////////////////////////////////////////////////////////
~CollectionReadLock () {
_primary->endRead(_primary);
}
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
// -----------------------------------------------------------------------------
// --SECTION-- private variables
// -----------------------------------------------------------------------------
////////////////////////////////////////////////////////////////////////////////
/// @addtogroup ArangoDB
/// @{
////////////////////////////////////////////////////////////////////////////////
private:
////////////////////////////////////////////////////////////////////////////////
/// @brief the collection
////////////////////////////////////////////////////////////////////////////////
TRI_primary_collection_t* _primary;
////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////
};
}
}
#endif
// Local Variables:
// mode: outline-minor
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|/// @page\\|// --SECTION--\\|/// @\\}\\)"
// End: