91c1463b4161112213dd1849738e61e28d147f22
[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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  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 typedef enum rpc_capabilities {
42         RPC_DELAYED_REPLY = (1 <<0)  /* delayed reply support */
43 } rpc_capabilities_t;
44
45 struct rpc_delayed_ctx;
46
47
48 /* Send the result to the caller */
49 typedef int (*rpc_send_f)(void* ctx);                                      /* Send the reply to the client */
50 typedef void (*rpc_fault_f)(void* ctx, int code, char* fmt, ...);          /* Signal a failure to the client */
51 typedef int (*rpc_add_f)(void* ctx, char* fmt, ...);                       /* Add a new piece of data to the result */
52 typedef int (*rpc_scan_f)(void* ctx, char* fmt, ...);                      /* Retrieve request parameters */
53 typedef int (*rpc_rpl_printf_f)(void* ctx, char* fmt, ...);                /* Add printf-like formated data to the result set */
54 typedef int (*rpc_struct_add_f)(void* ctx, char* fmt, ...);                /* Add fields in a structure */
55 typedef int (*rpc_array_add_f)(void* ctx, char* fmt, ...);                 /* Add values in an array */
56 typedef int (*rpc_struct_scan_f)(void* ctx, char* fmt, ...);               /* Scan attributes of a structure */
57 typedef int (*rpc_struct_printf_f)(void* ctx, char* name, char* fmt, ...); /* Struct version of rpc_printf */
58
59 /* returns the supported capabilities */
60 typedef rpc_capabilities_t (*rpc_capabilities_f)(void* ctx);
61 /* create a special "context" for delayed replies */
62 typedef struct rpc_delayed_ctx* (*rpc_delayed_ctx_new_f)(void* ctx);
63 /* close the special "context" for delayed replies */
64 typedef void (*rpc_delayed_ctx_close_f)(struct rpc_delayed_ctx* dctx);
65
66 /*
67  * RPC context, this is what RPC functions get as a parameter and use
68  * it to obtain the value of the parameters of the call and reference
69  * to the result structure that will be returned to the caller
70  */
71 typedef struct rpc {
72         rpc_fault_f fault;
73         rpc_send_f send;
74         rpc_add_f add;
75         rpc_scan_f scan;
76         rpc_rpl_printf_f rpl_printf;
77         rpc_struct_add_f struct_add;
78         rpc_array_add_f array_add;
79         rpc_struct_scan_f struct_scan;
80         rpc_struct_printf_f struct_printf;
81         rpc_capabilities_f capabilities;
82         rpc_delayed_ctx_new_f delayed_ctx_new;
83         rpc_delayed_ctx_close_f delayed_ctx_close;
84 } rpc_t;
85
86
87 typedef struct rpc_delayed_ctx{
88         rpc_t rpc;
89         void* reply_ctx;
90         /* more private data might follow */
91 } rpc_delayed_ctx_t;
92
93
94 /*
95  * RPC Function Prototype
96  */
97
98 typedef void (*rpc_function_t)(rpc_t* rpc, void* ctx);
99
100 /*
101  * RPC callback context.
102  *
103  * Defines a convenient way of packing an rpc callback
104  * (rpc_function_t) parameters and it's not used/needed
105  * by the rpc api/interface.
106  */
107 typedef struct rpc_cb_ctx {
108         rpc_t *rpc;
109         void *c;
110 } rpc_cb_ctx_t;
111
112
113 /*
114  * Remote Procedure Call Export
115  */
116 typedef struct rpc_export {
117         const char* name;        /* Name of the RPC function (null terminated) */
118         rpc_function_t function; /* Pointer to the function */
119         const char** doc_str;  /* Documentation strings, method signature and description */
120         unsigned int flags;      /* Various flags, reserved for future use */
121 } rpc_export_t;
122
123
124 #endif /* _RPC_H */