Documentation |
Documentation.Script-Flags-1-6 HistoryShow minor edits - Show changes to markup August 05, 2013, at 01:58 PM
by
- Changed line 4 from:
to:
(:allVersions Script-Flags 1.6:) May 29, 2013, at 01:50 AM
by
- Changed lines 1-2 from:
Documentation? -> Script -> Flags 1.6to:
Documentation -> Manuals -> Manual 1.6 -> Script Flags(:title Script Flags - ver 1.6 :) Added lines 4-12:
Deleted lines 13-14:
This documentation is valid for OpenSIPS v1.6.x May 12, 2013, at 02:11 PM
by
- Changed line 1 from:
Resources -> Documentation -> CookBooks -> Scripting Flagsto:
Documentation? -> Script -> Flags 1.6April 24, 2013, at 10:08 PM
by
- Added lines 1-147:
Resources -> Documentation -> CookBooks -> Scripting Flags(:toc-float Table of Content:) This documentation is valid for OpenSIPS v1.6.x Types of flags
Corresponding FunctionsMessage/transaction flagssetflag(flag_idx) resetflag(flag_idx) isflagset(flag_idx) Branch flagssetbflag/setbranchflag(branch_idx,flag_idx) resetbflag/resetbranchflag(branch_idx,flag_idx) isbflagset/isbranchflagset(branch_idx,flag_idx) or, the shorter format, working on the default (branch 0) flags: setbflag(flag_idx) resetbflag(flag_idx) isbflagset(flag_idx) Script flagssetsflag/setscriptflag(flag_idx) resetsflag/resetscriptflag(flag_idx) issflagset/isscriptflagset(flag_idx) Flags and Pseudo VariablesMessage/transaction flags$mf - decimal value $mF - hexa value Branch flags$bf - decimal value $bF - hexa value Script flags$sf - decimal value $sF - hexa valu Flags and routesMessage/transaction flagsThese flags will show up in all routes where messages related to the initial request are processed. So, they will be visible and changeable in onbranch, failure and onreply routes; the flags will be visible in all branch routes; if you change a flag in a branch route, the next branch routes will inherit the change. Branch flagsThere flags will show up in all routes where messages related to initial branch request are processed. So, in branch route you will see different sets of flags (as they are different branches); in onreply route yo will see the branch flags corresponding to the branch the reply belongs to; in failure route, the branch flags corresponding to the branch the winning reply belongs to will be visible. In request route, you can have multiple branches (as a result of a lookup(), enum query, append_branch(), etc) - the default branch is 0 (corresponding to the RURI); In reply routes there will be only one branch , the 0 one. In branch route the default branch is the current process branch (having index 0); In failure route, initially there is only one branch (index 0), corresponding the failed branch. Script flagsThere flags are available only in script and are reset after each top level route execution (routes internally triggered by OpenSIPS). They will be persistent per main route, onreply_route, branch_route, failure_route. Note they will be inherit in routes called from other routes. ExampleNat flag handling.......... # 3 - the nat flag modparam("usrloc","nat_bflag",3) .......... route { .......... if (nat detected) setbflag(3); # set branch flag 3 for the branch 0 .......... if (is_method("REGISTER")) { # the branch flags (including 3) will be saved into location save("location"); exit; } else { # lookup will load the branch flag from location if (!lookup("location")) { sl_send_reply("404","Not Found"); exit; } t_on_branch("1") t_relay(); } } branch_route[1] { xlog("-------branch=$T_branch_idx, branch flags=$bF\n"); if (isbflagset(3)) { #current branch is marked as natted ......... } } if no parallel forking is done, you can get rid of the branch route and add instead of t_on_branch(): ........ if (isbflagset(3)) { #current branch is marked as natted ......... } ......... Ronald? — 18 March 2012, 14:31(:commentboxchrono:) |