get_options.h

/*
 Copyright (c) 2013 by ScaleOut Software, Inc.

 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.
*/ 

#pragma once

#include <stdint.h>
#include <memory>
#include "boost/function.hpp"
#include "boost/shared_ptr.hpp"
#include "soss_client/soss_key.h"
#include "soss_client/object_policy.h"

namespace sosscli {

template<typename T>
class GetOptions
{
public:

 /* Constants */

 const static GetOptions<T> CACHE_DEFAULTS;

 /* Constructors */

 GetOptions()
 : use_client_cache_(true), throw_on_error_(true), max_lock_retry_count_(20000), lock_retry_interval_ms_(5) {}

 GetOptions(bool use_client_cache, bool throw_on_error, int32_t max_lock_retry_count, int32_t lock_retry_interval_ms)
 : use_client_cache_(use_client_cache), throw_on_error_(throw_on_error), max_lock_retry_count_(max_lock_retry_count), lock_retry_interval_ms_(lock_retry_interval_ms) {}

 GetOptions(const GetOptions &other)
 : use_client_cache_(other.use_client_cache_),
 throw_on_error_(other.throw_on_error_), 
 max_lock_retry_count_(other.max_lock_retry_count_),
 lock_retry_interval_ms_(other.lock_retry_interval_ms_),
 missed_object_callback_(other.missed_object_callback_)
 {
 if (other.missing_object_policy_)
 missing_object_policy_ = std::unique_ptr<ObjectPolicy>(new ObjectPolicy(*other.missing_object_policy_));
 }

 GetOptions& operator=(const GetOptions& rhs)
 {
 if (this != &rhs)
 {
 use_client_cache_ = rhs.use_client_cache_;
 throw_on_error_ = rhs.throw_on_error_;
 max_lock_retry_count_ = rhs.max_lock_retry_count_;
 lock_retry_interval_ms_ = rhs.lock_retry_interval_ms_;
 missed_object_callback_ = rhs.missed_object_callback_;
 if (rhs.missing_object_policy_)
 missing_object_policy_ = std::unique_ptr<ObjectPolicy>(new ObjectPolicy(*rhs.missing_object_policy_));
 }
 return *this;
 }

 
 virtual ~GetOptions() {};

 /* Accessors */

 bool use_client_cache() const { return use_client_cache_; }

 GetOptions& set_use_client_cache(bool use_client_cache) { use_client_cache_ = use_client_cache; return *this; }

 bool throw_on_error() const { return throw_on_error_; }

 GetOptions& set_throw_on_error(bool throw_on_error) { throw_on_error_ = throw_on_error; return *this; }

 int32_t max_lock_retry_count() const { return max_lock_retry_count_; }

 GetOptions& set_max_lock_retry_count(int32_t max_lock_retry_count) { max_lock_retry_count_ = max_lock_retry_count; return *this; }

 int32_t lock_retry_interval_ms() const { return lock_retry_interval_ms_; }

 GetOptions& set_lock_retry_interval_ms(int32_t lock_retry_interval_ms) { lock_retry_interval_ms_ = lock_retry_interval_ms; return *this; }

 GetOptions& set_missed_object_callback(boost::function<boost::shared_ptr<T>(const SossKey &key)> callback) { missed_object_callback_ = callback; return *this; }

 boost::function<boost::shared_ptr<T>(const SossKey &key)> missed_object_callback() const { return missed_object_callback_; }

 ObjectPolicy* missing_object_policy() const { return missing_object_policy_.get(); }

 GetOptions& set_missing_object_policy(std::unique_ptr<ObjectPolicy> policy) { missing_object_policy_ = std::move(policy); return *this; }

protected:

private:

 bool use_client_cache_;
 bool throw_on_error_;
 int32_t max_lock_retry_count_;
 int32_t lock_retry_interval_ms_;

 // object creation callback
 boost::function<boost::shared_ptr<T>(const SossKey &key)> missed_object_callback_;

 // Optional policy for an object inserted via the insert-once callback
 std::unique_ptr<ObjectPolicy> missing_object_policy_;
};

template<typename T> const GetOptions<T> GetOptions<T>::CACHE_DEFAULTS = GetOptions<T>();

} // namespace