libguac  0.7.0
plugin.h
Go to the documentation of this file.
00001 
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is libguac.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Michael Jumper.
00019  * Portions created by the Initial Developer are Copyright (C) 2010
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 
00039 #ifndef _GUAC_PLUGIN_H
00040 #define _GUAC_PLUGIN_H
00041 
00042 #include "client.h"
00043 
00053 #define GUAC_PROTOCOL_LIBRARY_PREFIX "libguac-client-"
00054 
00058 #define GUAC_PROTOCOL_LIBRARY_SUFFIX ".so"
00059 
00064 #define GUAC_PROTOCOL_NAME_LIMIT 256
00065 
00072 #define GUAC_PROTOCOL_LIBRARY_LIMIT (                                  \
00073                                                                        \
00074       sizeof(GUAC_PROTOCOL_LIBRARY_PREFIX) - 1 /* "libguac-client-" */ \
00075     +        GUAC_PROTOCOL_NAME_LIMIT      - 1 /* [up to 256 chars] */ \
00076     + sizeof(GUAC_PROTOCOL_LIBRARY_SUFFIX) - 1 /* ".so"             */ \
00077     + 1                                        /* NULL terminator   */ \
00078                                                                        \
00079 )
00080 
00081 typedef struct guac_client_plugin guac_client_plugin;
00082 
00088 struct guac_client_plugin {
00089 
00093     void* __client_plugin_handle;
00094 
00099     guac_client_init_handler* init_handler;
00100 
00106     const char** args;
00107 
00108 };
00109 
00119 guac_client_plugin* guac_client_plugin_open(const char* protocol);
00120 
00129 int guac_client_plugin_close(guac_client_plugin* plugin);
00130 
00141 int guac_client_plugin_init_client(guac_client_plugin* plugin, 
00142         guac_client* client, int argc, char** argv);
00143 
00144 #endif
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines