429c6ee67cd83864b0fcbff1a8ed027faa45afcf
[vsc-common.git] / include / libvscremote / libvscremote.h
1 /*
2  * libvscremote.h: XML-RPC based remote extension for libvsccli
3  *
4  * Copyright (C) 2009 Matthias Bolte <matthias.bolte@googlemail.com>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
19  */
20
21 #ifndef __VSC_REMOTE_H__
22 #define __VSC_REMOTE_H__
23
24 #include <libvsccli/types.h>
25
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29
30 typedef const char * (*VscRemoteMethodNameLookupFunction)
31    (struct VscError *error, const char *command_name);
32
33 typedef const char * (*VscRemoteArgumentNameLookupFunction)
34    (struct VscError *error, const char *command_name,
35     const char *option_long_name);
36
37 extern const struct VscCliCommandInfo vsc_remote_login_command_info;
38 extern const struct VscCliCommandInfo vsc_remote_logout_command_info;
39
40 void
41 vsc_remote_init (struct VscError *error, const char *name, const char *version,
42                  const char *remote_url,
43                  VscRemoteMethodNameLookupFunction method_name_lookup_function,
44                  VscRemoteArgumentNameLookupFunction argument_name_lookup_function);
45
46 void
47 vsc_remote_cleanup (void);
48
49 void
50 vsc_remote_check (struct VscError *error, int expected_login_state);
51
52 const char *
53 vsc_remote_get_cookie (struct VscError *error);
54
55 const char *
56 vsc_remote_get_username (struct VscError *error);
57
58 #ifdef __cplusplus
59 }
60 #endif
61
62 #endif /* __VSC_REMOTE_H__ */