typed_named_cache.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 "boost/version.hpp"
#include "boost/shared_ptr.hpp"
#include "boost/make_shared.hpp"
#include "boost/thread.hpp"
#include "soss_client/named_cache.h"
#include "soss_client/get_options.h"
#include "soss_client/put_options.h"
#include "soss_client/get_result.h"
#include "soss_client/internal/put_helper.h"

namespace sosscli {

template <typename T>
class TypedNamedCache : public NamedCache
{
public:

 virtual ~TypedNamedCache() {}

 /* Cache operations */

 PutResult put(SossKey key, const boost::shared_ptr<T> obj_ptr, const ObjectPolicy &obj_policy = ObjectPolicy::CACHE_DEFAULTS, const PutOptions &options = PutOptions::CACHE_DEFAULTS);
 
 PutResult insert(SossKey key, const boost::shared_ptr<T> obj_ptr, const ObjectPolicy &obj_policy = ObjectPolicy::CACHE_DEFAULTS, const PutOptions &options = PutOptions::CACHE_DEFAULTS);

 PutResult insert_and_lock(SossKey key, const boost::shared_ptr<T> obj_ptr, const ObjectPolicy &obj_policy = ObjectPolicy::CACHE_DEFAULTS, const PutOptions &options = PutOptions::CACHE_DEFAULTS);

 PutResult update(SossKey key, const boost::shared_ptr<T> obj_ptr, const PutOptions &options = PutOptions::CACHE_DEFAULTS);

 PutResult update_locked_and_retain(SossKey key, const boost::shared_ptr<T> obj_ptr, LockTicket lock_ticket, const PutOptions &options = PutOptions::CACHE_DEFAULTS);

 PutResult update_locked_and_release(SossKey key, const boost::shared_ptr<T> obj_ptr, LockTicket lock_ticket, const PutOptions &options = PutOptions::CACHE_DEFAULTS);

 PutResult update_optimistic(SossKey key, const boost::shared_ptr<T> obj_ptr, int32_t version, const PutOptions &options = PutOptions::CACHE_DEFAULTS);

 GetResult<T> get(SossKey key, const GetOptions<T> &options = GetOptions<T>::CACHE_DEFAULTS);

 GetResult<T> get_and_lock(SossKey key, const GetOptions<T> &options = GetOptions<T>::CACHE_DEFAULTS);

 GetResult<T> get_locked(SossKey key, LockTicket lock_ticket, const GetOptions<T> &options = GetOptions<T>::CACHE_DEFAULTS);

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

 boost::function<boost::shared_ptr<T>(const SossKey &key)> missed_object_callback() const {return missed_object_callback_;}
 
protected:
 /* Extension points for subclasses */
 
 virtual boost::shared_ptr<T> deserialize(const std::vector<uint8_t> &bytes) = 0;

 virtual void serialize(const T& object, std::vector<uint8_t> &bytes_out, std::vector<uint8_t> &prop_spec_out) = 0;

 GetResult<T> get(SossKey& key, uint32_t flags, LockTicket lock_ticket, const GetOptions<T> &options);

 PutResult put(SossKey &key, const boost::shared_ptr<T> obj_ptr, const ObjectPolicy &obj_policy, uint32_t put_flags, const PutOptions &options, LockTicket lock_ticket, int32_t version);

private:

 // optional callback that can be used to create a missing object.
 boost::function<boost::shared_ptr<T>(const SossKey &key)> missed_object_callback_; 

};

} // namespace

#include "soss_client/internal/typed_named_cache-impl.h"