e2c57e16b4f514361180fea257f9e7e7dfa9b5fa
[sip-router] / modules / xmlops / README
1 1. XMLOPS Module
2
3 Daniel-Constantin Mierla
4
5    asipto.com
6    <miconda@gmail.com>
7
8    Copyright © 2009 asipto.com
9      __________________________________________________________________
10
11    1.1. Overview
12    1.2. Dependencies
13
14         1.2.1. Kamailio Modules
15         1.2.2. External Libraries or Applications
16
17    1.3. Parameters
18
19         1.3.1. buf_size (integer)
20         1.3.2. xml_ns (str)
21
22    1.4. Pseudo-Variables
23
24         1.4.1. $xml(name=>spec)
25
26 1.1. Overview
27
28    This is a module implementing funtions and pseudo-variables for XML
29    operations.
30
31 1.2. Dependencies
32
33 1.2.1. Kamailio Modules
34
35    The following modules must be loaded before this module:
36      * none.
37
38 1.2.2. External Libraries or Applications
39
40    The following libraries or applications must be installed before
41    running kamailio with this module loaded:
42      * libxml - for compilaiton is needed the devel vesion as well.
43
44 1.3. Parameters
45
46 1.3.1. buf_size (integer)
47
48    Maximum size of the XML buffer.
49
50    Default value is 4096.
51
52    Example 1. Set buf_size parameter
53 ...
54 modparam("xmlops", "buf_size", 8192)
55 ...
56
57 1.3.2. xml_ns (str)
58
59    Register xml namespace prefix. Parameter value must have the format:
60    'prefix=uri'.
61
62    Example 2. Set xml_ns parameter
63 ...
64 modparam("xmlops", "xml_ns", "rpid=urn:ietf:params:xml:ns:pidf:rpid")
65 ...
66
67 1.4. Pseudo-Variables
68
69 1.4.1.  $xml(name=>spec)
70
71    Pseudo-variable for XML document operations using xpath syntax. For
72    more see the Peudo-Variables Cookbook.
73
74    Example 3. xml usage
75 ...
76 $xml(x=>doc)
77     = '<?xml version="1.0" encoding="UTF-8"?><a><b>test</b></a>';
78 xlog("content of node b: $xml(x=>xpath:/a/b/text())\n");
79 $xml(x=>xpath:/a/b) = "1234";
80 ...