%docentities; ]> &adminguide;
Overview This is a module that enables media streams to be proxied via an &rtp; proxy. The only &rtp; proxy currently known to work with this module is the Sipwise rtpengine . The rtpengine module is a modified version of the original rtpproxy module using a new control protocol. The module is designed to be a drop-in replacement for the old module from a configuration file point of view, however due to the incompatible control protocol, it only works with &rtp; proxies which specifically support it.
Multiple &rtp; proxy usage The rtpengine module can support multiple &rtp; proxies for balancing/distribution and control/selection purposes. The module allows definition of several sets of rtpproxies. Load-balancing will be performed over a set and the admin has the ability to choose what set should be used. The set is selected via its id - the id being defined with the set. Refer to the rtpengine_sock module parameter definition for syntax description. The balancing inside a set is done automatically by the module based on the weight of each &rtp; proxy from the set. The selection of the set is done from script prior using rtpengine_delete(), rtpengine_offer() or rtpengine_answer() functions - see the set_rtpengine_set() function. Another way to select the set is to define setid_avp module parameter and assign setid to the defined avp before calling rtpengine_offer() or rtpengine_manage() function. If forwarding of the requests fails and there is another branch to try, remember to unset the avp after calling rtpengine_delete() function. For backward compatibility reasons, a set with no id take by default the id 0. Also if no set is explicitly set before rtpengine_delete(), rtpengine_offer() or rtpengine_answer() the 0 id set will be used. IMPORTANT: if you use multiple sets, take care and use the same set for both rtpengine_offer()/rtpengine_answer() and rtpengine_delete()!! If the set was selected using setid_avp, the avp needs to be set only once before rtpengine_offer() or rtpengine_manage() call. From the current implementation point of view, the sets of rtpproxy nodes are shared memory(shm), so all processes can see a common list of nodes. There is no locking when setting the nodes enabled/disabled (to keep the memory access as fast as possible). Thus, problems related to node state might appear for concurent processes that might set the nodes enabled/disabled(e.g. by fifo command). This robustness problems are overcomed as follows. If the current process sees the selected node as disabled, the node is force tested before the current process actually takes the disabled decision. If the test succeeds, the process will set the node as enabled (but other concurrent process might still see it as disabled). . If the current process sees the selected node as enabled, it does no additional checks and sends the command which will fail in case the machine is actually broken. The process will set the node as disabled (but other concurrent process might still see it as enabled). The 'kamctl fifo' commands (including rtpengin ones) are executed by an exclusive process which operate on the same shared memory node list. All the nodes are pinged in the beginning by all the processes, even if the node list is shared memory.
Dependencies
&kamailio; Modules The following modules must be loaded before this module: tm module - (optional) if you want to have rtpengine_manage() fully functional
External Libraries or Applications The following libraries or applications must be installed before running &kamailio; with this module loaded: None.
Parameters
<varname>rtpengine_sock</varname> (string) Definition of socket(s) used to connect to (a set) &rtp; proxy. It may specify a UNIX socket or an IPv4/IPv6 UDP socket. Default value is NONE (disabled). Set <varname>rtpengine_sock</varname> parameter ... # single rtproxy modparam("rtpengine", "rtpengine_sock", "udp:localhost:12221") # multiple rtproxies for LB with weights (missing weight defaults to 1) modparam("rtpengine", "rtpengine_sock", "udp:localhost:12221=2 udp:localhost:12222=1") # multiple sets of multiple rtproxies modparam("rtpengine", "rtpengine_sock", "1 == udp:localhost:12221 udp:localhost:12222") modparam("rtpengine", "rtpengine_sock", "2 == udp:localhost:12225") ...
<varname>rtpengine_disable_tout</varname> (integer) Once an &rtp; proxy was found unreachable and marked as disabled, the rtpengine module will not attempt to establish communication to that &rtp; proxy for rtpengine_disable_tout seconds. Default value is 60. Set <varname>rtpengine_disable_tout</varname> parameter ... modparam("rtpengine", "rtpengine_disable_tout", 20) ...
<varname>rtpengine_tout_ms</varname> (integer) Timeout value expressed in milliseconds in waiting for reply from &rtp; proxy. Default value is 1000. Set <varname>rtpengine_tout_ms</varname> parameter ... modparam("rtpengine", "rtpengine_tout_ms", 2000) ...
<varname>rtpengine_allow_op</varname> (integer) Enable this to allow finishing the current sessions while denying new sessions for the manually deactivated nodes via kamctl command i.e. "disabled(permanent)" nodes. Probably the manually deactivated machine is still running(did not crash). This is useful when deactivating a node for maintanance and reject new sessions but allow current ones to finish. The behaviour is the same for a rtpengine deleted table node. When the node is deleted from the table and the table reloaded (see nh_reload_rtpp) the node actually is disabled(permanent) and hidden for display. Next time the same node will be added in the table, and the content reloaded, it will be updated and re-displayed. Default value is 0 to keep the current behaviour. Set <varname>rtpengine_allow_op</varname> parameter ... modparam("rtpengine", "rtpengine_allow_op", 1) ...
<varname>queried_nodes_limit</varname> (integer) The total number of nodes inside a set (sets are configurable via rtpengine_sock function) to be queried before giving up establishing a session. This brings more flexibility in case checking all rtpengines would take too long. Max limit is 50. By default all nodes in a set are tried before giving up communicating with the rtpengines. Set <varname>queried_nodes_limit</varname> parameter ... modparam("rtpengine", "queried_nodes_limit", 5) ...
<varname>rtpengine_retr</varname> (integer) How many times the module should retry to send and receive after timeout was generated. Default value is 5. Set <varname>rtpengine_retr</varname> parameter ... modparam("rtpengine", "rtpengine_retr", 2) ...
<varname>extra_id_pv</varname> (string) The parameter sets the PV defination to use when the b parameter is used on rtpengine_delete(), rtpengine_offer(), rtpengine_answer() or rtpengine_manage() command. Default is empty, the b parameter may not be used then. Set <varname>extra_id_pv</varname> parameter ... modparam("rtpengine", "extra_id_pv", "$avp(extra_id)") ...
<varname>setid_avp</varname> (string) The parameter defines an AVP that, if set, determines which &rtp; proxy set rtpengine_offer(), rtpengine_answer(), rtpengine_delete(), and rtpengine_manage() functions use. There is no default value. Set <varname>setid_avp</varname> parameter ... modparam("rtpengine", "setid_avp", "$avp(setid)") ...
<varname>force_send_interface</varname> (string) Forces all control messages between the &sip; proxy and the &rtp; proxy to be sent from the specified local interface. Both IPv4 and IPv6 addresses are supported. If not specified, the default interface selected by the operating system will be used. Note: when rtpengine_sock is a IPv6 link-local address, one _must_ set this parameter in order to successfully connect to RTP engine. This is necessarely because OS needs additional scope_id hint to communicate over IPv6 link locals. The scope_id is resolved based on the given IPv6. There is no default value. Set <varname>force_send_interface</varname> parameter ... modparam("rtpengine", "force_send_interface", "10.3.7.123") modparam("rtpengine", "force_send_interface", "2001:8d8:1ff:10c0:9a90:96ff:fea8:fd99") ...
<varname>read_sdp_pv</varname> (string) If this parameter is set to a valid AVP or script var specifier, rtpengine will take the input SDP from this pv instead of the message body. There is no default value. Set <varname>read_sdp_pv</varname> parameter ... modparam("rtpengine", "read_sdp_pv", "$var(sdp)") ... route { ... $var(sdp) = $rb + "a=foo:bar\r\n"; rtpengine_manage(); }
<varname>write_sdp_pv</varname> (string) If this parameter is set to a valid AVP or script var specifier, the SDP returned by rtpengine in the offer/answer operations is returned in the specified variable instead of the message body. There is no default value. Set <varname>write_sdp_pv</varname> parameter ... modparam("rtpengine", "write_sdp_pv", "$avp(sdp)") ... route { ... rtpengine_manage(); set_body("$avp(sdp)a=baz123\r\n", "application/sdp"); }
<varname>rtp_inst_pvar</varname> (string) A pseudo variable to store the chosen RTP Engine IP address. If this parameter is set, the IP address and port of the instance chosen will be stored in the given variable. By default, this parameter is not set. Set <varname>rtp_inst_pvar</varname> parameter ... modparam("rtpengine", "rtp_inst_pvar", "$avp(RTP_INSTANCE)") ...
<varname>hash_table_size</varname> (integer) Size of the hash table. Default value is 256. NOTE: If configured size is less than 1, the size will be defaulted to 1. Set <varname>hash_table_size</varname> parameter ... modparam("rtpengine", "hash_table_size", "123") ...
<varname>hash_table_tout</varname> (integer) Number of seconds after an rtpengine hash table entry is marked for deletion. By default, this parameter is set to 3600 (seconds). To maintain information about a selected rtp machine node, for a given call, entries are added in a hashtable of (callid, node) pairs. When command comes, lookup callid. If found, return chosen node. If not found, choose a new node, insert it in the hastable and return the chosen node. NOTE: In the current implementation, the actual deletion happens on the fly, while insert/remove/lookup the hastable, only for the entries in the insert/remove/lookup path. NOTE: When configuring this parameter, one should consider maximum call time VS share memory for unfinished calls. Set <varname>hash_table_tout</varname> parameter ... modparam("rtpengine", "hash_table_tout", "300") ...
<varname>db_url</varname> (string) The rtpengine datablase url. If present and valid, it activates database mode. Node information is read from database, not from config. By default, the datablase url is NULL (not set). Set <varname>db_url</varname> parameter ... modparam("rtpengine", "db_url", "mysql://pass@localhost/db") ...
<varname>table_name</varname> (string) The rtpengine table name. If database mode is activated (i.e. valid db_url), set the name of rtpengine table, on startup. By default, the rtpengine table name is "rtpengine". NOTE: One needs to add the version of the rtpengine table in the version table. The current version is version 1. Set <varname>table_name</varname> parameter ... modparam("rtpengine", "table_name", "rtpengine_table_name") ... Setup <varname>rtpengine</varname> table mysql> describe rtpengine; +----------+------------------+------+-----+---------+-------+ | Field | Type | Null | Key | Default | Extra | +----------+------------------+------+-----+---------+-------+ | setid | int(10) unsigned | NO | | NULL | | | url | varchar(256) | NO | | NULL | | | weight | int(10) unsigned | NO | | NULL | | | disabled | int(11) | NO | | NULL | | +----------+------------------+------+-----+---------+-------+ mysql> select * from rtpengine; +-------+---------------------------+--------+----------+ | setid | url | weight | disabled | +-------+---------------------------+--------+----------+ | 0 | udp:rtpproxy1.domain:8800 | 100 | 0 | | 0 | udp:rtpproxy2.domain:8800 | 200 | 1 | +-------+---------------------------+--------+----------+ mysql> select * from version; +---------------------------+---------------+ | table_name | table_version | +---------------------------+---------------+ | rtpengine | 1 | +---------------------------+---------------+
<varname>setid_col</varname> (string) Column name in the rtpengine table. If database mode is activated (i.e. valid db_url), set the setid of rtp nodes according to this column, on startup. The MySQL value for this column should be INT UNSIGNED. By default, the column name is "setid". Set <varname>setid_col</varname> parameter ... modparam("rtpengine", "setid_col", "setid_column_name") ...
<varname>url_col</varname> (string) Column name in the rtpengine table. If database mode is activated (i.e. valid db_url), set the url of rtp nodes according to this column, on startup. The MySQL value for this column should be VARCHAR. By default, the column name is "url". Set <varname>url_col</varname> parameter ... modparam("rtpengine", "url_col", "url_column_name") ...
<varname>weight_col</varname> (string) Column name in the rtpengine table. If database mode is activated (i.e. valid db_url), set the weight of rtp nodes according to this column, on startup. The column value has priority over the URL weight. The MySQL value for this column should be INT UNSIGNED. By default, the column name is "weight". Set <varname>weight_col</varname> parameter ... modparam("rtpengine", "weight_col", "weight_column_name") ...
<varname>disabled_col</varname> (string) Column name in the rtpengine table. If database mode is activated (i.e. valid db_url), set the state of rtp nodes according to this column, on startup. The MySQL value for this column should be INT. By default, the column name is "disabled". Set <varname>disabled_col</varname> parameter ... modparam("rtpengine", "disabled_col", "disabled_column_name") ...
<varname>setid_default</varname> (string) The default set of nodes to be used. By default, the setid is 0. NOTE that if setid_avp is configured, this value will be ignored and the active set will be chosen according to the setid_avp. Set <varname>setid_default</varname> parameter ... modparam("rtpengine", "setid_default", 11) ...
Functions
<function moreinfo="none">set_rtpengine_set(setid[, setid])</function> Sets the ID of the &rtp; proxy set to be used for the next rtpengine_delete(), rtpengine_offer(), rtpengine_answer() or rtpengine_manage() command. The parameter can be an integer or a config variable holding an integer. A second set ID can be specified to daisy-chain two &rtp; proxies. The two set IDs must be distinct from each other and there must not be any overlap in the proxies present in both sets. In this use case, the request (offer, answer, etc) is first sent to an &rtp; proxy from the first set, which rewrites the &sdp; body and sends it back to the module. The rewritten &sdp; body is then used to make another request to an &rtp; proxy from the second set, which rewrites the &sdp; body another time and sends it back to the module to be placed back into the &sip; message. This is useful if you have a set of &rtp; proxies that the caller must use, and another distinct set of &rtp; proxies that the callee must use. This is supported by all rtpengine commands except rtpengine_manage(). This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, BRANCH_ROUTE. <function>set_rtpengine_set</function> usage ... set_rtpengine_set("2"); rtpengine_offer(); ...
<function moreinfo="none">rtpengine_offer([flags])</function> Rewrites &sdp; body to ensure that media is passed through an &rtp; proxy. To be invoked on INVITE for the cases the &sdp; bodies are in INVITE and 200 OK and on 200 OK when &sdp; bodies are in 200 OK and ACK. Meaning of the parameters is as follows: flags - flags to turn on some features. The flags string is a list of space-separated items. Each item is either an individual token, or a token in key=value format. The possible tokens are described below. via-branch=... - Include the branch value of one of the Via headers in the request to the &rtp; proxy. Possible values are: 1 - use the first Via header; 2 - use the second Via header; auto - use the first Via header if this is a request, or the second one if this is a reply; extra - don't take the value from a header, but instead use the value of the extra_id_pv variable. This can be used to create one media session per branch on the &rtp; proxy. When sending a subsequent delete command to the &rtp; proxy, you can then stop just the session for a specific branch when passing the flag '1' or '2' in the rtpengine_delete, or stop all sessions for a call when not passing one of those two flags there. This is especially useful if you have serially forked call scenarios where the &rtp; proxy gets an offer command for a new branch, and then a delete command for the previous branch, which would otherwise delete the full call, breaking the subsequent answer for the new branch. This flag is only supported by the Sipwise rtpengine &rtp; proxy at the moment! asymmetric - flags that UA from which message is received doesn't support symmetric &rtp;. Disables learning of endpoint addresses in the Sipwise rtpengine proxy. force-answer - force answer, that is, only rewrite &sdp; when corresponding session already exists in the &rtp; proxy. By default is on when the session is to be completed. direction=... - this option specifies a logical network interface and should be given exactly twice. It enables &rtp; bridging between different addresses or networks of the same family (e.g. IPv4 to IPv4). The first instance of the option specifies the interface that the originator of this message should be using, while the second instance specifies the interface that the target should be using. For example, if the &sip; message was sent by an endpoint on a private network and will be sent to an endpoint on the public internet, you would use direction=priv direction=pub if those two logical network interfaces were called priv and pub in your &rtp; proxy's configuration respectively. The direction must only be specified in for initial &sdp; offer; answers or subsequent offers can omit this option. internal, external - shorthand for direction=internal and direction=external respectively. Useful for brevity or as legacy option if the &rtp; proxy only supports two network interfaces instead of multiple, arbitrarily named ones. auto-bridge - this flag an alternative to the internal and external flags in order to do automatic bridging between IPv4 on the "internal network" and IPv6 on the "external network". Instead of explicitly instructing the &rtp; proxy to select a particular address family, the distinction is done by the given IP in the &sdp; body by the &rtp; proxy itself. Not supported by Sipwise rtpengine. address-family=... - instructs the &rtp; proxy that the recipient of this &sdp; body expects to see addresses of a particular family. Possible values are IP4 and IP6. For example, if the &sdp; body contains IPv4 addresses but the recipient only speaks IPv6, you would use address-family=IP6 to bridge between the two address families. Sipwise rtpengine remembers the address family preference of each party after it has seen an &sdp; body from them. This means that normally it is only necessary to explicitly specify the address family in the offer, but not in the answer. Note: Please note, that this will only work properly with non-dual-stack user-agents or with dual-stack clients according to RFC6157 (which suggest ICE for Dual-Stack implementations). This short-cut will not work properly with RFC4091 (ANAT) compatible clients, which suggests having different m-lines with different IP-protocols grouped together. force - instructs the &rtp; proxy to ignore marks inserted by another &rtp; proxy in transit to indicate that the session is already goes through another proxy. Allows creating a chain of proxies. Not supported and ignored by Sipwise rtpengine. trust-address - flags that IP address in &sdp; should be trusted. Starting with rtpengine 3.8, this is the default behaviour. In older versions, without this flag the &rtp; proxy ignores the address in the &sdp; and uses source address of the &sip; message as media address which is passed to the &rtp; proxy. SIP-source-address - the opposite of trust-address. Restores the old default behaviour of ignoring endpoint addresses in the &sdp; body. replace-origin - flags that IP from the origin description (o=) should be also changed. replace-session-connection - flags to change the session-level &sdp; connection (c=) IP if media description also includes connection information. symmetric - flags that for the UA from which message is received, support symmetric &rtp; must be forced. Does nothing with the Sipwise rtpengine proxy as it is the default. repacketize=NN - requests the &rtp; proxy to perform re-packetization of &rtp; traffic coming from the UA which has sent the current message to increase or decrease payload size per each &rtp; packet forwarded if possible. The NN is the target payload size in ms, for the most codecs its value should be in 10ms increments, however for some codecs the increment could differ (e.g. 30ms for GSM or 20ms for G.723). The &rtp; proxy would select the closest value supported by the codec. This feature could be used for significantly reducing bandwith overhead for low bitrate codecs, for example with G.729 going from 10ms to 100ms saves two thirds of the network bandwith. Not supported by Sipwise rtpengine. ICE=... - controls the &rtp; proxy's behaviour regarding ICE attributes within the &sdp; body. Possible values are: force - discard any ICE attributes already present in the &sdp; body and then generate and insert new ICE data, leaving itself as the only ICE candidates; force-relay - discard any relay type ICE attributes already present in the &sdp; body and then generate and insert itself as the only ICE relay candidates; remove instructs the &rtp; proxy to discard any ICE attributes and not insert any new ones into the &sdp;. The default (if no ICE=... is given at all), new ICE data will only be generated if no ICE was present in the &sdp; originally; otherwise the &rtp; proxy will only insert itself as additional ICE candidate. Other &sdp; substitutions (c=, m=, etc) are unaffected by this flag. RTP, SRTP, AVP, AVPF - These flags control the &rtp; transport protocol that should be used towards the recipient of the &sdp;. If none of them are specified, the protocol given in the &sdp; is left untouched. Otherwise, the SRTP flag indicates that SRTP should be used, while RTP indicates that SRTP should not be used. AVPF indicates that the advanced RTCP profile with feedback messages should be used, and AVP indicates that the regular RTCP profile should be used. See also the next set of flags below. RTP/AVP, RTP/SAVP, RTP/AVPF, RTP/SAVPF - these serve as an alternative, more explicit way to select between the different &rtp; protocols and profiles supported by the &rtp; proxy. For example, giving the flag RTP/SAVPF has the same effect as giving the two flags SRTP AVPF. to-tag - force inclusion of the To tag. Normally, the To tag is always included when present, except for delete messages. Including the To tag in a delete messages allows you to be more selective about which dialogues within a call are being torn down. rtcp-mux-demux - if rtcp-mux (RFC 5761) was offered, make the &rtp; proxy accept the offer, but not offer it to the recipient of this message. rtcp-mux-reject - if rtcp-mux was offered, make the &rtp; proxy reject the offer, but still offer it to the recipient. Can be combined with rtcp-mux-offer to always offer it. rtcp-mux-offer - make the &rtp; proxy offer rtcp-mux to the recipient of this message, regardless of whether it was offered originally or not. rtcp-mux-accept - if rtcp-mux was offered, make the &rtp; proxy accept the offer and also offer it to the recipient of this message. Can be combined with rtcp-mux-offer to always offer it. media-address=... - force a particular media address to be used in the &sdp; body. Address family is detected automatically. TOS=... - change the IP TOS value for all outgoing &rtp; packets within the entire call in both directions. Only honoured in an offer, ignored for an answer. Valid values are 0 through 255, given in decimal. If this option is not specified, the TOS value will revert to the default TOS (normally 184). A value of -1 may be used to leave the currently used TOS unchanged. delete-delay=... - override the default delay (in seconds) before a call is actually deleted from memory. Can be set to zero to effectuate immediate deletion. This option only makes sense for delete operations. strict-source - instructs the &rtp; proxy to check the source addresses of all incoming &rtp; packets and drop the packets if the address doesn't match. media-handover - the antithesis of strict-source. Instructs the &rtp; proxy not only to accept mismatching &rtp; source addresses (as it normally would), but also to accept them as the new endpoint address of the opposite media flow. Not recommended as it allows media streams to be hijacked by an attacker. DTLS=... - influence the behaviour of DTLS-SRTP. Possible values are no or off to suppress offering or accepting DTLS-SRTP, and passive to prefer participating in DTLS-SRTP in a passive role. SDES-off - don't offer SDES when it normally would. In an SRTP context, this leaves DTLS-SRTP as the only other option. SDES-unencrypted_srtp, SDES-unencrypted_srtcp, SDES-unauthenticated_srtp - these directly reflect the SDES session parameters from RFC 4568 and will make the &rtp; proxy offer these parameters when offering SDES. SDES-encrypted_srtp, SDES-encrypted_srtcp, SDES-authenticated_srtp - the opposites of the flags above. Useful if accepting these parameters is not desired and they should be rejected instead. This function can be used from ANY_ROUTE. <function>rtpengine_offer</function> usage route { ... if (is_method("INVITE")) { if (has_body("application/sdp")) { if (rtpengine_offer()) t_on_reply("1"); } else { t_on_reply("2"); } } if (is_method("ACK") && has_body("application/sdp")) rtpengine_answer(); ... } onreply_route[1] { ... if (has_body("application/sdp")) rtpengine_answer(); ... } onreply_route[2] { ... if (has_body("application/sdp")) rtpengine_offer(); ... }
<function moreinfo="none">rtpengine_answer([flags])</function> Rewrites &sdp; body to ensure that media is passed through an &rtp; proxy. To be invoked on 200 OK for the cases the &sdp; bodies are in INVITE and 200 OK and on ACK when &sdp; bodies are in 200 OK and ACK. See rtpengine_offer() function description above for the meaning of the parameters. This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE, FAILURE_ROUTE, BRANCH_ROUTE. <function>rtpengine_answer</function> usage See rtpengine_offer() function example above for example.
<function moreinfo="none">rtpengine_delete([flags])</function> Tears down the RTPProxy session for the current call. See rtpengine_offer() function description above for the meaning of the parameters. Note that not all flags make sense for a delete. This function can be used from ANY_ROUTE. <function>rtpengine_delete</function> usage ... rtpengine_delete(); ...
<function moreinfo="none">rtpengine_manage([flags])</function> Manage the RTPProxy session - it combines the functionality of rtpengine_offer(), rtpengine_answer() and rtpengine_delete(), detecting internally based on message type and method which one to execute. It can take the same parameters as rtpengine_offer(). The flags parameter to rtpengine_manage() can be a configuration variable containing the flags as a string. Functionality: If INVITE with &sdp;, then do rtpengine_offer() If INVITE with &sdp;, when the tm module is loaded, mark transaction with internal flag FL_SDP_BODY to know that the 1xx and 2xx are for rtpengine_answer() If ACK with &sdp;, then do rtpengine_answer() If BYE or CANCEL, or called within a FAILURE_ROUTE[], then call rtpengine_delete(). Be careful with calling this function after resuming a suspended transaction (e.g., after t_continue()), because the context of executed route is FAILURE ROUTE (in other words, rtpengine_manage() in the route block of t_continue() does the same as in failure_route). If reply to INVITE with code >= 300 do rtpengine_delete() If reply with &sdp; to INVITE having code 1xx and 2xx, then do rtpengine_answer() if the request had &sdp; or tm is not loaded, otherwise do rtpengine_offer() This function can be used from ANY_ROUTE. <function>rtpengine_manage</function> usage ... rtpengine_manage(); ...
<function moreinfo="none">start_recording()</function> This function will send a signal to the &rtp; proxy to record the &rtp; stream on the &rtp; proxy. This function is not supported by Sipwise rtpengine at the moment! This function can be used from REQUEST_ROUTE and ONREPLY_ROUTE. <function>start_recording</function> usage ... start_recording(); ...
Exported Pseudo Variables
<function moreinfo="none">$rtpstat</function> Returns the &rtp; statistics from the &rtp; proxy. The &rtp; statistics from the &rtp; proxy are provided as a string and it does contain several packet counters. The statistics must be retrieved before the session is deleted (before rtpengine_delete()). $rtpstat Usage ... append_hf("X-RTP-Statistics: $rtpstat\r\n"); ...
<acronym>MI</acronym> Commands
<function moreinfo="none">nh_enable_rtpp proxy_url/all 0/1</function> Enables a &rtp; proxy if the second parameter value is greater than 0. Disables it if a zero value is given. The first parameter is either a specific &rtp; proxy url (exactly as defined in the config file) or the keyword all. The second parameter value must be a number in decimal. When try to enable the &rtp; proxy, an application ping command is sent to it. If it fails, the proxy is not enabled. Displays success or fail when try to enable/disable. NOTE: If a &rtp; proxy is defined multiple times (in the same or diferent sets), all of its instances will be enabled/disabled. NOTE: If a &rtp; proxy is in the disabled permanent state and one tries to enable it, even if the ping fails, it is moved to a disabled temporary state and a recheck_ticks are given to it. While the recheck_ticks are grater than 0, the proxy is considered disabled temporary, and it is not taken into consideration for sending data. When the recheck_ticks are 0, the proxy is retested when trying to send data(not automatically retested), and data can be send to it on success. NOTE: When specify the IPv6 &rtp; proxy url one must prefix it with :: to escape the :: from the IPv6 address. See the example below. <function moreinfo="none">nh_enable_rtpp</function> usage ... $ &ctltool; fifo nh_enable_rtpp udp:192.168.2.133:8081 0 $ &ctltool; fifo nh_enable_rtpp ::udp6:fe80::9a90:96ff:fea8:fd99:9999 1 $ &ctltool; fifo nh_enable_rtpp all 1 ...
<function moreinfo="none">nh_show_rtpp proxy_url/all</function> Displays all the &rtp; proxies and their information: set and status (disabled or not, weight and recheck_ticks). If a &rtp; proxy has been disabled by nh_enable_rtpp mi command a "(permanent)" quote will appear when printing the disabled status. This is to differentiate from a temporary disable due to the proxy being not found responsive by kamailio. In addition, when disabled permanent, recheck_ticks have no meaning and "N\A" is printed instead of the value. It takes either a specific &rtp; proxy url (exactly as defined in the config file) or the keyword all as a parameter. NOTE: When specify the IPv6 &rtp; proxy url one must prefix it with :: to escape the :: from the IPv6 address. See the example below. <function moreinfo="none">nh_show_rtpp</function> usage ... $ &ctltool; fifo nh_show_rtpp udp:192.168.2.133:8081 $ &ctltool; fifo nh_show_rtpp ::udp6:fe80::9a90:96ff:fea8:fd99:9999 $ &ctltool; fifo nh_show_rtpp all ...
<function moreinfo="none">nh_ping_rtpp proxy_url/all</function> Sends an application ping command to the &rtp; proxy. If the proxy does not respond, it will be disabled, but not permanent. If the proxy responds, no action is taken. Displays the ping result, i.e. success or fail when try to ping. It takes either a specific &rtp; proxy url (exactly as defined in the config file) or the keyword all as a parameter. NOTE: When specify the IPv6 &rtp; proxy url one must prefix it with :: to escape the :: from the IPv6 address. See the example below. <function moreinfo="none">nh_ping_rtpp</function> usage ... $ &ctltool; fifo nh_ping_rtpp udp:192.168.2.133:8081 $ &ctltool; fifo nh_ping_rtpp ::udp6:fe80::9a90:96ff:fea8:fd99:9999 $ &ctltool; fifo nh_ping_rtpp all ...
<function moreinfo="none">nh_reload_rtpp</function> Reloads the database node table content if configured. Returns specific message related to success, failure and no db_url configured. NOTE: The current behaviour updates the nodes state or creates new ones or hides old ones, based on the database content. If allow_op modparam is enabled, the sessions are still allowed to finish for the hidden old nodes. <function moreinfo="none">nh_reload_rtpp</function> usage ... $ &ctltool; fifo nh_reload_rtpp ...
<function moreinfo="none">nh_show_hash_total</function> Print the total number of hash entries in the hash table at a given moment. <function moreinfo="none">nh_show_hash_total</function> usage ... $ &ctltool; fifo nh_show_hash_total ...