Login | Register


Documentation -> Manuals -> Manual devel -> Script Flags

Pages for other versions: devel 2.3 2.2 1.11 Older versions: 2.1 1.10 1.9 1.8 1.7 1.6 1.5 1.4

1.  Types of flags

  • message flags (or transaction flags) these flags are transaction persistent. They are visible in all routes and cases where the transaction context is visible
  • branch flags are saved also in transaction, but per branch; also they will be saved in usrloc (per contact). A new set of functions were added for manipulating these flags from script. So, there flags will be registration persistent and branch persistent.
  • script flags are no-message-related flags - they are only script persistent and you can strictly use them for scripting. Once you exit a top level route, they will be lost. These flags are useful and they offer an option to de-congest the message flags - many flags have no need to be saved as they just reflect some scripting status.

2.  Corresponding Functions

Starting from OpenSIPS 1.9, flags may receive alphanumerical values. However, this does not affect performance, since they are converted into bit indexes upon startup. When it comes to DB persistency (only a few modules do this - e.g. usrloc), flags are generally stored in their string form, in order to preserve their semantics, and not the bit index they received during a given OpenSIPS run.

2.1  Message/transaction flags

  • setflag(FLAG)
  • resetflag(FLAG)
  • isflagset(FLAG)

Examples: setflag(accounting), resetflag(DO_NAT) or setflag(19)

2.2  Branch flags

  • setbflag/setbranchflag(branch_idx, FLAG)
  • resetbflag/resetbranchflag(branch_idx, FLAG)
  • isbflagset/isbranchflagset(branch_idx, FLAG)

or, the shorter format, working on the default (branch 0) flags:

  • setbflag(FLAG)
  • resetbflag(FLAG)
  • isbflagset(FLAG)

2.3  Script flags

  • setsflag/setscriptflag(FLAG)
  • resetsflag/resetscriptflag(FLAG)
  • issflagset/isscriptflagset(FLAG)

3.  Flags and Pseudo Variables

3.1  Message/transaction flags

$mf - ReadOnly; outputs a list of flags

3.2  Branch flags

$bf - ReadOnly; returns a list of flags

3.3  Script flags

$sf - ReadOnly; outputs a list of flags

4.  Flags and routes

4.1  Message/transaction flags

These 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.

4.2  Branch flags

There 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.

4.3  Script flags

There 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.

5.  Example

5.1  Nat flag handling

 # 3 - the nat flag
 modparam("usrloc", "nat_bflag", "NAT_BFLAG")

 route {
   if (nat detected)
      setbflag(NAT_BFLAG); # set branch flag "NAT_BFLAG" for the branch 0

   if (is_method("REGISTER")) {
      # the branch flags (including "NAT_BFLAG") will be saved into location
   } else {
      # lookup will load the branch flag from location
      if (!lookup("location")) {
         sl_send_reply("404","Not Found");

 branch_route[1] {
   xlog("-------branch=$T_branch_idx, branch flags=$bF\n");
   if (isbflagset(NAT_BFLAG)) {
      #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(NAT_BFLAG)) {
      #current branch is marked as natted

Add Comment 
Sign as Author 
Enter code 308

Page last modified on July 21, 2015, at 11:53 AM