/usr/include/licq/plugin/plugin.h is in licq-dev 1.6.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | /*
* This file is part of Licq, an instant messaging client for UNIX.
* Copyright (C) 2010-2011 Licq developers
*
* Licq is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* Licq 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Licq; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef LICQ_PLUGIN_H
#define LICQ_PLUGIN_H
#include <boost/noncopyable.hpp>
#include <pthread.h>
#include <string>
#include "../macro.h"
namespace LicqDaemon
{
class PluginManager;
}
namespace Licq
{
/**
* Base class for plugin instances
*
* All plugins must have a subclass implementing this interface
*
* Note: When a subclass is constructed, it should only perform minimal
* initialization needed for simple functions like name() and version() to
* be usable. Licq will call init() afterwards to properly initialze the
* plugin before run() is called to start the plugin.
*
* Although a plugin will run in a separate thread, calls to the public
* functions and the protected functions called from the protocol manager
* can be made from any thread. It is the responsibility of the plugin to make
* sure these functions are thread safe when needed.
*/
class Plugin : private boost::noncopyable
{
public:
class Params;
// Notification that plugins can get via its pipe
static const char PipeSignal = 'S';
static const char PipeShutdown = 'X';
/// Get the plugin's unique id.
int id() const;
/// Get the plugin's name.
virtual std::string name() const = 0;
/// Get the plugin's version.
virtual std::string version() const = 0;
/// Configuration file for the plugin. Empty string if none. Path is relative to BASE_DIR
virtual std::string configFile() const;
/// Get the name of the library from where the plugin was loaded.
const std::string& libraryName() const;
/// Ask the plugin to shutdown.
void shutdown();
/**
* Check if a thread belongs to this plugin
* Called by anyone
*
* @param thread Thread to test
* @return True if thread is the main thread for this plugin
*/
bool isThread(const pthread_t& thread) const;
/// Convenience function to check the current thread belongs to this plugin
bool isThisThread() const
{ return isThread(::pthread_self()); }
protected:
/**
* Constructor
*
* @param p Paramaters from PluginManager
*/
Plugin(Params& p);
/// Destructor
virtual ~Plugin();
/**
* Initialize the plugin
* Called in plugin thread by PluginManager
*
* @param argc Number of command line parameters
* @param argv Command line parameters
* @return True if initialization was successful
*/
virtual bool init(int argc, char** argv) = 0;
/**
* Run the plugin
* Called in plugin thread by PluginManager
*
* This function will be called in a separate thread and may block
*
* @return Exit code for the plugin
*/
virtual int run() = 0;
/**
* Delete the plugin object from the plugins context
* This function will be called once after run() has returned and the plugin
* thread has terminated but before the library is closed.
* Normally this function should only contain "delete this;"
*/
virtual void destructor() = 0;
/**
* Get read end of pipe used to communicate with the plugin
* Called from plugin
*
* @return A file descriptor that can be polled for new events and signals
*/
int getReadPipe() const;
/**
* Send a notification to the plugin
*
* @param c A character, will be received by plugin through it's read pipe
*/
void notify(char c);
private:
LICQ_DECLARE_PRIVATE();
/// Convenience for friends to access myPrivate without casting from subclass
Private* basePrivate() { return myPrivate; }
/// Allow the plugin manager to access private members
friend class LicqDaemon::PluginManager;
};
} // namespace Licq
#endif
|