105 lines
3.2 KiB
C++
105 lines
3.2 KiB
C++
/**
|
|
* @file llexperiencecache.h
|
|
* @brief Caches information relating to experience keys
|
|
*
|
|
* $LicenseInfo:firstyear=2012&license=viewerlgpl$
|
|
* Second Life Viewer Source Code
|
|
* Copyright (C) 2012, Linden Research, Inc.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation;
|
|
* version 2.1 of the License only.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*
|
|
* Linden Research, Inc., 945 Battery Street, San Francisco, CA 94111 USA
|
|
* $/LicenseInfo$
|
|
*/
|
|
|
|
|
|
|
|
#ifndef LL_LLEXPERIENCECACHE_H
|
|
#define LL_LLEXPERIENCECACHE_H
|
|
|
|
#include "linden_common.h"
|
|
#include <boost/signals2.hpp>
|
|
|
|
class LLSD;
|
|
class LLUUID;
|
|
|
|
|
|
|
|
namespace LLExperienceCache
|
|
{
|
|
const std::string PRIVATE_KEY = "private_id";
|
|
const std::string MISSING = "DoesNotExist";
|
|
|
|
const std::string AGENT_ID = "agent_id";
|
|
const std::string GROUP_ID = "group_id";
|
|
const std::string EXPERIENCE_ID = "public_id";
|
|
const std::string NAME = "name";
|
|
const std::string PROPERTIES = "properties";
|
|
const std::string EXPIRES = "expiration";
|
|
const std::string DESCRIPTION = "description";
|
|
const std::string QUOTA = "quota";
|
|
const std::string MATURITY = "maturity";
|
|
const std::string METADATA = "extended_metadata";
|
|
const std::string SLURL = "slurl";
|
|
|
|
|
|
// should be in sync with experience-api/experiences/models.py
|
|
const int PROPERTY_INVALID = 1 << 0;
|
|
const int PROPERTY_PRIVILEGED = 1 << 3;
|
|
const int PROPERTY_GRID = 1 << 4;
|
|
const int PROPERTY_PRIVATE = 1 << 5;
|
|
const int PROPERTY_DISABLED = 1 << 6;
|
|
const int PROPERTY_SUSPENDED = 1 << 7;
|
|
|
|
|
|
// default values
|
|
const static F64 DEFAULT_EXPIRATION = 600.0;
|
|
const static S32 DEFAULT_QUOTA = 128; // this is megabytes
|
|
|
|
// Callback types for get() below
|
|
typedef boost::signals2::signal<void (const LLSD& experience)>
|
|
callback_signal_t;
|
|
typedef callback_signal_t::slot_type callback_slot_t;
|
|
typedef std::map<LLUUID, LLSD> cache_t;
|
|
|
|
|
|
void setLookupURL(const std::string& lookup_url);
|
|
bool hasLookupURL();
|
|
|
|
void setMaximumLookups(int maximumLookups);
|
|
|
|
void idle();
|
|
void exportFile(std::ostream& ostr);
|
|
void importFile(std::istream& istr);
|
|
void initClass();
|
|
void bootstrap(const LLSD& legacyKeys, int initialExpiration);
|
|
|
|
void erase(const LLUUID& key);
|
|
bool fetch(const LLUUID& key, bool refresh=false);
|
|
void insert(const LLSD& experience_data);
|
|
const LLSD& get(const LLUUID& key);
|
|
|
|
// If name information is in cache, callback will be called immediately.
|
|
void get(const LLUUID& key, callback_slot_t slot);
|
|
|
|
const cache_t& getCached();
|
|
|
|
// maps an experience private key to the experience id
|
|
LLUUID getExperienceId(const LLUUID& private_key, bool null_if_not_found=false);
|
|
|
|
};
|
|
|
|
#endif // LL_LLEXPERIENCECACHE_H
|