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

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file lldispatcher.h
  3.  * @brief LLDispatcher class header file.
  4.  *
  5.  * $LicenseInfo:firstyear=2004&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2004-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_LLDISPATCHER_H
  33. #define LL_LLDISPATCHER_H
  34. #include <map>
  35. #include <vector>
  36. #include <string>
  37. class LLDispatcher;
  38. class LLMessageSystem;
  39. class LLUUID;
  40. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  41. // Class LLDispatchHandler
  42. //
  43. // Abstract base class for handling dispatches. Derive your own
  44. // classes, construct them, and add them to the dispatcher you want to
  45. // use.
  46. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  47. class LLDispatchHandler
  48. {
  49. public:
  50. typedef std::vector<std::string> sparam_t;
  51. //typedef std::vector<S32> iparam_t;
  52. LLDispatchHandler() {}
  53. virtual ~LLDispatchHandler() {}
  54. virtual bool operator()(
  55. const LLDispatcher* dispatcher,
  56. const std::string& key,
  57. const LLUUID& invoice,
  58. const sparam_t& string) = 0;
  59. //const iparam_t& integers) = 0;
  60. };
  61. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  62. // Class LLDispatcher
  63. //
  64. // Basic utility class that handles dispatching keyed operations to
  65. // function objects implemented as LLDispatchHandler derivations.
  66. //~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  67. class LLDispatcher
  68. {
  69. public:
  70. typedef std::string key_t;
  71. typedef std::vector<std::string> keys_t;
  72. typedef std::vector<std::string> sparam_t;
  73. //typedef std::vector<S32> iparam_t;
  74. // construct a dispatcher.
  75. LLDispatcher();
  76. virtual ~LLDispatcher();
  77. // Returns if they keyed handler exists in this dispatcher.
  78. bool isHandlerPresent(const key_t& name) const;
  79. // copy all known keys onto keys_t structure
  80. void copyAllHandlerNames(keys_t& names) const;
  81. // Call this method with the name of the request that has come
  82. // in. If the handler is present, it is called with the params and
  83. // returns the return value from 
  84. bool dispatch(
  85. const key_t& name,
  86. const LLUUID& invoice,
  87. const sparam_t& strings) const;
  88. //const iparam_t& itegers) const;
  89. // Add a handler. If one with the same key already exists, its
  90. // pointer is returned, otherwise returns NULL. This object does
  91. // not do memory management of the LLDispatchHandler, and relies
  92. // on the caller to delete the object if necessary.
  93. LLDispatchHandler* addHandler(const key_t& name, LLDispatchHandler* func);
  94. // Helper method to unpack the dispatcher message bus
  95. // format. Returns true on success.
  96. static bool unpackMessage(
  97. LLMessageSystem* msg,
  98. key_t& method,
  99. LLUUID& invoice,
  100. sparam_t& parameters);
  101. protected:
  102. typedef std::map<key_t, LLDispatchHandler*> dispatch_map_t;
  103. dispatch_map_t mHandlers;
  104. };
  105. #endif // LL_LLDISPATCHER_H