llcachename.h
上传用户:king477883
上传日期:2021-03-01
资源大小:9553k
文件大小:5k
源码类别:

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llcachename.h
  3.  * @brief A cache of names from UUIDs.
  4.  *
  5.  * $LicenseInfo:firstyear=2002&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2002-2010, Linden Research, Inc.
  8.  * 
  9.  * Second Life Viewer Source Code
  10.  * The source code in this file ("Source Code") is provided by Linden Lab
  11.  * to you under the terms of the GNU General Public License, version 2.0
  12.  * ("GPL"), unless you have obtained a separate licensing agreement
  13.  * ("Other License"), formally executed by you and Linden Lab.  Terms of
  14.  * the GPL can be found in doc/GPL-license.txt in this distribution, or
  15.  * online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
  16.  * 
  17.  * There are special exceptions to the terms and conditions of the GPL as
  18.  * it is applied to this Source Code. View the full text of the exception
  19.  * in the file doc/FLOSS-exception.txt in this software distribution, or
  20.  * online at
  21.  * http://secondlifegrid.net/programs/open_source/licensing/flossexception
  22.  * 
  23.  * By copying, modifying or distributing this software, you acknowledge
  24.  * that you have read and understood your obligations described above,
  25.  * and agree to abide by those obligations.
  26.  * 
  27.  * ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
  28.  * WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
  29.  * COMPLETENESS OR PERFORMANCE.
  30.  * $/LicenseInfo$
  31.  */
  32. #ifndef LL_LLCACHENAME_H
  33. #define LL_LLCACHENAME_H
  34. #include <boost/bind.hpp>
  35. #include <boost/signals2.hpp>
  36. class LLMessageSystem;
  37. class LLHost;
  38. class LLUUID;
  39. typedef boost::signals2::signal<void (const LLUUID& id,
  40.                                       const std::string& first_name,
  41.                                       const std::string& last_name,
  42.                                       BOOL is_group)> LLCacheNameSignal;
  43. typedef LLCacheNameSignal::slot_type LLCacheNameCallback;
  44. // Old callback with user data for compatability
  45. typedef void (*old_callback_t)(const LLUUID&, const std::string&, const std::string&, BOOL, void*);
  46. // Here's the theory:
  47. // If you request a name that isn't in the cache, it returns "waiting"
  48. // and requests the data.  After the data arrives, you get that on 
  49. // subsequent calls.
  50. // If the data hasn't been updated in an hour, it requests it again,
  51. // but keeps giving you the old value until new data arrives.
  52. // If you haven't requested the data in an hour, it releases it.
  53. class LLCacheName
  54. {
  55. public:
  56. LLCacheName(LLMessageSystem* msg);
  57. LLCacheName(LLMessageSystem* msg, const LLHost& upstream_host);
  58. ~LLCacheName();
  59. // registers the upstream host
  60. // for viewers, this is the currently connected simulator
  61. // for simulators, this is the data server
  62. void setUpstream(const LLHost& upstream_host);
  63. boost::signals2::connection addObserver(const LLCacheNameCallback& callback);
  64. // janky old format. Remove after a while. Phoenix. 2008-01-30
  65. void importFile(LLFILE* fp);
  66. // storing cache on disk; for viewer, in name.cache
  67. bool importFile(std::istream& istr);
  68. void exportFile(std::ostream& ostr);
  69. // If available, copies the first and last name into the strings provided.
  70. // first must be at least DB_FIRST_NAME_BUF_SIZE characters.
  71. // last must be at least DB_LAST_NAME_BUF_SIZE characters.
  72. // If not available, copies the string "waiting".
  73. // Returns TRUE iff available.
  74. BOOL getName(const LLUUID& id, std::string& first, std::string& last);
  75. BOOL getFullName(const LLUUID& id, std::string& fullname);
  76. // Reverse lookup of UUID from name
  77. BOOL getUUID(const std::string& first, const std::string& last, LLUUID& id);
  78. BOOL getUUID(const std::string& fullname, LLUUID& id);
  79. // If available, this method copies the group name into the string
  80. // provided. The caller must allocate at least
  81. // DB_GROUP_NAME_BUF_SIZE characters. If not available, this
  82. // method copies the string "waiting". Returns TRUE iff available.
  83. BOOL getGroupName(const LLUUID& id, std::string& group);
  84. // Call the callback with the group or avatar name.
  85. // If the data is currently available, may call the callback immediatly
  86. // otherwise, will request the data, and will call the callback when
  87. // available.  There is no garuntee the callback will ever be called.
  88. boost::signals2::connection get(const LLUUID& id, BOOL is_group, const LLCacheNameCallback& callback);
  89. // LEGACY
  90. boost::signals2::connection get(const LLUUID& id, BOOL is_group, old_callback_t callback, void* user_data);
  91. // This method needs to be called from time to time to send out
  92. // requests.
  93. void processPending();
  94. // Expire entries created more than "secs" seconds ago.
  95. void deleteEntriesOlderThan(S32 secs);
  96. // Debugging
  97. void dump(); // Dumps the contents of the cache
  98. void dumpStats(); // Dumps the sizes of the cache and associated queues.
  99. static std::string getDefaultName();
  100. static void LocalizeCacheName(std::string key, std::string value);
  101. static std::map<std::string, std::string> sCacheName;
  102. private:
  103. class Impl;
  104. Impl& impl;
  105. };
  106. extern LLCacheName* gCacheName;
  107. #endif