////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2018 ArangoDB 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 Simon Grätzer
////////////////////////////////////////////////////////////////////////////////

#ifndef ARANGOD_CLUSTER_CLUSTER_TRANSACTION_COLLECTION_H
#define ARANGOD_CLUSTER_CLUSTER_TRANSACTION_COLLECTION_H 1

#include "Basics/Common.h"
#include "StorageEngine/TransactionCollection.h"
#include "VocBase/AccessMode.h"
#include "VocBase/voc-types.h"

namespace arangodb {
namespace transaction {
class Methods;
}
class TransactionState;

/// @brief collection used in a transaction
class ClusterTransactionCollection final : public TransactionCollection {
 public:
  ClusterTransactionCollection(TransactionState* trx, TRI_voc_cid_t cid,
                               AccessMode::Type accessType, int nestingLevel);
  ~ClusterTransactionCollection();

  /// @brief whether or not any write operations for the collection happened
  bool hasOperations() const override;

  void freeOperations(transaction::Methods* activeTrx, bool mustRollback) override;

  bool canAccess(AccessMode::Type accessType) const override;
  int use(int nestingLevel) override;
  void unuse(int nestingLevel) override;
  void release() override;

 private:
  /// @brief request a lock for a collection
  /// returns TRI_ERROR_LOCKED in case the lock was successfully acquired
  /// returns TRI_ERROR_NO_ERROR in case the lock does not need to be acquired
  /// and no other error occurred returns any other error code otherwise
  int doLock(AccessMode::Type, int nestingLevel) override;

  /// @brief request an unlock for a collection
  int doUnlock(AccessMode::Type, int nestingLevel) override;
};
}  // namespace arangodb

#endif