pkg/kamailio/fedora/16: Updated rel in .spec to dev2
[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 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_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, ...);                /* Create a new structure */
55 typedef int (*rpc_struct_scan_f)(void* ctx, char* fmt, ...);               /* Scan attributes of a structure */
56 typedef int (*rpc_struct_printf_f)(void* ctx, char* name, char* fmt, ...); /* Struct version of rpc_printf */
57
58 /* returns the supported capabilities */
59 typedef rpc_capabilities_t (*rpc_capabilities_f)(void* ctx);
60 /* create a special "context" for delayed replies */
61 typedef struct rpc_delayed_ctx* (*rpc_delayed_ctx_new_f)(void* ctx);
62 /* close the special "context" for delayed replies */
63 typedef void (*rpc_delayed_ctx_close_f)(struct rpc_delayed_ctx* dctx);
64
65 /*
66  * RPC context, this is what RPC functions get as a parameter and use
67  * it to obtain the value of the parameters of the call and reference
68  * to the result structure that will be returned to the caller
69  */
70 typedef struct rpc {
71         rpc_fault_f fault;
72         rpc_send_f send;
73         rpc_add_f add;
74         rpc_scan_f scan;
75         rpc_printf_f printf;
76         rpc_struct_add_f struct_add;
77         rpc_struct_scan_f struct_scan;
78         rpc_struct_printf_f struct_printf;
79         rpc_capabilities_f capabilities;
80         rpc_delayed_ctx_new_f delayed_ctx_new;
81         rpc_delayed_ctx_close_f delayed_ctx_close;
82 } rpc_t;
83
84
85 typedef struct rpc_delayed_ctx{
86         rpc_t rpc;
87         void* reply_ctx;
88         /* more private data might follow */
89 } rpc_delayed_ctx_t;
90
91
92 /*
93  * RPC Function Prototype
94  */
95
96 typedef void (*rpc_function_t)(rpc_t* rpc, void* ctx);
97
98 /*
99  * RPC callback context.
100  *
101  * Defines a convenient way of packing an rpc callback
102  * (rpc_function_t) parameters and it's not used/needed
103  * by the rpc api/interface.
104  */
105 typedef struct rpc_cb_ctx {
106         rpc_t *rpc;
107         void *c;
108 } rpc_cb_ctx_t;
109
110
111 /*
112  * Remote Procedure Call Export
113  */
114 typedef struct rpc_export {
115         const char* name;        /* Name of the RPC function (null terminated) */
116         rpc_function_t function; /* Pointer to the function */
117         const char** doc_str;  /* Documentation strings, method signature and description */
118         unsigned int flags;      /* Various flags, reserved for future use */
119 } rpc_export_t;
120
121
122 #endif /* _RPC_H */