get_result.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 <stdexcept>
#include "boost/shared_ptr.hpp"
#include "soss_client/lock_ticket.h"

namespace sosscli {

template <typename T>
class GetResult
{
public:

 /* Constructors */

 GetResult(LockTicket lock_ticket, int32_t version, int32_t return_code, boost::shared_ptr<T> object_ptr, bool client_cache_hit)
 : lock_ticket_(lock_ticket), version_(version), return_code_(return_code), object_ptr_(object_ptr), client_cache_hit_(client_cache_hit) {}
 
 virtual ~GetResult() {};

 /* Accessors */

 boost::shared_ptr<T> object_ptr()
 { 
 if (return_code_ < 1)
 throw std::runtime_error("The object was not retrieved successfully. Check GetResult.return_code() for error info.");
 return object_ptr_; 
 }

 int32_t version() { return version_; }

 LockTicket lock_ticket() { return lock_ticket_; }

 int32_t return_code() { return return_code_; }

 bool client_cache_hit() { return client_cache_hit_; }

protected:

private:
 GetResult() {}

 LockTicket lock_ticket_;
 int32_t version_;
 int32_t return_code_;
 boost::shared_ptr<T> object_ptr_;
 bool client_cache_hit_;
};

} // namespace