[sr-dev] git:master:8217e812: rtjson: regenerated readme

Module: kamailio Branch: master Commit: 8217e812d5ba0dcd975c24aa1ead066e80742315 URL: https://github.com/kamailio/kamailio/commit/8217e812d5ba0dcd975c24aa1ead066… Author: Daniel-Constantin Mierla <miconda(a)gmail.com> Committer: Daniel-Constantin Mierla <miconda(a)gmail.com> Date: 2015-06-23T23:22:37+02:00 rtjson: regenerated readme --- Modified: modules/rtjson/README --- Diff: https://github.com/kamailio/kamailio/commit/8217e812d5ba0dcd975c24aa1ead066… Patch: https://github.com/kamailio/kamailio/commit/8217e812d5ba0dcd975c24aa1ead066… --- diff --git a/modules/rtjson/README b/modules/rtjson/README index b1cc61d..5ac95f8 100644 --- a/modules/rtjson/README +++ b/modules/rtjson/README @@ -10,7 +10,7 @@ Daniel-Constantin Mierla <miconda(a)gmail.com> - Copyright © 2015 asipto.com + Copyright © 2015 asipto.com __________________________________________________________________ Table of Contents @@ -116,7 +116,7 @@ modparam("rtjson", "xavp_cfg", "myxavp") 4.3. rtjson_next_route() 4.4. rtjson_update_branch() -4.1. rtjson_init_routes(rtdoc) +4.1. rtjson_init_routes(rtdoc) Initialize routing based on JSON document stored in rtdoc parameter. @@ -131,7 +131,7 @@ modparam("rtjson", "xavp_cfg", "myxavp") rtjson_init_routes("$var(json)"); ... -4.2. rtjson_push_routes() +4.2. rtjson_push_routes() Push the routes given in JSON document to rtjson_init_routes(rtdoc) to the internal fields used by Kamailio for routing. @@ -144,7 +144,7 @@ rtjson_init_routes("$var(json)"); rtjson_push_routes(); ... -4.3. rtjson_next_route() +4.3. rtjson_next_route() To be used in failure_route for serial forking, to push the next route to the internal fields used by Kamailio for routing. @@ -155,13 +155,15 @@ rtjson_push_routes(); ... rtjson_init_routes("$var(json)"); rtjson_push_routes(); +t_on_failure("REROUTE"); +t_relay(); ... failure_route[REROUTE] { rtjson_next_route(); } ... -4.4. rtjson_update_branch() +4.4. rtjson_update_branch() To be used in branch_route if the JSON document had attributes that needs to be set for each branch. @@ -172,6 +174,8 @@ failure_route[REROUTE] { ... rtjson_init_routes("$var(json)"); rtjson_push_routes(); +t_on_branch("OUTGOING"); +t_relay(); ... branch_route[OUTGOING] { rtjson_update_branch(); @@ -182,13 +186,40 @@ branch_route[OUTGOING] { The format of the JSON document containing routing information. - Description of the fields: TBA. + Description of the fields in the JSON routing document: + * version - intended to enforce versioning checks (not enforced yet), + recommended to be set to "1.0". + * routing - can be "serial" or "parallel", corresponding to desired + routing type: serial or parallel forking. + * routes - an array with structures holding the attributes for + destinations. The attributes can be: + + uri - request URI + + dst_uri - outbound proxy URI + + path - Path URI vector + + socket - local socket + + headers - a structure with values for headers From and To + specified as display name and URI, plus extra headers to be + appended to SIP request. It requires uac module in order to + update From and To headers. Set by rtjson_update_branch() only + for serial routing. + + branch_flags - branch flags. Set by rtjson_update_branch() + only for serial routing. + + fr_timer - value for fr_timer parameter of tm module. Set by + rtjson_update_branch() only for serial routing. + + fr_inv_timer - value for fr_inv_timer parameter of tm module. + Set by rtjson_update_branch() only for serial routing. + + Other fields can appear in the JSON routing document, being ignored by + rtjson functions. They can be processed directly in the configuration + files using json or jansson modules. For example, the document can + include the transaction identification tuple (index,label) that can be + used to resume the execution of a suspended transaction. Example 1.6. JSON Routing Structure ... { "version": "1.0", - "routing": "parallel", + "routing": "serial", "routes": [ { "uri": "sip:127.0.0.1:5080",