arangodb/arangod/Utils/CollectionKeys.h

////////////////////////////////////////////////////////////////////////////////
/// @brief collection keys
///
/// @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 Jan Steemann
/// @author Copyright 2014, ArangoDB GmbH, Cologne, Germany
/// @author Copyright 2012-2013, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////

#ifndef ARANGODB_ARANGO_COLLECTION_KEYS_H
#define ARANGODB_ARANGO_COLLECTION_KEYS_H 1

#include "Basics/Common.h"
#include "Basics/JsonHelper.h"
#include "Utils/CollectionNameResolver.h"
#include "VocBase/voc-types.h"

struct TRI_document_collection_t;
struct TRI_vocbase_t;

namespace triagens {
  namespace arango {

    class CollectionGuard;
    class DocumentDitch;
    
    typedef TRI_voc_tick_t CollectionKeysId;

// -----------------------------------------------------------------------------
// --SECTION--                                              class CollectionKeys
// -----------------------------------------------------------------------------

    class CollectionKeys {

      public:

        CollectionKeys (CollectionKeys const&) = delete;
        CollectionKeys& operator= (CollectionKeys const&) = delete;

        CollectionKeys (TRI_vocbase_t*, 
                        std::string const&,
                        TRI_voc_tick_t,
                        double ttl);

        ~CollectionKeys ();

// -----------------------------------------------------------------------------
// --SECTION--                                                  public functions
// -----------------------------------------------------------------------------

      public:
        
        CollectionKeysId id () const {
          return _id;
        }
        
        double ttl () const {
          return _ttl;
        }
        
        double expires () const {
          return _expires;
        }

        bool isUsed () const {
          return _isUsed;
        }

        bool isDeleted () const {
          return _isDeleted;
        }
        
        void deleted () {
          _isDeleted = true;
        }
        
        void use () {
          TRI_ASSERT(! _isDeleted);
          TRI_ASSERT(! _isUsed);

          _isUsed = true;
          _expires = TRI_microtime() + _ttl;
        }

        void release () {
          TRI_ASSERT(_isUsed);
          _isUsed = false;
        }
        
        size_t count () const {
          TRI_ASSERT(_markers != nullptr);
          return _markers->size();
        }

////////////////////////////////////////////////////////////////////////////////
/// @brief initially creates the list of keys
////////////////////////////////////////////////////////////////////////////////

        void create (TRI_voc_tick_t);

////////////////////////////////////////////////////////////////////////////////
/// @brief hashes a chunk of keys
////////////////////////////////////////////////////////////////////////////////

        std::tuple<std::string, std::string, uint64_t> hashChunk (size_t, size_t) const;

////////////////////////////////////////////////////////////////////////////////
/// @brief dumps keys into the JSON
////////////////////////////////////////////////////////////////////////////////

        void dumpKeys (triagens::basics::Json&,
                       size_t,
                       size_t) const;

////////////////////////////////////////////////////////////////////////////////
/// @brief dumps documents into the JSON
////////////////////////////////////////////////////////////////////////////////

        void dumpDocs (triagens::basics::Json&,
                       size_t,
                       size_t,
                       TRI_json_t const*) const;
        
// -----------------------------------------------------------------------------
// --SECTION--                                                 private variables
// -----------------------------------------------------------------------------

      private:

        struct TRI_vocbase_t*                        _vocbase;
        triagens::arango::CollectionGuard*           _guard;
        struct TRI_document_collection_t*            _document;
        triagens::arango::DocumentDitch*             _ditch;
        std::string const                            _name;
        triagens::arango::CollectionNameResolver     _resolver;
        TRI_voc_tick_t                               _blockerId;
        std::vector<TRI_df_marker_t const*>*         _markers;
        
        CollectionKeysId                             _id;
        double                                       _ttl;
        double                                       _expires;
        bool                                         _isDeleted;
        bool                                         _isUsed;
    };

  }
}

#endif

// -----------------------------------------------------------------------------
// --SECTION--                                                       END-OF-FILE
// -----------------------------------------------------------------------------

// Local Variables:
// mode: outline-minor
// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}"
// End: