Regular expressions - Revision history

Monica: /* Parameters */

2013-11-04T10:27:45Z

‎Parameters

Monica: /* Parameters */

2013-10-31T12:50:46Z

‎Parameters

Dana at 13:12, 11 June 2013

2013-06-11T13:12:58Z

Dana: /* Result of the match */

2013-05-27T09:21:29Z

‎Result of the match

Dana at 08:29, 27 May 2013

2013-05-27T08:29:37Z

Dana: /* Messages handled */

2013-05-10T12:44:55Z

‎Messages handled

Dana: /* Messages handled */

2013-05-10T12:44:27Z

‎Messages handled

Monica: /* Messages handled */

2013-04-08T12:15:09Z

‎Messages handled

Monica at 12:14, 8 April 2013

2013-04-08T12:14:31Z

Dana: /* Request inband DTMF detection */

2013-04-08T12:02:11Z

‎Request inband DTMF detection

← Older revision		Revision as of 10:27, 4 November 2013
Line 415:		Line 415:
	* [[Routing]]		* [[Routing]]

−	[[Category:Routing]]	+	[[Category:Routing]] [[Category:Regexroute]]

← Older revision		Revision as of 12:50, 31 October 2013
Line 414:		Line 414:
	* [[Example of forking a call using lateroute]] - if you want to fork calls and route the forked call legs again through regexroute, this page will help you.		* [[Example of forking a call using lateroute]] - if you want to fork calls and route the forked call legs again through regexroute, this page will help you.
	* [[Routing]]		* [[Routing]]
		+
		+	[[Category:Routing]]

@@ Line 132: / Line 132: @@
 It is possible to use this module to install handlers for arbitrary messages. This is done by listing the messages and their priority in the [extra] section of the config file. You can only install one handler for any given message name.
-Each such message will be handled in a section with the same name as the message. The default match sting is the message name so make sure you set a new match or name the parameters explicitely:
+Each such message will be handled in a section with the same name as the message. The default match sting is the message name so make sure you set a new match or name the parameters explicitly:
   [extra]
@@ Line 268: / Line 268: @@
   ; For each handler create a corresponding [message.name] section in which
   ;  implement handling for that specific message. You will need to match
-  ;  parameters explicitely or set a new match string.
+  ;  parameters explicitly or set a new match string.

@@ Line 24: / Line 24: @@
 In both prerouting and routing the result of the match (right-hand size of the line, after the equal sign) can include parts of the matched string. For this to work the matching expression should include the \( and \) subexpression capture markers. In the result you can use \digit markers which are replaced with the entire matched string (\0), first captured subexpression (\1), second matched subexpression (\2) and so on. You can include each of the the \digit placeholders as many times as you need.
-Expressions are checked sequentially in their section. As soon as one matches and specifies a result, its result is returned and no further matches are attempted. If an expression matches, but its result is empty, parameters will be changed according to the string after ";", but further matches will be attempted (see the gsm codec example which doesn't return).
+Expressions are checked sequentially in their section. As soon as one matches and specifies a result, its result is returned and no further matches are attempted. If an expression matches, but its result is empty, parameters will be changed according to the string after ";", but further matches will be attempted (see the [[#Changing codec priorities|gsm codec example]] which doesn't return).
 You can act on non-matching regular expressions by adding a caret character ^ at the end of them. Note that in this case the matched string (\0) and all captured subexpressions will be empty.

@@ Line 4: / Line 4: @@
 Besides the basic routing functionality, this module allows custom handling for other messages and using global variables.
-===Messages handled===
+==Messages handled==
 There are two messages handled by default by the regexroute module:
@@ Line 12: / Line 12: @@
 Besides this messages, you can add custom handlers for other messages as well. See [[#Handling_extra_messages|handling extra messages]].
-==== Preroute stage ====
+=== Preroute stage ===
 In the preroute stage the caller is matched with regular expressions in the '''[contexts]''' section and the result is stored in a message parameter named '''context'''. Note that the preroute stage is skipped if the message already has a '''context''' parameter.
-==== Route stage ====
+=== Route stage ===
 In the route stage the called number is matched against regular expressions from the section with the same name as the value of the '''context''' parameter. If this parameter is missing the [default] section is used.
-====Result of the match====
+===Result of the match===
 In both prerouting and routing the result of the match (right-hand size of the line, after the equal sign) can include parts of the matched string. For this to work the matching expression should include the \( and \) subexpression capture markers. In the result you can use \digit markers which are replaced with the entire matched string (\0), first captured subexpression (\1), second matched subexpression (\2) and so on. You can include each of the the \digit placeholders as many times as you need.
@@ Line 48: / Line 48: @@
 The module also supports global variables that are not tied to a specific message. These can be used in the right hand expressions for building call targets and setting message parameters. Global variables are accessed as '''$(variable)''' or as '''$variable''' in function parameters.
-=== Order of processing ===
+== Order of processing ==
 For each line that matches the following operations are applied:
@@ Line 58: / Line 58: @@
 For the ''if'' target the line is processed only after matching the last ''if'' - that is on the first target that is not ''if''.
-==== Examples ====
+=== Examples ===
 ) For the matching rule:
@@ Line 91: / Line 91: @@
 Naturally, instead of regfile.conf you can use the database module (register.conf), with the priorities set accordingly. Note, if you have a catch-all in regexroute, and give it a higher numeric priority, then it will route all your internal lines - meaning, you need to define rules in regexroute so these numbers get routed by your register or regfile modules.
-=== Testing and debug routing ===
+== Testing and debug routing ==
 An easy way to debug routing is to use the function echo:
@@ Line 99: / Line 99: @@
 The first part - ^.*$ matches every call and the second part prints in the Yate Debug called is called_value
-=== Handling authentication ===
+== Handling authentication ==
 In many cases you need to authorize only authenticated calls. The authentication is performed by the module that handles the incoming call which sets the "username" parameter. This is valid only for the SIP protocol.
@@ Line 106: / Line 106: @@
   ${username}^$=-;error=noauth
-=== Changing codec priorities ===
+== Changing codec priorities ==
 The incoming call's codecs are hold in a parameter "formats" that can be manipulated to favor some codecs. An example of bringing the GSM codec to front is this:
@@ Line 117: / Line 117: @@
 See more info about using regexroute for [[Transcoding|transcoding]].
-=== Request inband DTMF detection ===
+== Request inband DTMF detection==
 If inband DTMF tones are used and the hardware does not support detecting them, Yate can provide detection using the [[Tone detector|tonedetect]] module. Please check the module documentation for applicability and resource format.
@@ Line 128: / Line 128: @@
   .*=;tonedetect_out=yes
-=== Handling extra messages ===
+== Handling extra messages ==
 It is possible to use this module to install handlers for arbitrary messages. This is done by listing the messages and their priority in the [extra] section of the config file. You can only install one handler for any given message name.
@@ Line 144: / Line 144: @@
   ${username}^$=;auth_register=false
-=== Using global variables ===
+== Using global variables ==
 The module supports arbitrary variables that are preserved between calls.
@@ Line 165: / Line 165: @@
   ^set \([^ ]\+\) \+\(.*\)$=\1=\2$(chr,13)$(chr,10);$\1=\2
-=== The regexroute configuration file ===
+== The regexroute configuration file ==
 This is the regexroute.conf file:
@@ Line 390: / Line 390: @@
   ;.*=-;error=noauth
-=== Parameters ===
+== Parameters ==
 This is a list of usual parameters found in the [[call.route|call.route]] message. Arbitrary parameters can be added by any module.

@@ Line 10: / Line 10: @@
 * the '''call.route''' message that tries to map a called number to a string describing the target channel or module
-Besides this messages, you can add custom handlers for other messages as well. See [[#Handling_extra_messages]]
+Besides this messages, you can add custom handlers for other messages as well. See [[#Handling_extra_messages|handling extra messages]]
 ==== Preroute stage ====

@@ Line 7: / Line 7: @@
 There are two messages handled by default by the regexroute module:
-* the '''preroute''' message that tries to classify the caller in a context
+* the '''call.preroute''' message that tries to classify the caller in a context
-* the '''route''' message that tries to map a called number to a string describing the target channel or module
+* the '''call.route''' message that tries to map a called number to a string describing the target channel or module
 Besides this messages, you can add custom handlers for other messages as well. See [[#Handling_extra_messages]]

← Older revision		Revision as of 12:14, 8 April 2013
Line 1:		Line 1:

	Regular expression Route Module(regexroute) provides a simple way of routing telephony calls inside Yate.<br> This module describes the routes using a configuration file in which each number or parameter is matched using regular expressions.		Regular expression Route Module(regexroute) provides a simple way of routing telephony calls inside Yate.<br> This module describes the routes using a configuration file in which each number or parameter is matched using regular expressions.
		+
		+	Besides the basic routing functionality, this module allows custom handling for other messages and using global variables.

	===Messages handled===		===Messages handled===