|
@@ -10,10 +10,10 @@
|
|
|
<!-- Module Developer's Guide -->
|
|
|
|
|
|
<chapter>
|
|
|
-
|
|
|
+
|
|
|
<title>&develguide;</title>
|
|
|
<para>
|
|
|
- The module exports a number of functions that allow selecting
|
|
|
+ The module exports a number of functions that allow selecting
|
|
|
and retrieving an element from an xcap server and also registering
|
|
|
a callback to be called when the management command refreshXcapDoc is received
|
|
|
and the document in question is retrieved.
|
|
@@ -23,21 +23,21 @@
|
|
|
<function moreinfo="none">bind_xcap_api(xcap_api_t* api)</function>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function allows binding the needed functions.
|
|
|
+ This function allows binding the needed functions.
|
|
|
</para>
|
|
|
<example>
|
|
|
<title><function>xcap_api</function> structure</title>
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
typedef struct xcap_api {
|
|
|
-
|
|
|
+
|
|
|
/* xcap node selection and retrieving functions*/
|
|
|
xcap_get_elem_t get_elem;
|
|
|
xcap_nodeSel_init_t int_node_sel;
|
|
|
xcap_nodeSel_add_step_t add_step;
|
|
|
xcap_nodeSel_add_terminal_t add_terminal;
|
|
|
xcap_nodeSel_free_t free_node_sel;
|
|
|
- xcapGetNewDoc_t getNewDoc; /* an initial request for the module
|
|
|
+ xcapGetNewDoc_t getNewDoc; /* an initial request for the module
|
|
|
to fetch this document that does not exist in xcap db table
|
|
|
and handle its update*/
|
|
|
|
|
@@ -48,7 +48,7 @@ typedef struct xcap_api {
|
|
|
</programlisting>
|
|
|
</example>
|
|
|
</section>
|
|
|
-
|
|
|
+
|
|
|
<section>
|
|
|
<title>
|
|
|
<function moreinfo="none">get_elem</function>
|
|
@@ -61,7 +61,7 @@ typedef char* (*xcap_get_elem_t)(char* xcap_root,
|
|
|
xcap_doc_sel_t* doc_sel, xcap_node_sel_t* node_sel);
|
|
|
...
|
|
|
</programlisting>
|
|
|
- </para>
|
|
|
+ </para>
|
|
|
<para>
|
|
|
This function sends a HTTP request and gets the specified information
|
|
|
from the xcap server.
|
|
@@ -90,15 +90,15 @@ typedef struct xcap_doc_sel
|
|
|
int type; /* the type of the path segment
|
|
|
after the AUID which must either
|
|
|
be GLOBAL_TYPE (for "global") or
|
|
|
- USERS_TYPE (for "users") */
|
|
|
- str xid; /* the XCAP User Identifier
|
|
|
+ USERS_TYPE (for "users") */
|
|
|
+ str xid; /* the XCAP User Identifier
|
|
|
if type is USERS_TYPE */
|
|
|
- str filename;
|
|
|
+ str filename;
|
|
|
}xcap_doc_sel_t;
|
|
|
...
|
|
|
</programlisting>
|
|
|
</listitem>
|
|
|
-
|
|
|
+
|
|
|
<listitem>
|
|
|
<para>
|
|
|
<emphasis>node_sel</emphasis>-
|
|
@@ -135,14 +135,14 @@ typedef struct ns_list
|
|
|
</programlisting>
|
|
|
<para>
|
|
|
The node selector is represented like a list of steps that will
|
|
|
- be represented in the path string separated by '/' signs.
|
|
|
+ be represented in the path string separated by '/' signs.
|
|
|
The namespaces for the nodes are stored also in a list, as an
|
|
|
association of name and value, where the value is to be included
|
|
|
in the respective string val field of the step.
|
|
|
</para>
|
|
|
<para>
|
|
|
To construct the node structure the following functions in the xcap_api
|
|
|
- structure should be used: 'int_node_sel', 'add_step' and if needed,
|
|
|
+ structure should be used: 'int_node_sel', 'add_step' and if needed,
|
|
|
'add_terminal'.
|
|
|
</para>
|
|
|
<para>
|
|
@@ -150,8 +150,8 @@ typedef struct ns_list
|
|
|
be NULL.
|
|
|
</para>
|
|
|
</listitem>
|
|
|
- </itemizedlist>
|
|
|
-
|
|
|
+ </itemizedlist>
|
|
|
+
|
|
|
</section>
|
|
|
<section>
|
|
|
<title>
|
|
@@ -177,6 +177,6 @@ typedef int (xcap_cb)(int doc_type, str xid, char* doc);
|
|
|
...
|
|
|
</programlisting>
|
|
|
</para>
|
|
|
- </section>
|
|
|
+ </section>
|
|
|
</chapter>
|
|
|
|