CacheableKey.hpp

Go to the documentation of this file.

#pragma once

#ifndef GEODE_CACHEABLEKEY_H_
#define GEODE_CACHEABLEKEY_H_

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */

#include "geode_globals.hpp"
#include "geode_types.hpp"
#include "Cacheable.hpp"

namespace apache {
namespace geode {
namespace client {

class CPPCACHE_EXPORT CacheableKey : public Cacheable {
 protected:
  CacheableKey() : Cacheable() {}

  virtual ~CacheableKey() {}

 public:
  virtual bool operator==(const CacheableKey& other) const = 0;

  virtual int32_t hashcode() const = 0;

  virtual int32_t logString(char* buffer, int32_t maxLength) const;

  template <class PRIM>
  inline static CacheableKeyPtr create(const PRIM value);

 private:
  // Never defined.
  CacheableKey(const CacheableKey& other);
  void operator=(const CacheableKey& other);
};

template <class TKEY>
inline CacheableKeyPtr createKey(const SharedPtr<TKEY>& value);

template <typename TKEY>
inline CacheableKeyPtr createKey(const TKEY* value);
}  // namespace client
}  // namespace geode
}  // namespace apache

#endif  // GEODE_CACHEABLEKEY_H_