////////////////////////////////////////////////////////////////////////////////
/// @brief "safe" collection write 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_WRITE_LOCK_H
#define TRIAGENS_UTILS_COLLECTION_WRITE_LOCK_H 1

#include "VocBase/primary-collection.h"

using namespace std;

namespace triagens {
  namespace arango {

// -----------------------------------------------------------------------------
// --SECTION--                                         class CollectionWriteLock
// -----------------------------------------------------------------------------

    class CollectionWriteLock {

////////////////////////////////////////////////////////////////////////////////
/// @addtogroup ArangoDB
/// @{
////////////////////////////////////////////////////////////////////////////////

////////////////////////////////////////////////////////////////////////////////
/// @brief CollectionWriteLock
////////////////////////////////////////////////////////////////////////////////

      private:
        CollectionWriteLock (const CollectionWriteLock&);
        CollectionWriteLock& operator= (const CollectionWriteLock&);

////////////////////////////////////////////////////////////////////////////////
/// @}
////////////////////////////////////////////////////////////////////////////////

// -----------------------------------------------------------------------------
// --SECTION--                                      constructors and destructors
// -----------------------------------------------------------------------------

////////////////////////////////////////////////////////////////////////////////
/// @addtogroup ArangoDB
/// @{
////////////////////////////////////////////////////////////////////////////////

      public:

////////////////////////////////////////////////////////////////////////////////
/// @brief create the lock
////////////////////////////////////////////////////////////////////////////////

        CollectionWriteLock (TRI_primary_collection_t* primary) : _primary(primary) {
          _primary->beginWrite(_primary);
        }

////////////////////////////////////////////////////////////////////////////////
/// @brief destroy the lock
////////////////////////////////////////////////////////////////////////////////

        ~CollectionWriteLock () {
          _primary->endWrite(_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: