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

游戏引擎

开发平台:

C++ Builder

  1. /** 
  2.  * @file llplugininstance.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_LLPLUGININSTANCE_H
  34. #define LL_LLPLUGININSTANCE_H
  35. #include "llstring.h"
  36. #include "llapr.h"
  37. #include "apr_dso.h"
  38. /**
  39.  * @brief LLPluginInstanceMessageListener receives messages sent from the plugin loader shell to the plugin.
  40.  */
  41. class LLPluginInstanceMessageListener
  42. {
  43. public:
  44. virtual ~LLPluginInstanceMessageListener();
  45.    /** Plugin receives message from plugin loader shell. */
  46. virtual void receivePluginMessage(const std::string &message) = 0;
  47. };
  48. /**
  49.  * @brief LLPluginInstance handles loading the dynamic library of a plugin and setting up its entry points for message passing.
  50.  */
  51. class LLPluginInstance
  52. {
  53. LOG_CLASS(LLPluginInstance);
  54. public:
  55. LLPluginInstance(LLPluginInstanceMessageListener *owner);
  56. virtual ~LLPluginInstance();
  57. // Load a plugin dll/dylib/so
  58. // Returns 0 if successful, APR error code or error code returned from the plugin's init function on failure.
  59. int load(std::string &plugin_file);
  60. // Sends a message to the plugin.
  61. void sendMessage(const std::string &message);
  62.    // TODO:DOC is this comment obsolete? can't find "send_count" anywhere in indra tree.
  63. // send_count is the maximum number of message to process from the send queue.  If negative, it will drain the queue completely.
  64. // The receive queue is always drained completely.
  65. // Returns the total number of messages processed from both queues.
  66. void idle(void);
  67. /** The signature of the function for sending a message from plugin to plugin loader shell.
  68.     *
  69.  * @param[in] message_string Null-terminated C string 
  70.     * @param[in] user_data The opaque reference that the callee supplied during setup.
  71.     */
  72. typedef void (*sendMessageFunction) (const char *message_string, void **user_data);
  73. /** The signature of the plugin init function. TODO:DOC check direction (pluging loader shell to plugin?)
  74.     *
  75.     * @param[in] host_user_data Data from plugin loader shell.
  76.     * @param[in] plugin_send_function Function for sending from the plugin loader shell to plugin.
  77.     */
  78. typedef int (*pluginInitFunction) (sendMessageFunction host_send_func, void *host_user_data, sendMessageFunction *plugin_send_func, void **plugin_user_data);
  79.    /** Name of plugin init function */
  80. static const char *PLUGIN_INIT_FUNCTION_NAME;
  81. private:
  82. static void staticReceiveMessage(const char *message_string, void **user_data);
  83. void receiveMessage(const char *message_string);
  84. apr_dso_handle_t *mDSOHandle;
  85. void *mPluginUserData;
  86. sendMessageFunction mPluginSendMessageFunction;
  87. LLPluginInstanceMessageListener *mOwner;
  88. };
  89. #endif // LL_LLPLUGININSTANCE_H