@cfg_get.<group_name>.<var_name> is documented
[sip-router] / rpc.h
1 /* $Id$
2  *
3  * SER Remote Procedure Call Interface
4  *
5  * Copyright (C) 2005 iptelorg GmbH
6  *
7  * This file is part of ser, a free SIP server.
8  *
9  * ser is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version
13  *
14  * For a license to use the ser software under conditions
15  * other than those described here, or to purchase support for this
16  * software, please contact iptel.org by e-mail at the following addresses:
17  *    info@iptel.org
18  *
19  * ser is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License 
25  * along with this program; if not, write to the Free Software 
26  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
27  */
28
29 #ifndef _RPC_H
30 #define _RPC_H
31
32 /*
33  * TODO: Add the possibility to add printf-like formatted string to fault
34  */
35
36 enum rpc_flags {
37         RET_ARRAY = (1 << 0),
38         RET_VALUE = (1 << 1)
39 };
40         
41
42 /* Send the result to the caller */
43 typedef int (*rpc_send_f)(void* ctx);                                      /* Send the reply to the client */
44 typedef void (*rpc_fault_f)(void* ctx, int code, char* fmt, ...);          /* Signal a failure to the client */
45 typedef int (*rpc_add_f)(void* ctx, char* fmt, ...);                       /* Add a new piece of data to the result */
46 typedef int (*rpc_scan_f)(void* ctx, char* fmt, ...);                      /* Retrieve request parameters */
47 typedef int (*rpc_printf_f)(void* ctx, char* fmt, ...);                    /* Add printf-like formated data to the result set */
48 typedef int (*rpc_struct_add_f)(void* ctx, char* fmt, ...);                /* Create a new structure */
49 typedef int (*rpc_struct_scan_f)(void* ctx, char* fmt, ...);               /* Scan attributes of a structure */
50 typedef int (*rpc_struct_printf_f)(void* ctx, char* name, char* fmt, ...); /* Struct version of rpc_printf */
51
52 /*
53  * RPC context, this is what RPC functions get as a parameter and use
54  * it to obtain the value of the parameters of the call and reference
55  * to the result structure that will be returned to the caller
56  */
57 typedef struct rpc {
58         rpc_fault_f fault;
59         rpc_send_f send;
60         rpc_add_f add;
61         rpc_scan_f scan;
62         rpc_printf_f printf;
63         rpc_struct_add_f struct_add;
64         rpc_struct_scan_f struct_scan;
65         rpc_struct_printf_f struct_printf;
66 } rpc_t;
67
68
69 /*
70  * RPC Function Prototype
71  */
72
73 typedef void (*rpc_function_t)(rpc_t* rpc, void* ctx);
74
75
76 /*
77  * Remote Procedure Call Export
78  */
79 typedef struct rpc_export {
80         const char* name;        /* Name of the RPC function (null terminated) */
81         rpc_function_t function; /* Pointer to the function */
82         const char** doc_str;  /* Documentation strings, method signature and description */
83         unsigned int flags;      /* Various flags, reserved for future use */
84 } rpc_export_t;
85
86
87 #endif /* _RPC_H */