soss_key.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 <string>
#include <stdint.h>
#include <vector>
#include <boost/thread.hpp>

#include "soss_svccli.h"

namespace sosscli {

class SossKey
{
public:

 /* Constants */

 static const size_t MAX_KEY_LENGTH = sizeof(((SOSS_OBJKEY*)0)->obj_id) + sizeof(((SOSS_OBJKEY*)0)->ext_obj_id); 

 /* Constructors */

 SossKey();

 SossKey(const SossKey &other);

 SossKey(const SOSS_OBJKEY &obj_key);

 SossKey(const std::string &key, const uint32_t app_id);

 SossKey(const std::wstring &key, const uint32_t app_id);

 SossKey(const std::vector<uint8_t> &bytes, const uint32_t app_id);

 SossKey(const std::string &key);

 SossKey(const std::wstring &key);

 SossKey(const std::vector<uint8_t> &bytes);

 SossKey(const char *key);

 SossKey(const wchar_t *key);

 SossKey(int32_t key);

 SossKey(const int32_t key, const uint32_t app_id);

 SossKey(uint32_t key);

 SossKey(const uint32_t key, const uint32_t app_id);

 SossKey(int64_t key);

 SossKey(const int64_t key, const uint32_t app_id);

 SossKey(uint64_t key);

 SossKey(const uint64_t key, const uint32_t app_id);
 
 virtual ~SossKey();

 /* operator overloads */

 SossKey& operator=(const SossKey& rhs);

 friend bool operator==(const SossKey &key1, const SossKey &key2);

 friend bool operator!=(const SossKey &key1, const SossKey &key2);

 friend std::size_t hash_value(SossKey const& key);

 /* Accessors */

 SOSS_OBJKEY obj_key() const {return obj_key_;}

 uint32_t app_id() const {return obj_key_.app_id;}

 void set_app_id(uint32_t app_id);

 bool has_app_id() const {return has_app_id_;}

 bool has_string_data() const {
 if (((obj_key_.flags & SOSSKEY_FLAG_HAS_KEYSTRING) != 0) && !original_string_key_.empty())
 return true;
 else
 return false;
 }

 const std::wstring& retrieve_original_string_key() const {
 return original_string_key_;
 }

 void set_local_string_key_data(const std::vector<wchar_t> &string_key_data)
 {
 original_string_key_.assign(string_key_data.begin(), string_key_data.end());
 }

protected:

private:

 void init(const std::vector<uint8_t> &bytes, const uint32_t app_id, const std::wstring &original_string_key, const bool has_app_id);
 void init_string_key(const std::string &key, const uint32_t app_id, const bool has_app_id);
 void init_wstring_key(const std::wstring &key, const uint32_t app_id, const bool has_app_id);

 void hash_string(const std::wstring &key, std::vector<uint8_t> *bytes);
 
 SOSS_OBJKEY obj_key_;
 std::wstring original_string_key_;
 bool has_app_id_;
 boost::mutex mutex_;

};

}