19681c748596735f6538722e1b60524f8c22dcd8
[sip-router] / modules / corex / README
1 COREX Module
2
3 Daniel-Constantin Mierla
4
5    <miconda@gmail.com>
6
7 Edited by
8
9 Daniel-Constantin Mierla
10
11    <miconda@gmail.com>
12
13    Copyright © 2012 asipto.com
14      __________________________________________________________________
15
16    Table of Contents
17
18    1. Admin Guide
19
20         1. Overview
21         2. Dependencies
22
23               2.1. Kamailio Modules
24               2.2. External Libraries or Applications
25
26         3. Parameters
27
28               3.1. alias_subdomains (string)
29
30         4. Functions
31
32               4.1. append_branch([ uri, [ q ] ])
33
34         5. RPC Commands
35
36               5.1. corex.list_sockets
37               5.2. corex.list_aliases
38
39    List of Examples
40
41    1.1. Set alias_subdomains parameter
42    1.2. append_branch usage
43
44 Chapter 1. Admin Guide
45
46    Table of Contents
47
48    1. Overview
49    2. Dependencies
50
51         2.1. Kamailio Modules
52         2.2. External Libraries or Applications
53
54    3. Parameters
55
56         3.1. alias_subdomains (string)
57
58    4. Functions
59
60         4.1. append_branch([ uri, [ q ] ])
61
62    5. RPC Commands
63
64         5.1. corex.list_sockets
65         5.2. corex.list_aliases
66
67 1. Overview
68
69    This module provides reimplementation of very old functions that were
70    in core and supported only static string or integer parameters. The new
71    versions bring support for dynamic parameters (allowing variables
72    inside the parameters).
73
74    There are also brand new features, related to core internals, but
75    controlled from configuration file or via control interfaces.
76
77    Contributions to this module must be done under BSD license, to follow
78    the requirements of the core contributions.
79
80 2. Dependencies
81
82    2.1. Kamailio Modules
83    2.2. External Libraries or Applications
84
85 2.1. Kamailio Modules
86
87    The following modules must be loaded before this module:
88      * None.
89
90 2.2. External Libraries or Applications
91
92    The following libraries or applications must be installed before
93    running Kamailio with this module loaded:
94      * None
95
96 3. Parameters
97
98    3.1. alias_subdomains (string)
99
100 3.1. alias_subdomains (string)
101
102    Register a domain and all its sub-domains to match the myself
103    condition. It can be set many times. Its full format is:
104    'proto:domain:port', allowing to set restrictions on protocol and port
105    as well. Protocol and port are optional.
106
107    Default value is "NULL".
108
109    Example 1.1. Set alias_subdomains parameter
110 ...
111 modparam("corex", "alias_subdomains", "kamailio.org")
112 modparam("corex", "alias_subdomains", "udp:sip-router.org:5060")
113 ...
114
115 4. Functions
116
117    4.1. append_branch([ uri, [ q ] ])
118
119 4.1. append_branch([ uri, [ q ] ])
120
121    Append a new branch to the destination set, useful to build the
122    addresses for parallel forking or redirect replies.
123
124    Both parameters are optional, If no uri parameter is provided, then the
125    address from request URI (r-uri) is taken to build the new branch.
126
127    Meaning of the parameters is as follows:
128      * uri - SIP address of the branch to be used as R-URI in the outgoing
129        request.
130      * q - the Q value to set the priority of the branch based on Contact
131        address specifications
132
133    This function can be used from REQUEST_ROUTE or FAILURE_ROUTE.
134
135    Example 1.2. append_branch usage
136 ...
137     append_branch();
138     append_branch("$avp(uri)", "0.5");
139 ...
140
141 5. RPC Commands
142
143    5.1. corex.list_sockets
144    5.2. corex.list_aliases
145
146 5.1. corex.list_sockets
147
148    Print the list of sockets the application is listening on.
149
150    Example:
151                 sercmd corex.list_sockets
152
153 5.2. corex.list_aliases
154
155    Print the list of hostname aliases used to match myself condition.
156
157    Example:
158                 sercmd corex.list_aliases