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

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llpluginmessage.h
  3.  *
  4.  * @cond
  5.  * $LicenseInfo:firstyear=2008&license=viewergpl$
  6.  * 
  7.  * Copyright (c) 2008-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.  * @endcond
  32.  */
  33. #ifndef LL_LLPLUGINMESSAGE_H
  34. #define LL_LLPLUGINMESSAGE_H
  35. #include "llsd.h"
  36. /**
  37.  * @brief LLPluginMessage encapsulates the serialization/deserialization of messages passed to and from plugins.
  38.  */
  39. class LLPluginMessage
  40. {
  41. LOG_CLASS(LLPluginMessage);
  42. public:
  43. LLPluginMessage();
  44. LLPluginMessage(const LLPluginMessage &p);
  45. LLPluginMessage(const std::string &message_class, const std::string &message_name);
  46. ~LLPluginMessage();
  47. // reset all internal state
  48. void clear(void);
  49. // Sets the message class and name
  50. // Also has the side-effect of clearing any key/value pairs in the message.
  51. void setMessage(const std::string &message_class, const std::string &message_name);
  52. // Sets a key/value pair in the message
  53. void setValue(const std::string &key, const std::string &value);
  54. void setValueLLSD(const std::string &key, const LLSD &value);
  55. void setValueS32(const std::string &key, S32 value);
  56. void setValueU32(const std::string &key, U32 value);
  57. void setValueBoolean(const std::string &key, bool value);
  58. void setValueReal(const std::string &key, F64 value);
  59. void setValuePointer(const std::string &key, void *value);
  60. std::string getClass(void) const;
  61. std::string getName(void) const;
  62. // Returns true if the specified key exists in this message (useful for optional parameters)
  63. bool hasValue(const std::string &key) const;
  64. // get the value of a particular key as a string.  If the key doesn't exist in the message, an empty string will be returned.
  65. std::string getValue(const std::string &key) const;
  66. // get the value of a particular key as LLSD.  If the key doesn't exist in the message, a null LLSD will be returned.
  67. LLSD getValueLLSD(const std::string &key) const;
  68. // get the value of a key as a S32.  If the value wasn't set as a S32, behavior is undefined.
  69. S32 getValueS32(const std::string &key) const;
  70. // get the value of a key as a U32.  Since there isn't an LLSD type for this, we use a hexadecimal string instead.
  71. U32 getValueU32(const std::string &key) const;
  72. // get the value of a key as a Boolean.
  73. bool getValueBoolean(const std::string &key) const;
  74. // get the value of a key as a float.
  75. F64 getValueReal(const std::string &key) const;
  76. // get the value of a key as a pointer.
  77. void* getValuePointer(const std::string &key) const;
  78. // Flatten the message into a string
  79. std::string generate(void) const;
  80. // Parse an incoming message into component parts
  81. // (this clears out all existing state before starting the parse)
  82. // Returns -1 on failure, otherwise returns the number of key/value pairs in the message.
  83. int parse(const std::string &message);
  84. private:
  85. LLSD mMessage;
  86. };
  87. /**
  88.  * @brief Listener for plugin messages.
  89.  */
  90. class LLPluginMessageListener
  91. {
  92. public:
  93. virtual ~LLPluginMessageListener();
  94.    /** Plugin receives message from plugin loader shell. */
  95. virtual void receivePluginMessage(const LLPluginMessage &message) = 0;
  96. };
  97. /**
  98.  * @brief Dispatcher for plugin messages.
  99.  *
  100.  * Manages the set of plugin message listeners and distributes messages to plugin message listeners.
  101.  */
  102. class LLPluginMessageDispatcher
  103. {
  104. public:
  105. virtual ~LLPluginMessageDispatcher();
  106. void addPluginMessageListener(LLPluginMessageListener *);
  107. void removePluginMessageListener(LLPluginMessageListener *);
  108. protected:
  109. void dispatchPluginMessage(const LLPluginMessage &message);
  110.    /** A set of message listeners. */
  111. typedef std::set<LLPluginMessageListener*> listener_set_t;
  112.    /** The set of message listeners. */
  113. listener_set_t mListeners;
  114. };
  115. #endif // LL_LLPLUGINMESSAGE_H