Project     : sample_plugin - a sample plugin for partysip.Email       : partysip@wellx.comLicense     : GPLTeam        : Copyright 2002, WellX Telecom  <partysip@wellx.com>              Copyright 2002, Aymeric MOIZARD <jack@atosc.org>partysip is a modular SIP proxy server. This is a central point for managinga SIP network. Mainly SIP phones advertise their locations (sip urls like<sip:jack@atosc.org>) to partysip which is then able to route the calls.------------------------------------------- WANT YOUR PLUGIN IN THE SOURCE TREE? ------------------------------------------If your plugin is of any interest for the partysip community,you may consider implementing it in the original source treeof partysip. Please contact us.------------------------------------------------------- DESCRIPTION -------------------------------------------------------The useful feature about partysip is that you can build plugins for anypurpose: * answering machine. * make accounting. * remote control of your house. * conference center. * ...The idea of the included source code is to help people toimplement new plugins. This sample plugin is a sort of templatethat basicly present the required code method of plugins.------------------------------------------------- Using the template ------------------------------------------------------If you want to build a plugin, you must understand a few things:  * preprocessor MACROs SHOULD always be identical to the one used for partysip.  * A set of required methods and elements is mandatory for all plugins:	psp_plugin_t PPL_DECLARE_DATA $(PLUGIN_NAME)_plugin;	int plugin_init()	int plugin_start()    /* NOT ACTUALLY USED!! */	int plugin_release()To simplify the developments steps, the sample plugin uses: * The 'partysip-config' script comes with partysip and is   mainly used to provide all the required compilation flags,   and linker flags. * The autoconf tools help you to generate a MANDATORY config.h   file with all the #define required for include file selection. * 3 generic files for a plugin source code.    1: sample_plugin_core.c contains the mandatory methods and elements       used by partysip to load/unload the plugin.    2: sample_plugin.h and sample_plugin.c is the place where       you will define and implement the methods that you register       to partysip.-------------------------------------------- MODIFYING THE PLUGIN SOURCE CODE  --------------------------------------------Building a plugin is simple:Step 1: preparing files, makefiles and autotools. Modify ./configure.in:    * replace occurence of 'sample_plugin' by the name of your plugin.	NOTE! You have to avoid conflict plugin name: a good practice        would be to append your initials!    * update the version release. Modify the file names in ./src/    * rename all 'sample_plugin*.*' files using the name of your plugin. Modify the src/Makefile.am    * replace occurence of 'sample_plugin' using the name of your plugin.Step 2: Write the source code. Modify the source code of all files...Step 3: Compile your plugin. run:  $ ./configure --prefix=/the/same/prefix/used/for/partysipNOTE: This plugin NEEDs to be installed in the partysipplugin directory. This limitation will be removed later.  $ make  $ make install    (as root, of course, if you need that...)Step 4: Load your plugin!  partysip-0.4.4 does not yet have a user interface. This is why  in the first step of development you will have to manually edit  ./partysip/src/main.c and re-compile partysip so it will load your  plugin. (1 line is required...). This limitation will be removed  soon.Step 5: It doesn't work! write <partysip-dev@mail.freesoftware.fsf.org>.-------------------------------------------------------   CONTACTS  -------------------------------------------------------Full information at www.partysip.org.partysip is primarily developed by a French company: WellX Telecom.For any support or development about partysip, use <partysip@wellx.com>.For any information about WellX Telecom, use <info@wellx.com>.http://www.wellx.com/WellX Telecom7, Rue du parc de Clagny78000 VersaillesFrance