object_policy.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 <vector>
#include <stdint.h>
#include "boost/date_time/posix_time/posix_time_duration.hpp"
#include "soss_svccli.h"
#include "soss_client/soss_key.h"


namespace sosscli {

// forward declaration (breaks cyclic references):
class NamedCache;

class ObjectPolicy
{
public:
 template<typename T> friend class TypedNamedCache;

 /* Constants */

 const static boost::posix_time::time_duration INFINITE_TIMEOUT;

 const static boost::posix_time::time_duration MAX_TIMEOUT;

 const static size_t MAX_NUM_PARENTS = SOSSLIB_MAX_PARENTS;

 const static ObjectPolicy CACHE_DEFAULTS;

 /* enums */

 enum TimeoutType 
 {
 Sliding = SOSSLIB_TIMEOUT_SLIDING, 
 Absolute = SOSSLIB_TIMEOUT_ABSOLUTE,
 ResetOnUpdate = SOSSLIB_TIMEOUT_ABS_ON_READ
 };

 enum PreemptionPriority
 {
 NotRemovable = 0,
 Normal = 1
 };
 
 /* Constructors */

 ObjectPolicy();

 ObjectPolicy(NamedCache *named_cache);
 
 virtual ~ObjectPolicy() {}

 /* Accessors */

 boost::posix_time::time_duration timeout() const { return timeout_; }
 ObjectPolicy& set_timeout(boost::posix_time::time_duration timeout) { timeout_ = timeout; return *this; }

 TimeoutType timeout_type() const { return timeout_type_; }
 ObjectPolicy& set_timeout_type(TimeoutType timeout_type) { timeout_type_ = timeout_type; return *this; }
 
 PreemptionPriority preemption_priority() const { return preemption_priority_; }
 ObjectPolicy& set_preemption_priority(PreemptionPriority preemption_priority) { preemption_priority_ = preemption_priority; return *this; }

 bool allow_push_repl() const { return allow_push_repl_; }
 ObjectPolicy& set_allow_push_repl(bool allow_push_repl) { allow_push_repl_ = allow_push_repl; return *this; }

 std::vector<SossKey> parents() const { return parents_; }
 ObjectPolicy& set_parents(std::vector<SossKey> parents) { parents_ = parents; return *this; }
 
protected:

private:

 SOSSLIB_OBJ_PARAMS_EXT &copy_to(SOSSLIB_OBJ_PARAMS_EXT &params) const;

 boost::posix_time::time_duration timeout_;
 TimeoutType timeout_type_;
 PreemptionPriority preemption_priority_;
 bool allow_push_repl_;
 std::vector<SossKey> parents_;
};

}