Core Update of doxygen, removal of history, changing "ser" to "kamailio"
[sip-router] / rpc.h
1 /* 
2  * Kamailio Remote Procedure Call Interface
3  *
4  * Copyright (C) 2005 iptelorg GmbH
5  *
6  * This file is part of Kamailio, a free SIP server.
7  *
8  * Kamailio is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version
12  *
13  * Kamailio is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License 
19  * along with this program; if not, write to the Free Software 
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
21  */
22
23 /*!
24 * \file
25 * \brief Kamailio core :: RPC, Remote procedure call interface
26 * \ingroup core
27 * Module: \ref core
28 */
29
30 #ifndef _RPC_H
31 #define _RPC_H
32
33 /*
34  * TODO: Add the possibility to add printf-like formatted string to fault
35  */
36
37 enum rpc_flags {
38         RET_ARRAY = (1 << 0),
39         RET_VALUE = (1 << 1)
40 };
41
42 typedef enum rpc_capabilities {
43         RPC_DELAYED_REPLY = (1 <<0)  /* delayed reply support */
44 } rpc_capabilities_t;
45
46 struct rpc_delayed_ctx;
47
48
49 /* Send the result to the caller */
50 typedef int (*rpc_send_f)(void* ctx);                                      /*!< Send the reply to the client */
51 typedef void (*rpc_fault_f)(void* ctx, int code, char* fmt, ...);          /*!< Signal a failure to the client */
52 typedef int (*rpc_add_f)(void* ctx, char* fmt, ...);                       /*!< Add a new piece of data to the result */
53 typedef int (*rpc_scan_f)(void* ctx, char* fmt, ...);                      /*!< Retrieve request parameters */
54 typedef int (*rpc_rpl_printf_f)(void* ctx, char* fmt, ...);                /*!< Add printf-like formated data to the result set */
55 typedef int (*rpc_struct_add_f)(void* ctx, char* fmt, ...);                /*!< Add fields in a structure */
56 typedef int (*rpc_array_add_f)(void* ctx, char* fmt, ...);                 /*!< Add values in an array */
57 typedef int (*rpc_struct_scan_f)(void* ctx, char* fmt, ...);               /*!< Scan attributes of a structure */
58 typedef int (*rpc_struct_printf_f)(void* ctx, char* name, char* fmt, ...); /*!< Struct version of rpc_printf */
59
60 /* returns the supported capabilities */
61 typedef rpc_capabilities_t (*rpc_capabilities_f)(void* ctx);
62 /* create a special "context" for delayed replies */
63 typedef struct rpc_delayed_ctx* (*rpc_delayed_ctx_new_f)(void* ctx);
64 /* close the special "context" for delayed replies */
65 typedef void (*rpc_delayed_ctx_close_f)(struct rpc_delayed_ctx* dctx);
66
67 /*
68  * RPC context, this is what RPC functions get as a parameter and use
69  * it to obtain the value of the parameters of the call and reference
70  * to the result structure that will be returned to the caller
71  */
72 typedef struct rpc {
73         rpc_fault_f fault;
74         rpc_send_f send;
75         rpc_add_f add;
76         rpc_scan_f scan;
77         rpc_rpl_printf_f rpl_printf;
78         rpc_struct_add_f struct_add;
79         rpc_array_add_f array_add;
80         rpc_struct_scan_f struct_scan;
81         rpc_struct_printf_f struct_printf;
82         rpc_capabilities_f capabilities;
83         rpc_delayed_ctx_new_f delayed_ctx_new;
84         rpc_delayed_ctx_close_f delayed_ctx_close;
85 } rpc_t;
86
87
88 typedef struct rpc_delayed_ctx{
89         rpc_t rpc;
90         void* reply_ctx;
91         /* more private data might follow */
92 } rpc_delayed_ctx_t;
93
94
95 /**
96  * RPC Function Prototype
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 */