This document describes libRoadRunners Plugins API.
The Plugins API is centered around the PluginManager, Plugin, and Parameter classes. Where the Plugin manager is responsible for validating, loading and unloading plugins at runtime.
The Plugins themselves are self contained shared libraries that may be designed to extend the functionality of the main libRoadRunners core API.
The capabilities of a Plugin is communicated to a client by use of Parameters. A Parameter in this context, is a specialized object able to communicate various types of data between the Plugin and the client.
A client typically loads and configure a plugin, throught the use of Parameters, and then executes the plugin using a plugins execute function. Finally, the client may retrieve some kind of result from the Plugin, again, using a Parameter.
Since a Plugins function will be determined by the actual Plugin author, documentation on a Plugins purpose and on how to use the plugin, is ideally bundled with the plugin and retrieved by various Plugin functions, getInfo(), getExtendedInfo() and getManualAsPDF().
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of University of Washington nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
Generated on Wed Dec 18 2013 23:07:32 for libRoadRunner Plugin C++ API by 1.8.5
1.8.5
