• the module now uses local time instead of UTC time. The former behavior can be restored by enabling use_utc_time.

FRAUD_DETECTION module

• the module uses local time instead of UTC time. The former behavior can be restored by enabling use_utc_time.

• $json_pretty(id) - dumps the JSON in a nice, readable form, by adding spaces and tabs to the output.
• $json_compact(id) - outputs the JSON in a compact manner, avoiding any extra spaces in the output.

• Adapt to the newly added SessionV1 interface, which provides mechanisms to access enhanced CGRateS submodules (such as AttributeS or SuppplierS modules). One can activate each of these new features by setting the $cgr_opt(name) variable.
• Provide a simple mechanism to access the values returned by CGRateS using the $cgr_ret(name) variable. The old $cgrret variable has been deprecated and replaced by the newly added $cgr_ret(name), although when used without a name (i.e. $cgr_ret) it has the same behavior as the old $cgrret).

• add callid, from_tag and to_tag to the E_DLG_STATE_CHANGED event parameters.

• the public_ip parameter of the encode_contact() function now also accepts script variables.

• new modparam, sipping_latency_flag - Enables pinging latency computation (and event raising) for the current Contacts of a received REGISTER.
• new modparam, sipping_ignore_rpl_codes - CSV string containing a series of SIP reply codes which are to be discarded. Useful for usrloc full-sharing topologies, where the location nodes are front-ended by a SIP entity of our own, hence it may reply to contact pings with status codes such as 408 (Request Timeout), which should be ignored.

The subs_phtable_list MI command now includes in its output the Contact and the first proxy from Record-Route as next_hop; also listed subscriptions can be filtered by "From" and "To" URIs.

• new module parameter limit_per_interval that selects if the limit parameter of the rl_check() function is specified per-timer_interval or per-second.

• new lookup() flag, l (Local-only). Only valid within a federated user location cluster. Forces the lookup to result in local contacts only (no additional global branches are added).
• new lookup() flag, yXXXX (Pinging latency filtering). Maximally accepted contact pinging latency (microseconds). Contacts of an AoR with a higher latency will be discarded during the lookup.
• new lookup() flag, Y (Pinging latency sorting). The branches will be created in ascending order of their target contact's last successful ping latency (fastest ping -> slowest ping). This flag may work together with the "y" flag.

• new function rest_init_client_tls() - forces a specific TLS client domain (cert / private key pair) for the next request.

• Provide access to the entire information of a RTPEngine session using the $rtpquery variable
• Provide an easy way to get statistics from a RTP call such as MOS (Mean Opinion Score) value using the $rtpstat(name) variable.

• The new default_set parameter can be used to specify a custom default set, instead of the hardocoded 0.
• The rtpproxy_offer() function can now return the IP and port used by rtpproxy to receive the media.

• provided a way to parse and access ISUP parameters and subfields from an ISUP message contained in a script variable. This can be done via the script transformation {isup.param,param_name,[subfield_name]} directly exported by the module.

• added the media_ip parameter to the siprec_start_recording() function in order to include the "c=" line in the sdp body.

• the sql_cacher_reload MI function can now invalidate all keys when issued in the "on demand" mode when no specific key is passed as parameter.

• new modparam: latency_event_min_us. Denotes a minimal pinging latency threshold (microseconds) beyond which the E_UL_LATENCY_UPDATE will start getting raised.
• new modparam: latency_event_min_us_delta. Denotes a minimal pinging latency difference (microseconds, positive or negative) beyond which the E_UL_LATENCY_UPDATE will start getting raised.

• OpenSIPS will now start even if Redis is unreachable. A new modparam, shutdown_on_error, can be enabled in order to revert to the old behavior.

• new parameters: db_mode, current_info and neighbor_info that add the possibility of dynamically learning the topology of the cluster without needing to provision any node information in a database. Describing at least one neighbor along with its own information is enough for a node to join a cluster.

• Added a node capabilities layer that is used to keep track of the status of the higher-level clustering services (eg. dialog replication) along with the MI command clusterer_list_cap to list them.

• script functions that send/broadcast a "request"-like message: cluster_send_req() / cluster_broadcast_req() or a "reply"-like message: cluster_send_rpl()
• exported events that signal the receival of a request or reply message: E_CLUSTERER_REQ_RECEIVED and E_CLUSTERER_RPL_RECEIVED and provide the message in the event parameters.

• new script function cluster_check_addr() that checks if an IP address belongs to one of the nodes in the cluster.
• Added the ability to dispatch the execution of any MI command to all nodes or a single node in in the cluster with the cluster_send_mi and cluster_broadcast_mi MI commands.

• significant rework of the module in order to fit with even more scenarios. The Path-based insertion support was dropped -- the insertion is now exclusively performed by rewriting Contact URIs, with the option of replacing the Contact username as well, or simply append a ";ctid=" URI parameter. More details in the updated mid_registrar docs.

• significant rework of the module in order to fit with even more scenarios. The Path-based insertion support was dropped -- the insertion is now exclusively performed by rewriting Contact URIs. More details in the updated mid_registrar docs.

• new modparam, sipping_latency_flag - Enables pinging latency computation (and event raising) for the current Contacts of a received REGISTER.

• new function rest_init_client_tls() - forces a specific TLS client domain (cert / private key pair) for the next request.

REST_CLIENT module

• new function rest_client_init_tls() - forces a specific TLS client domain (cert / private key pair) for the next request.

• major clustering additions to the module, featuring a "federated data" topology and two "full mesh" topology variants (OpenSIPS-oriented or NoSQL-oriented). Read this blog post for more details.

NATHELPER module

• new modparam, sipping_latency_bflag - Enables pinging latency computation (and event raising) for the current Contacts of a received REGISTER.
• new modparam, sipping_ignore_rpl_codes - CSV string containing a series of SIP reply codes which are to be discarded. Useful for usrloc full-sharing topologies, where the location nodes are front-ended by a SIP entity of our own, hence it may reply to contact pings with status codes such as 408 (Request Timeout), which should be ignored.

MID_REGISTRAR module

• added restart persistency support. Currently only works with single-instance user location setups.

REGISTRAR module

• new lookup() flag, l (Local-only). Only valid within a federated user location cluster. Forces the lookup to result in local contacts only (no additional global branches are added).
• new lookup() flag, yXXXX (Pinging latency filtering). Maximally accepted contact pinging latency (microseconds). Contacts of an AoR with a higher latency will be discarded during the lookup.
• new lookup() flag, Y (Pinging latency sorting). The branches will be created in ascending order of their target contact's last successful ping latency (fastest ping -> slowest ping). This flag may work together with the "y" flag.

• new event: E_UL_LATENCY_UPDATE. Raised
• new modparam: latency_event_min_us. Denotes a minimal pinging latency threshold (microseconds) beyond which the E_UL_LATENCY_UPDATE will start getting raised.
• new modparam: latency_event_min_us_delta. Denotes a minimal pinging latency difference (microseconds, positive or negative) beyond which the E_UL_LATENCY_UPDATE will start getting raised.

NEW FREESWITCH_SCRIPTING module

FREESWITCH_SCRIPTING is a new module that provides the ability to subscribe to arbitrary FreeSWITCH ESL events and receive/manipulate them inside the OpenSIPS script. It also allows the script writer to run arbitrary FreeSWITCH ESL commands. Read this blog post for detailed explanations.

FREESWITCH module

• new modparams for fine-grained control over the ESL interaction.

• if DBG_MALLOC is enabled and you forgot to set the memdump and/or memlog levels, you may still extract a memory dump without restarting OpenSIPS by temporarily dropping OpenSIPS to "log_level = 14" and "log_level = 15" respectively, perform the dump, then restore the logging back to its original state.

Memory manager

• auto-recovery from "double pointer free" errors in production environments
• improved error reporting in "out of memory" situations
• if DBG_MALLOC is enabled and you forgot to enable memdump and/or memlog, you may still extract a memory dump without restarting OpenSIPS by temporarily setting debugging levels to "log_level = 14" and "log_level = 15" respectively, perform the dump, then restore the logging back to original

• extended multi-line strings, allowing for more readable code such as in this example

• more multi-line strings, allowing for more readable code, such as:

avp_db_query("
    SELECT
        table_name,
        table_version
    FROM
        version",
    "$avp(tn),
    $avp(tv)");

• script functions that send/broadcast a "request"-like message: cluster_send_req() / cluster_broadcast_req() or a "reply"-like message: cluster_send_rpl()

• new script function cluster_check_addr() that checks if an IP address belongs to one of the nodes in the cluster.

• Added a new column to the clusterer table, flags that can be set to the value "seed" in order to bootstrap the data sync'ing in the cluster.

• Added support for proper dialog distribution required in scenarios like Active-Backup, Active-Active or Anycast setups. This roughly consists of the following features: data synchronization at OpenSIPS startup(or runtime if required) and dialog "ownership" and coordination of nodes in terms of taking actions on dialogs. More details can be found in this article.

MANGLER module

• the public_ip parameter of the encode_contact() function now also accepts script variables.

RATELIMIT module

• new module parameter limit_per_interval that selects if the limit parameter of the rl_check() function is specified per-timer_interval or per-second.

SIPREC module

• added the media_ip parameter to the siprec_start_recording() function in order to include the "c=" line in the sdp body.
• added the "t=0 0" line in the SDP body.
• allow custom XML values for the caller and callee parameters of siprec_start_recording() function.

SQL_CACHER module

• the sql_cacher_reload MI function can now invalidate all keys when issued in the "on demand" mode when no specific key is passed as parameter.

For a detailed description of those scenarios, please refer to the this blog post.
The subs_phtable_list MI command now includes in its output the Contact and the first proxy from Record-Route as next_hop; also listed subscriptions can be filtered by "From" and "To" URIs.

• provided a way to parse and access ISUP parameters and subfields from an ISUP message contained in a script variable. This can be done via the script transformation {isup.param,param_name,[subfield_name]} directly exported by the module.

• Added support for proper dialog distribution required in scenarios like Active-Active, Active-Backup and Anycast setups. This includes features like data synchronization at startup or dialog ownership and actions coordination. More details can be found in this article.

• script functions that send/broadcast a "request"-like message: cluster_send_req()/cluster_broadcast_req() or a "reply"-like message: cluster_send_rpl()

DIALOG module

• accept script variables for the profile parameter of the is_in_profile(), get_profile_size(), set_dlg_profile() and unset_dlg_profile() functions.
• add callid, from_tag and to_tag to the E_DLG_STATE_CHANGED event parameters.

• Added a node capabilities layer that is used to keep track of the status of the higher-level clustering services (eg. dialog replication) along with the MI command clusterer_list_cap to list them.

• script functions that send/broadcast a "request"-like message: cluster_send_req/cluster_broadcast_req or a "reply"-like message: cluster_send_rpl
• exported events that signal the receival of a request or reply message: E_CLUSTERER_REQ_RECEIVED and E_CLUSTERER_RPL_RECEIVED and provide the message in the event parameters.

• Added the ability to dispatch the execution of any MI command to all nodes or a single node in in the cluster with the cluster_send_mi and cluster_broadcast_mi MI commands.

• new script function cluster_check_addr that checks if an IP address belongs to one of the nodes in the cluster.

• Introduced a generic way of cluster communication directly at script level. This can be achieved using:
  • script functions that send/broadcast a "request"-like message: cluster_send_req/cluster_broadcast_req or a "reply"-like message: cluster_send_rpl.

• Added a new column to the clusterer table, flags that can be set to the value seed in order to bootstrap the data sync'ing in the cluster.

• The internal topology, in terms of the state of the links between nodes, was enhanced by advertising and keeping a bidirectional representation. This improves the topology consistency and convergence.
• Added a node capabilities layer that is used to keep track of the status of the higher-level clustering services (eg. dialog replication).
• Added a mechanism that allows modules that use the clustering API to perform data synchronization from an eligible node based on the capabilities layer.

CLUSTERER module

• The topology establishing mechanism no longer requires any fields in the DB for persistency(removed ls_seq_no and top_seq_no).
• new parameters: db_mode, current_info and neighbor_info that add the possibility of dynamically learning the topology of the cluster without needing to provision any node information in a database. Describing at least one neighbor along with its own information is enough for a node to join a cluster.

• you can now mark an interface as an anycast interface using the anycast keyword - doing so, the tm module will automatically detect replies that are not destined to the current OpenSIPS instance and will handle them accordingly.
• script transformations now accept NULL as input and also return NULL instead of empty string for unsuccessful operation or errors. This allows a more cleaner way of chaining transformations and checking the final result.

JSONRPC is a new module in OpenSIPS 2.4 that provides functions to run JSON-RPC commands on a remote JSON-RPC server, and retrieve the call's response back.

NEW EVENT_JSONRPC module

The new EVENT_JSONRPC module in OpenSIPS 2.4 implements a transport protocol for the OpenSIPS Event Interface. Using this module, you can notify applications about OpenSIPS internal events using the JSON-RPC protocol.

NEW JSONRPC module

JSONRPC is a new module in OpenSIPS 2.4 that provides functions to run JSON-RPC commands on a remote JSON-RPC server, and retrieve the response back.

• you can now mark an interface as an anycast interface using the anycast keyword - doing so, the tm module will automatically detect replies that are not destined to the current OpenSIPS instance and will handle them accordingly.

• Added support for handling transactions in a distributed environment, with multiple active-active servers, such as ANYCAST setups. Read more about the Full Anycast support on our blog.

• Provide a simple mechanism to access the values returned by CGRateS using the $cgr_ret(name) variable. The old $cgrret variable has been deprecated and replaced by the newly added $cgr_ret(name), although when used without a name (i.e. $cgr_ret) it has the same behavior as the old $cgrret).

• Adapt with the latest transcoding features added in rtpengine.
• Provide access to the entire information of a RTPEngine session using the $rtpquery variable
• Provide an easy way to get statistics from a RTP call such as MOS (Mean Opinion Score) value using the $rtpstat(name) variable.
• Make the RTPEngine provisioning more flexible by adding database support for specifying rtpengine sockets.

CGRateS module

• Adapt to the newly added SessionV1 interface, which provides mechanisms to access enhanced CGRateS submodules (such as AttributeS or SuppplierS modules). One can activate each of these new features by setting the $cgr_opt(name) variable.
• Provide a simple mechanism to access the values returned by CGRateS using the $cgr_ret(name) variable.

• The rtpproxy_offer() function can now return the IP and port used by rtpproxy to receive the media.

• OpenSIPS can now be configured to listen for a specific protocol on any interface, including IPv6, using the * token (i.e. listen = udp:*:5060 will bind all available IPs on port 5060)

• OpenSIPS can now be configured to listen for a specific protocol on any interface using the * token (i.e. listen = udp:*:5060 will bind all available IPs on port 5060)

• The new default_set parameter can be used to specify a custom default set, instead of the hardocoded 0.

NEW SIPREC module

The new SIPREC module in OpenSIPS 2.4 provides the means to do call recording to an external recorder using the SIPREC standard.

• "-f -" was introduced for reading the config file via stdin instead from a file.

• old keywords were dropped (src_ip, dst_ip, src_port, dst_port, uri, from_uri, to_uri, method, status, myself, proto and msg:len)

SIPTRACE module

The tracing capabilities were extended in order to capture the following SIP messages which were not traced so far:

• 100 trying generated by OpenSIPS
• incoming ACK for negative replies
• outgoing ACK to negative replies
• incoming replies to CANCEL requests
• incoming request retransmissions
• outgoing request retransmissions
• outgoing reply retransmissions

SIP Parser

• the "To" like headers (like PPI or PAI) are now properly parsed as multi-value (comma separated) name-addr/addr-spec headers

DNS_CACHE module

• proper handling of TTL 0 in DNS answers. RFC1035 states that "zero TTL values are interpreted to mean that the RR can only be used for the transaction in progress, and should not be cached".

• a new extra field attr provided by the E_UL_CONTACT_INSERT event

InterProcess Communication (IPC) support

• added the job dispatching capability - to send an internal job to be executed/handled by any available process (kind of a pseudo load-balancing of the internal jobs among the processes). The FreeSWITCH module is using this in order to execute the incoming FS events in any idle process.
• added Remote Procedure Call (RPC) support via IPC - a process can trigger the execution of a function in a different process. This is used by the TCP core to "externalize" the execution of its functions responsible for generating statistics.
• shutdown sequence is now implemented via RPC - the attendant/main process executes in all IPC aware processes a terminate function. This leads to a controlled process termination versus the old brutal approach based on simply killing the processes. Such killing may result in an inconsistent state of the shared resources and even more in a failed shutdown process with lost data. For the future, a per-process cleanup handler may be exported by each module.

• Added support for Content-Disposition: no-cancel by forcing the "0x10" flag in t_relay() - as per RFC3841, section 9.1, the TM module may be instructed not to cancel all ongoing branches when a 2xx reply is received. It will keep the pending branches ongoing until (1) all branches will receive a final reply or (2) the transaction hits the timeout. This is work sponsored by Harris Corporation (https://www.harris.com).

TM module

• Added support for Content-Disposition: no-cancel by forcing the "0x10" flag in t_relay() - as per RFC3841, section 9.1, the TM module may be instructed not to cancel all ongoing branches when a 2xx reply is received. It will keep the pending branches ongoing until (1) all branches will receive a final reply or (2) the transaction hits the timeout.

USRLOC module

• migrate the "expires" column from DATETIME to INT. Instead of keeping the expires value as DATETIME, better keep it as UNIX timestamp in order to avoid any impact due TZ and DST changes.

DB interface

• added the escaping/encoding of unsupported characters inside a DB URL. Using %xy hexa encoding, you can push any sort of characters in key fields of the URL as username and password.

SIP_I module

• added the ability to push custom headers in body parts via the default_part_headers module parameter or as an optional extra parameter to add_isup_part([isup_msg_type][,extra_headers]) function - this is very useful for managing the "Content-Disposition" header per body part.

SIPMSGOPS module

• added the ability to push custom headers in body parts as an option extra parameter to add_body_part(body,mime[,headers])' function - this is very useful for managing the "Content-Disposition" header per body part.

"Load" statistics

OpenSIPS 2.4 comes with a complete re-design of the statistics that gives information about the OpenSIPS internal load. The load is defined as percentage of time spent in doing processing versus total time. Following the model of "top", there are three load values, calculated over different periods of time:

OpenSIPS core

"Load" statistics class reworked - the statistics giving information about the OpenSIPS internal load. The load is defined as percentage of time spent in doing processing versus total time. Following the model of "top", there are three load values, calculated over different periods of time:

• realtime load - calculated over the last 1 second
• last minute load - calculated over the last 1 minute
• last 10 minutes load - calculated over the last 10 minutes

The new load class overs a more granular access to the load information:

• load per process
• load per OpenSIPS core (covering only core/SIP processes)
• load per entire OpenSIPS (covering all processes, core and modules)

Find the full list of available load statistics (and their description) here.

PRESENCE module

Added clustering capabilities in terms of full data sharing or/and federated clusters. The clustering support allows the presence node to share data between them (full sharing versus data partitioning with replication) and to synchronize/coordinate the nodes in terms of taking actions over data (broadcast & querying over the cluster, tag sharing).
The clustering support enabled several scenarios:

• active - backup High Availability
• multi-active Load Balancing
• multi-active Federation (partitioning)
• mix between HA and Federation scenarios

For a detailed description of those scenarios, please refer to the this blog post.

JSON module

• Two new variables that control the way the JSON object is printed as string have been added:
  • $json_pretty(id) - dumps the JSON in a nice, readable form, by adding spaces and tabs to the output.
  • $json_compact(id) - outputs the JSON in a compact manner, avoiding any extra spaces in the output.

CACHEDB_REDIS module

• OpenSIPS will now start even if Redis is unreachable. A new modparam, shutdown_on_error, can be enabled in order to revert to the old behavior.

SIPREC module

• The new SIPREC module in OpenSIPS 2.4 provides the means to do call recording to an external recorder using the SIPREC standard.

CACHEDB_REDIS module

• OpenSIPS will now start even if Redis is unreachable. A new modparam, shutdown_on_error, can be enabled in order to revert to the old behavior.

• any script variable now supports comparison via the '==' and '!=' logical operators with IP addresses and netmasks (eg. $var(ip) == 10.10.0.0/24). This tests whether the IP address in the variable matches the subnet given in the expression.

• any script variable now supports comparison via the '==' and '!=' logical operators with IP addresses and netmasks (eg. $var(ip) == 10.10.0.0/24). This tests weather the IP address in the variable matches the subnet given in the expression.

OpenSIPS script

• new core function is_myself that tests if a host is a local address that OpenSIPS listens on
• new core variable $af that returns the address family (IPv6 or IPv4) of the received SIP message
• any script variable supports comparison via the '==' and '!=' logical operators with IP addresses and subnet masks (eg. $var(ip) == 10.10.0.0/24). This tests weather the IP address in the variable is equal to the IP in the right operand (in case no subnet mask or '/32' is used) or matches the subnet of the given right operand.

• "-f -" config file via stdin

RTPPROXY module

• The rtpproxy module can now instruct the RTPProxy server to duplicate the stream RTP to a remote destination.

RTPENGINE module

• The rtpengine has support for two new parameters: in-iface and out-iface that can be used to specify which listening interface rtpengine should advertise when running in bridge mode.

TBA

• TBA

TBA

Migration from 2.3.x to 2.4.0

• TBA

• TBA

Migration from 2.2.x to 2.4.0?

• support for armv6 and armv7 locking
• support for fast-locks on mips and mips64el architectures
• support for native umutex in freebsd
• added a new statistic for the SHM memory groups that prints the maximum memory used of a group
• added content-aware body (multi-part) changing - this allows parsing and modification of the body via the "body parts" list; parts can be modified (with function or lumps), can be deleted and new ones can be added. Any type of modification (and any of them) is allowed. The body is completely rebuild based on the resulting list of body parts. Also we support transparent transitions from no body to body, single part body to multi-part body or the other way around - with automatic update of the Content-Type and Content-Len headers, of course.
• major rework of body and SDP parsing - unified and consistent way of parsing and accessing the body parts (single or multi part body). This results in a transparent way of parsing and freeing the parts content (like SDP or ISUP).
• address potential starvation for the timer tasks - even if the timer tasks have priority in the asyns reactor (for being handled), if all the worker processes are already busy in handling some SIP tasks which takes too long, may lead into a starvation of the timer tasks. For the moment we address this by creating a extra worker processes (similar to the SIP workers) which is dedicated to executing the timer tasks. Still, based on their availability and load, the SIP workers are able to consume timer tasks.
• added the first basic version of an IPC support - this is an internal mechanism that allows any process to pass a job to another process. the IPC support is internally used by the Event Routing module and by the TCP stack. In the next version, more custom existing inter-process communication will be migrated to this generic IPC support. Also, the IPC mechanism opens new possibilities when comes to improvements or creation of new features.

• new $xlog_level core pseudo-variable that prints the level of message printed at syslog
• new custom index append for $avp variables to allow you to add new values at the end of the list (at the bottom of the stack) - $(avp(name)[append]) = "last value";
• $rb can now take as name a mime, in order to access the body parts by mime : $rb(application/sdp) - get the first SDP body part ; $(rb(application/isup)[-1]) - get the last ISUP body part
• the the xlog messages include now the time and process ID when printing to stderr (to be consistent with the syslog logging)

Async layer

• new launch() statement to starts a function/job in async mode and continue the script immediately, without waiting for the job to be terminated. A "report" route may be triggered (outside the context of the msg launching the job) when the job is terminated to be able to access the return code and the possible returned data. See for more.
• new internal (non-scripting) support for async I/O operations - internal functions can register FDs into the reactor in order to be triggered when data is available (and run a handler). For example this is internally used by the cgrates module in order to handle its communication with the external cgrates engine
• enhanced the ASYNC API to allows resume via non-FD events (outside I/O reactor scope) ; The resume/suspect logic is reused, but the waiting and triggering can now by done via other means (like event based) rather than being I/O reactor based.

OpenSIPS Enhanced tracing

Starting with this versions multiple events can be traced, other than sip packets. There are two types of events:

• events that take place when a certain type of SIP packet is processed, events happening in a '''sip context that can be controlled using siptrace module;
• events that don't take place in a sip context that are controlled directly via proto_hep module;

At the moment, OpenSIPS 2.4 supports tracing for the following sip context events:

• xlog messages;
• rest_client module queries ( requests and replies );

These events are controlled via sip_trace function which was enhanced with a new parameter through which one can specify which of these events shall be traced. All these events will be traced in the sip context that is given to the function, that is if rest tracing is activated for a dialog, all rest requests and replies that will occur for that dialog shall be traced. The following non sip events can be traced:

• transport layer events( currently available for TCP, TLS, WS and WSS transport layers;
• mi commands ( all mi protocols are available );

For these types of events the hep ids defined directly in proto_hep module, since there is no sip context( see mi_fifo exmaple). For the mi commands there is the posibilty to define blacklists or whitlists of commands to be traced in order to avoid tracing commands that are not useful( see mi_fifo example ). For transport layer protocols the unit we are working with is a connection. All protocol events such as connect or accept events, connection closed events for TCP, certificate information and master key for TLS and WSS and http request and reply used during the handshake for WS and WSS. Tracing can be activated via MI ( WSS example ) and the connections that will be traced can be controlled via a filter route in which users will ses source and destination IPs and ports for that connection ( WSS example ).

CGRATES module (new)

• the cgrates module provides an interface to the CGRateS rating eninge. Using this module you can do multi-tenant prepaid and postpaid billing in the OpenSIPS script. Read more information here.

EVENT ROUTING module (new)

• The Event (based) Routing module, or shortly the EBR module, provides a mechanism that allows different SIP processings (of messages in script) to communicate and synchronize between through OpenSIPS Events.
• This mechanism is based on the Subscribe-Notify concept. Any SIP processing may subscribe to various OpenSIPS Events Upon Event raising, the subscriber will be notified, so it will be able to make use of the data attached to the Event. Note that the Event raising may take place in a completely different SIP processing context, completely unrelated to the subscriber processing.
• The EBR support allows implementation of more advanced SIP scenarios like Push Notification or Call Pickup

FREESWITCH module (new)

• the freeswitch module acts as a connection manager for FreeSWITCH Event Socket Layer sockets. It currently provides dynamic statistics from FreeSWITCH in order to update routing behavior for the dispatcher and load_balancer modules.

SIP_I module (new)

• the SIP-I module provides SIP-I to SIP gatewaying and ISUP awarness by offering the possibility of processing ISDN User Part(ISUP) messages encapsulated in SIP. The available operations are: reading and modifying parameters from an ISUP message, removing or adding new optional parameters, adding an ISUP part to a SIP message body. This is done explicitly via script variables and functions. The supported ISUP message types are only the ones that can be included in a SIP message according to the SIP-I(SIP with encapsulated ISUP) protocol defined by ITU-T.

MID_REGISTRAR module (new)

• the mid_registrar enables a series of scenarios in which OpenSIPS acts as a SIP registration front-end. This novel SIP platform component is able to throttle down SIP registration traffic rates on the way to existing farms of SIP registrars, by extending contact expiration intervals. Moreover, it can also be configured to take over all parallel forking duties for these existing SIP infrastructures.

RABBITMQ module (new)

• a new RabbitMQ module provides a more flexible and easy to use interface to a RabbitMQ server. Check out more!

XML module (new)

• the XML module allows the processing of XML documents from the script by exposing a variable that provides access to the elements and their contents and attributes. In this way you can modify, add or remove nodes in the XML tree.

• diameter support has been removed;
• extra variables engine was reworked(including both extra and leg engine); *_extra and *_extra_bye parameters have been replaced with extra_fields with which you can define tags to be used in the script using acc_extra script variable; the variable can be set/modified until the accounting is being made;
• leg variables engine was also reworked; now you can define leg variables for each of the available backends(log, db, aaa, evi); the modparam section is the same as for the extra_fields parameter whereas in the script you can use acc_leg variable to set the leg values; the variable can be indexed with the index of the leg; it accepts both positive index(0 is the first leg) and negative indexes(-1 is the last leg);
• the leg accounting engine is not based anymore on AVPs; each time you want to create a new leg you have to call acc_new_leg function which will create a new leg for you; the value of the last leg shall be accessed with acc_current_leg variable;
• for further information read the docs

Call Center module

• new queue_pos_param module paramter to report the queue position - the parameter value is the name of an SIP URI parameter to be used to report the position in the waiting queue when sending the call to media server for onwait/queue playback. The position 0 means it is the next call to be delivered to an agent.

Clusterer module

• the module was reworked and enhanced in order to provide a better node availability detection mechanism and inter-cluster routing of BIN messages (if the link between nodes A and B is down the message might be routed through node C). As there were no explicit probes at the clusterer module level, an active pinging mechanism was introduced which establishes the state of the connections of the current node with other nodes in the cluster at BIN interface level. Based on this, a link-state resembling protocol was implemented in order to learn the cluster topology and compute a routing 'table' used for sending BIN messages between nodes. Also the possibility of adding new nodes to the cluster without additional provisioning for the existing components was introduced.
• new module parameters for tweaking the probing mechanism:
  • ping_interval - the interval in seconds between regular pings sent to a neighbour node
  • ping_timeout - the time in milliseconds to wait for a reply to a previously sent ping before retrying or considering the link with the neighbour node down. This is also the interval between successive retries if the send fails.
  • node_timeout - the time in seconds to wait before pinging is restarted for a failed node
• the module's *_col parameters were changed to reflect the modified DB column names
• the MI command clusterer_list now lists information about the other nodes in the cluster from the current node's perspective
• new MI command clusterer_list_topology that lists the cluster's topology from the current node's perspective as an adjacency list
• for further information read the module documentation

DB MYSQL module

• new tls_client_domain module parameter - Quickly enable TLS usage for a given MySQL backend

Dialog module

• the dlg_list and dlg_end_dlg MI commands are now also using (display and accept) the dialog ID as dialog identifier - this is a single unique numerical ID ; Still, the h_label and h_id are accepted as old way to identify the dialogs.
• added new script function get_dialog_vals() for fetching all the values of a dialog found by callid string. The dialog values are returned as a parallel arrays of names and values.

Dispatcher module

• the module now supports dynamically calculated weights for FreeSWITCH destinations! As such:
  • the weight column type is now "string", as it can hold either an integer weight or a FreeSWITCH ESL socket. However, OpenSIPS still retains internal backwards-compatibility with the previous schema
  • fetch_freeswitch_stats - enables the dynamic weight calculation engine
  • max_freeswitch_weight - control the maximum weight of a FreeSWITCH destination computed using its runtime resource usage
• the round-robin algorithm now supports weights - each destination is chosen until its count reaches the weight, and only then moves to a different destination.
• new module parameter ds_ping_maxfwd - this parameter allows you to set a custom value for inserted Max-Forward header in the SIP ping requests generated by dispatcher module. If not used, it will let TM to add a default value.

• the do_routing() accepts now any kind of variable for the routing group parameter; previously this was limited to AVP variables.
• added support for replicating the gateways and carrier status (upon changes) to other OpenSIPS nodes inside a cluster (using the clusterer module and BIN interface). New control parameters were added:
  • replicate_status_to - the cluster ID for replication pool
  • accept_replicated_status - the cluster ID for accepting incoming replication data

Cachedb_local module

• in previous versions the module had only one "database"(one hash); now multiple such databases can be defined, each of these representing an unique collection having it's own set of keys and values;
• the collections can be defined using cache_collections module parameter;
• each collection should be assigned to a cachedb_url; same collection can be assign to multiple cachedb_urls;
• for more information check the official documentation

Load Balancer module

• the module now supports dynamically calculated max resource values for FreeSWITCH destinations! As such:
  • resources may also be provisioned with a FreeSWITCH ESL socket URL as "max value" apart from an integer, as shown here
  • fetch_freeswitch_stats - enables the runtime max resource value calculation engine
  • initial_freeswitch_load - the starting "max resource" value, until the first batch of statistics arrive from FreeSWITCH
• preserve destination's status during reload - preserve the status (enabled or not) of the destinations during a data reload from DB.
• more detailed return code for functions starting/continuing the LB process. In case of LB failure, the ret code may be:
  • -1 generic internal error
  • -2 no capacity left
  • -3 no available destinations
  • -4 bad resources
• added support for replicating the destination status (upon changes) to other OpenSIPS nodes inside a cluster (using the clusterer module and BIN interface). New control parameters were added:
  • replicate_status_to - the cluster ID for replication pool
  • accept_replicated_status - the cluster ID for accepting incoming replication data

MI FIFO module

• trace mi datagram requests
  • command
  • parameters
  • module name
• and replies
  • code
  • reason
  • part of the reply message
• see official documentation;
• add blacklists/whitelists for traced mi commands (see official documentation);

MI HTTP module

• trace mi datagram requests:
  • command;
  • parameters;
  • module name;
• and replies:
  • code;
  • reason;
  • part of the reply message;
• for more information check the official documentation;
• add blacklists/whitelists for traced mi commands (see official documentation);

MI JSON module

• trace mi datagram requests:
  • command;
  • parameters;
  • module name;
• and replies:
  • code;
  • reason;
  • part of the reply message;
• for more information check the official documentation;
• add blacklists/whitelists for traced mi commands (see official documentation);

MI XMLRPC NG module

• trace mi datagram requests:
  • command;
  • parameters;
  • module name;
• and replies:
  • code;
  • reason;
  • part of the reply message;
• for more information check the official documentation;
• add blacklists/whitelists for traced mi commands (see official documentation);

MI DATAGRAM module

• trace mi datagram requests:
  • command;
  • parameters;
  • module name;
• and replies:
  • code;
  • reason;
  • part of the reply message;
• for more information check the official documentation;
• add blacklists/whitelists for traced mi commands (see official documentation);

• Support for SUBSCRIBE/NOTIFY CNAM;
• Updated for OSP Toolkit 4.12.0 (see official documentation for more information).

PRESENCE module

• New E_PRESENCE_EXPOSED event that can be triggered over the MI interface and simulates the receiving of a PUBLISH message (see documentation);

PROTO HEP module

• be able to define hep destinations ( called hep ids ) that will be used by other modules;
• message payloads are now encapsulated using JSON format;
• new extra_correlation chunk used for correlating different types of messages( such as sip with xlog or rest, or transport messages with sip messages);

PROTO TCP module

• enable tracing for TCP connection events ( information about all accepted and created connections and information concerning closed connections );
• new trace_destination module parameter to define tracing destination;
• new trace_on module parameter to set tracing on and off at startup;
• new trace_filter_route module parameter to define a route which can be used for filtering traced connections;
• new tcp_trace mi function to control tracing ( on/off switch );

PROTO TLS module

• enable tracing for TLS connection events ( trace certificate info, master key along with information about all accepted and created connections and information concerning closed connections);
• new trace_destination module parameter to define tracing destination;
• new trace_on module parameter to set tracing on and off at startup;
• new trace_filter_route module parameter to define a route which can be used for filtering traced connections;
• new tls_trace mi function to control tracing ( on/off switch );

PROTO WS module

• enable tracing for WS connection events ( http request and reply used in web socket handshake along with information about all accepted and created connections and information concerning closed connections);
• new trace_destination module parameter to define tracing destination;
• new trace_on module parameter to set tracing on and off at startup;
• new trace_filter_route module parameter to define a route which can be used for filtering traced connections;
• new ws_trace mi function to control tracing ( on/off switch );

PROTO WSS module

• enable tracing for WSS connection events ( http request and reply used in web socket handshake, certificate info, master key along with information about all accepted and created connections and information concerning closed connections);
• new trace_destination module parameter to define tracing destination;
• new trace_on module parameter to set tracing on and off at startup;
• new trace_filter_route module parameter to define a route which can be used for filtering traced connections;
• new wss_trace mi function to control tracing ( on/off switch );

Registrar module

• the obsolete functions registered() and is_other_contact() finally removed. You should we their replacements 'is_registered() and is_ip_registered().

REST client module

• Connection reusage support added for all synchronous requests (see commit 79d02f379
• new connect_poll_interval module parameter - Allows complete control over how quickly we want to detect libcurl's completed TCP handshakes.
• new max_async_transfers module parameter - Maximum number of asynchronous HTTP transfers a single OpenSIPS worker is allowed to run simultaneously.
• new rest_put() script function, including async support (see commit c4807008b)
• ability to trace HTTP traffic using the sip_trace() function from siptrace module

RTPProxy module

• add support to specify RTPProxy to record both streams in a single file;
• add support for the latest notification mechanism in the RTPProxy master branch;
• add new rtpproxy_stats command that returns statistics about the call, such as packet loss, messages received from each side, etc.;
• add new rtpproxy_all_stats command that returns advanced statistics about the call, such as SSRC changes. This is only available in the RTPProxy master branch.
• add support for mangling RTP session TTL for both caller and callee.

RTPEngine module

• pass the flags from the rtpengine_offer/answer() functions to rtpengine, even though they are not known by OpenSIPS - loose the flags check restrictions to relax integration with further extensions.
• add new sock_pvar parameter to all rtpengine_* functions that can be used to return the rtpengine socket used for that call;
• add new sdp_pvar parameter to rtpengine_offer/answer/manage() functions that will store the SDP returned by rtpengine - Note that if you store the SDP body in a pvar, it will not be reflected in the outgoing message automatically, you will have to do it manually.
• added new teardown MI command as alias to dlg_end_dlg from dialog module

SIPMSGOPS module

• following the work on the multi-part body support, the following functions has changed in the module:
  • old filter_body() and strip_body() functions merged under the new remove_body_part() function
  • old has_body() function (not yet removed) is replaced by the new has_body_part() function
  • old add_body() function removed and replaced by the new add_body_part() function

• use hep ids defined in proto_hep instead of defining the hep ids in siptrace using trace_id module parameter;
• allow tracing multiple types of events(xlog messages, rest HTTP requests and replies) using sip_trace function;

STATISTICS module

• add support for statistic groups and easy iteration over them in the OpenSIPS script. New control module parameters:
  • stat_groups - define the statistic groups before startup
  • stat_iter_init() - begin iteration over the statistics contained within a group
  • stat_iter_next() - fetch the current statistic, move on to the next one if possible
• allow stats to be updated via variables - the update_stat() function accepts variables for passing the update value.

TOPOLOGY HIDING module

• new D flag of the topology_hiding() function forces the insertion of the dialog ID (DID) into the Contact Username, rather than Contact URI parameters (as before).

• Added support for dynamic branch manipulation - new functions were added to allow remote injecting of new branches into an ongoing transaction:
  • t_inject_branches(source, flags) - injects new branches;
  • t_wait_for_new_branches() - instruct the transaction to wait more (even if all current branches are completed) for possible new branch injections.
• new script variable $T_id to expose the transaction internal ID as an opaque hexa string.
• new t_add_cancel_reason() script function to allow the insertion of a custom Reason header into a CANCEL request.

TLS MGM module

• support for the latest OpenSSL library version 1.1.0;
• for all module parameters accepting a TLS domain ID in their value, the syntax was changed : "tls_dom:value" was replaced with "[tls_dom]value", to avoid any conflicts between the separator and the actual value.
• 'full DB support added - instead of storing in DB the file path for certificate, private key, CA list and DH params, the DB holds the actual data (as BLOB). So, the TLS configuration is 100% DB driven, no files needed any more.

• The E_UL_CONTACT_INSERT, E_UL_CONTACT_UPDATE and E_UL_CONTACT_DELETE events have now more attributes (full set to describe the contact):
  • path string
  • q value
  • socket description
  • branch flags
  • expires
  • uri as former "address"
• when listing contact records via MI command, the Contact ID is also printed (this helps with correlating the in-memory records with the DB records)

CLUSTERER module (new)

• The new clusterer allows you to group multiple OpenSIPS nodes in a cluster in order to share the same information in your entire platform. This module can be used by the dialog module to replicate dialog profiles to other nodes, or by the usrloc module to share contact information across multiple nodes.

• The new clusterer allows you to group multiple OpenSIPS nodes in a cluster in order to share the same information in your entire platform. This module can be used by the dialog module to replicate dialog profiles to other nodes, or by the usrloc module to share contact information across multiple nodes.

PROTO_WSS module (new)

The Secure WebScoket module allows HTTPS enabled browsers to make or receive VoIP calls using the WebSocket protocol through a secure, TLS encrypted channel.

PROTO_WS module

• The WebSocket protocol module has been added client support. This allows OpenSIPS to connect to a different WebSocket server and relay SIP messages towards it.

NET_TCP module

PROTO_TLS module

• fix the CRLF ping-pong regression by adding the new module parameters tls_crlf_pingpong and tls_crlf_drop
• new tls_max_msg_chunks parameter - the maximum number of chunks that a SIP message is expected to arrive via TLS.

NET_TCP module

• tcp_accept_aliases is now by default set to on/enabled

EMERGENCY module

• added support for subscriber / notify functions.

DIALPLAN module

• new dp_show_partiton MI command to list all the details on the defined partitions.

EVENT_FLATSTORE module (new)

The module provides a logging facility for different events, triggered through the OpenSIPS Event Interface, directly from the OpenSIPS script. The module logs the events along with their parameters in regular text files.

• new xlog_default_level parameter to configure the default logging level for all xlog() prints.

DB_MYSQL

• new parameter max_db_queries to define how many time a DB query should be retried.
• new parameter max_db_retries to define how many attempts should be perform in setting the DB connection.

DB_POSTGRES

• new parameter max_db_queries to define how many time a DB query should be retried.

WS module

• The WebSocket protocol module has been added client support. This allows OpenSIPS to connect to a different WebSocket server and relay SIP messages towards it.

CACHEDB_REDIS

• the connect_timeout parameter has been added to control the connection time to a Redis server. This prevents OpenSIPS from blocking indefinitely until the Redis server times out.

• support for locking debugging - compile with DBG_LOCK (from menuconfig for example) and each lock will stored information regarding the place from where the lock was acquired (file, function, line) - this is useful when debugging deadlocks.

• debug MI command was renamed to log_level (same functionality, input and output)

• debug global parameter was renamed to log_level global parameter (same behavior and values)

• mi_xmlrpc_ng_root module parameter was renamed to http_root

CLUSTERER module

• The new clusterer allows you to group multiple OpenSIPS nodes in a cluster in order to share the same information in your entire platform.

• integrated with the clusterer module for pipes sharing. The sharing is not done anymore via a NoSQL database, but directly between OpenSIPS instances (via BIN protocol encapsulated in Clusterer module). New parameters were added to control the clustering : replicate_pipes_to(the cluster ID where to to share the pipes), accept_pipes_from(the cluster ID of the incoming sharing traffic), accept_pipes_timeout(the time between two successive incoming packets), repl_pipes_auth_check (ip authentication check for incoming packets) and repl_timer_interval (how often the pipe information should be shared within the cluster)

RATELIMT module

• integrated with the clusterer module for pipes sharing. The sharing is not done anymore via a NoSQL database, but directly between OpenSIPS instances (via BIN protocol encapsulated in Clusterer module). New parameters were added to control the clustering : accept_pipes_timeout(the time between two successive incoming packets) and repl_pipes_auth_check (ip authentication check for incoming packets)

• integrated with the clusterer module for dialog state replication and dialog profile sharing. The sharing is not done anymore via a NoSQL database, but directly between OpenSIPS instances (via BIN protocol encapsulated in Clusterer module). New parameters were added to control the clustering : accept_replicated_profile_timeout(the time between two successive incoming packets) and auth_check (ip authentication check for incoming packets)

• integrated with the clusterer module for dialog state replication and dialog profile sharing. The sharing is not done anymore via a NoSQL database, but directly between OpenSIPS instances (via BIN protocol encapsulated in Clusterer module).

• support for locking debugging - compile with DBG_LOCK (from menuconfig for example) and each lock will stored information regarding the place from where the lock was acquired (file, function, line) - this is useful when debugging deadlocks.

UAC module

• CSEQ is properly increased during the authentication process.

• integrated with the clusterer module for contacts replication. The parameter replicate_contacts_to points now to a cluster ID, instead to a list of destinations.

• hep packet manipulation - version 3 only - since the new, chunk based, design of the hep protocol, packet manipulation is now available from the script; hep_get(), hep_set() and hep_del() functions give you the possibility to add new chunks, modify old ones, read their value and also remove them; still you have to know the data type of the header when reading it, since that is not possible only with the means provided by the protocol;

• do_accounting - function through which one can enable all accounting types at once(database, aaa, syslog, event interface, diameter) in multiple ways: if no parameters used normal accounting shall be made else one can enable cdr, missed calls and failed transaction accounting; the function also allows setting the accounting table for database accounting type;
• drop_accounting - disable accounting types and flags set with do_accounting(); if no parameter provided all accounting shall be stopped; if only the type is provided all acounting for that type shall be stopped; if all flags are dropped(cdr, missed, failed) with the second parameter, normal accounting will still be enabled;
• read more in the official announcement and the documentation

• trace_id - tracing destinations can be defined using this parameter(database, sip duplication, hep duplication) via a generic uri; it also allows nesting multiple types of tracing under the same trace_id;
• capture_on improvement - the flag can now enable/disable trace_ids via mi; if no parameter used it shall affect all the trace_ids; by default it is enabled for all the ids
• sip_trace has a new design - the function can now trace on multiple levels - message tracing, transaction tracing(tm module) and dialog tracing(dialog module); transaction aware tracing can also be made in stateless mode(internally generated replies are traced);
• read the docs and the official announcement for more information;

• integration with proto_hep - sipcapture now uses proto_hep for communication; the receiving interface for hep messages has to be set up using the module;
• hep_route - hep packets manipulation became much simpler; now one can define a special route through which all messages coming through hep defined interfaces should go; if none is used, sip_capture shall automatically be called for all the packets; setting sip, which is also the default behavior, will pass the packets through the main request route;
• hep proxy - OpenSIPS can now act as a full hep proxy; one can set the destination uri and call hep_relay() function; the routing is being made the same way tm module does it, leaving you with the option to use the whole routing logic already available;
• hep packet manipulation - version 3 only - since the new, chunk based, design of the hep protocol, packet manipulation is now available from the script; hep_get(), hep_set() and hep_del() functions give you the posibility to add new chunks, modify old ones, read their value and also remove them; still you have to know the data type of the header when reading it, since that is not

possible only with the means provided by the protocol;

• read the docs and the official announcement for more information;

• new memgroup global parameter for configurable statistics about shared memory usage ; groups of modules can be defined in the .cfg file that would lead to statistics being generated with the number of fragments, used memory and real-used memory by those modules. The global fragments statistics now show the number of fragments allocated and in use.

• added millisecond precision for the duration of generated CDRs - a new field ms_duration is populated by the module when CDR-based accounting is done

• added Re-INVITE in-dialog pinging support; controlled via the new "R" and "r" flags available to create_dialog() as well as the new reinvite_ping_interval module parameter. It properly handle late negociation between endpoints, it ensure SDP persistency ( DB and BIN replication ), it ensure compatibility with topology hiding, it has support for whitelist or blacklist logic ( terminate call for 481 and 408 timeout, or terminate call for anything else other than 200 and 491 ).

DB_SQLITE module (new)

New DB module to provides SQLite backend support for OpenSIPS.

PROTO_HEP module (new)

Provides support for all hep protocols - HEPv1/2 and HEPv3. It concentrate all the HEP protocol related operations (async send and receive via TCP). The siptrace and sipcapture modules do require this module in order to perform the HEP read/write operations.

• new $cfg_file, $cfg_line script variables to return the name of the config file and the line inside the file.

• the memory dump for Q_MALLOC gives you the list of used memory chunks (and the list of free memory chunks as previously)
• memory dump via SIGUSR1 is now possible when also using the HP_MALLOC or F_MALLOC memory managers (listing the used memory chunks)

• memory dump via SIGUSR1 is now possible when also using the HP_MALLOC or F_MALLOC memory managers

• added Re-INVITE in-dialog pinging support

B2B_SCA

• the parameter table_name moved to default value b2b_sca (from sca)

• ViM syntax highlighting for OpenSIPS config script

• ViM syntax highlighting for OpenSIPS 2.4+ config script

• script flags and functions have been removed

• script flags and functions have been removed (simplicity reasons, logic can be rewritten)

• script flags and functions have been removed for simplicity reasons

• logging improvements on out-of-memory errors, DB errors, TCP errors, parsing errors, memory logging

• auto-correction of timer drifting - correlate and keep the internal timer in sync with the OS timer

• logging improvements on out-of-memory errors, DB errors, parsing errors, memory logging

• improvements to: out-of-memory errors, DB errors, parsing errors, memory logging

• error reporting improvements: out-of-memory errors, DB errors, parsing errors, etc.

DB_VIRTUAL module

• added async raw query support

• the partitions parameter can now be given as a multi-line string

  * three allocators: F_MALLOC, QM_MALLOC, HP_MALLOC. Any of them can be run in troubleshooting mode with -DDBG_MALLOC

• overall allocator rework
  • three allocators: F_MALLOC, QM_MALLOC, HP_MALLOC. Any of them can be run in troubleshooting mode with -DDBG_MALLOC. (although we recommend only doing this with QM_MALLOC)
  • reworked QM_MALLOC memory fragment dump output - it is now much more human-friendly
  • fixed and made F_MALLOC work in debug mode again, since it remains one the best troubleshooting options in high-traffic environments
  • improved menuconfig allocator selection (less error-prone)

The amount OpenSIPS of script coding it requires is minimal, with only a few module parameters, a scripting variable used to access the data and the optional possibility of triggering SQL->NoSQL transfers externally, through the MI interface.\\

The amount OpenSIPS script code required in order to use it is minimal, with only a few module parameters, a scripting variable used to access the data and the optional possibility of triggering SQL->NoSQL transfers externally, through the MI interface.\\

OpenSIPS 2.4 switched to TCP transport for BIN interface. (the UDP transport for BIN showed significant package loss under high traffic even in a private network, being unable to meet the requirements for a high-traffic data exchange between multiple OpenSIPS).
Even more, the TCP transport in BIN engine takes advantage of the Asynchronous Reactor, avoiding any potential blocking on reading/writing to the BIN connections.
The old UDP transport support from OpenSIPS core was dropped.
See module documentation

SQL_CACHER module (new)

This new module allows you to cache an arbitrary number of tables from your preferred SQL database into the OpenSIPS-supported cache database of your choice. The amount OpenSIPS script code required in order to use it is minimal, with only a few module parameters, a scripting variable used to access the data and the optional possibility of triggering SQL->NoSQL transfers externally, through the MI interface. See the module documentation

OpenSIPS troubleshooting / development

OpenSIPS testing / development

• add support for debugging locks (-DDBG_LOCK)

  * {s.trim}, {s.triml}, {s.trimr} - string trimming transformations

• for-each statement: add support for $json iterators

• ViM syntax highlighting for OpenSIPS config script

• new string transformations:
  • {s.width} - truncates or expands the input to the given len
  • {s.b64encode} - represents binary input data into ASCII
  • {s.b64decode} - decodes Base64 input
  • {s.xor} - encodes the input by XOR'ing with a key

• '''new string transformations:
  • {s.width}''' - truncates or expands the input to the given len
  • {s.b64encode}''' - represents binary input data into ASCII
  • {s.b64decode}''' - decodes Base64 input
  • {s.xor}''' - encodes the input by XOR'ing with a key

• default DB engine for MySQL was moved from MyISAM to InnoDB

• new string transformation: {s.width} - truncates or expands the input to the given len
• add support for folded strings in the config file (multi line strings). Now you can have a multi-chunk (even multi line folded) string as parameter to a script function

• debug MI command renamed to log_level (same functionality, input and output)
• default DB engine for MySQL was moved from MyISAM to InnoDB
• add support for folded strings in the config file (multi line strings). Now you can have a multi-chunk (even multi line folded) string as parameter to a script function

• auto-correction of timer drifting - correlate and keep in sync the internal timer with the OS timer

OpenSIPS script

• debug global parameter renamed to log_level global parameter (same behavior and values)
• new $log_level script variable to replace the setdebug() script function (same functionality and input)
• new debug_mode parameter to replace the outdated fork parameter
• global parameters user/uid and group/gid were removed (use the command line options for these settings)

REST_CLIENT module

• New function: rest_append_hf() - add custom HTTP headers before performing REST actions. Details about the function can be found in the module doc.

• auto-correction of timer drifting - correlate and keep in sync the internal timer with the OS timer.

OSP module

• new module parameters for STIR support : request_date_avp, sdp_fingerprint_avp, identity_signature_avp, identity_algorithm_avp, identity_information_avp, identity_type_avp, identity_canon_avp
• new function for STIR support setrequestdate()

MATHOPS module

• additional operations are available now addition (+), subtraction/negation (-), multiplication (*), division (/), exponentiation (^) and modulus (%)
• additional C math functions abs (calls to fabs), acos, asin, atan, ceil, cos, cosh, exp, floor, ln (calls to log), log (calls to log10), sin, sinh, sqrt, tan, tanh

• domain DB column is now by default NULL (to save DB space) versus empty string.

PROTO_TCP module

• parameter tcp_async is now by default on !

PIKE module

• new pike_rm MI command to unblock a detected IP address.

• when dns_try_ipv6 is set, try to resolve first as IPv6 (AAA record) instead of IPv4 (A record)

CFGUTILS module

• new asynchronous sleep() and usleep() functions. OpenSIPS will not block anymore while performing a sleep operation.

• add support for folded strings in the config file (multi line strings). Now you can have a multi-chunk (even multi line folded) string as parameter to a script function.

• new no_concurrent_reload module parameter (boolean, default off) to prevent multiple data reloads in the same time (from multiple processes). If you have a large routing set (millions of rules/prefixes), you should consider disabling concurrent reload as they will exhaust the shared memory (by reloading into memory, in the same time, multiple instances of routing data).

• default DB engine for MySQL was moved from MyISAM to InnoDB.

• all flags used for accounting have been removed and replaced with do_accounting() and drop_accounting() functions - read more in the official announcement

EVENT_RABBITMQ module

• new sync_mode module parameter to switch to asynchronous sending of the rabbitmq messages - when an event is raised in synchronous mode (sync_mode is set ON) the triggering process waits for the status of the operation from the actual worker process.

DB_TEXT module

• new dbt_reload MI function to force the reload of the cached tables from disk. Depending on parameters it could be a whole cache or a specified database or a single table. If any table cannot be reloaded from disk - the old version preserved and error reported.

• lb_start() / load_balance() has new flag s to pick a random destinations within equal loads, if multiple destinations selected. This could help to offload an excessive load from first destination and distribute load in situations when calls duration is near to zero (like failed calls) and counts in resources are almost always zero and does not reflect an actual calls flow.

PROTO_HEP module

• provides support for all hep protocols - HEPv1/2 and HEPv3

SIPCAPTURE module

• improved hep support - uses proto_hep module to provide support for all hep protocols
• hep_route - parameter which defines a special route through which hep related messages should go
• hep_proxy - posibilty to route hep packets the same way sip messages are routed
• hep chunk manipulation - posibility to add, remove and modify hep chunks for hep version 3

• new format_version module parameter to control if the XMLRPC output should be or not XML wise formating - the MI content is split (nodes and attributes) and encapsulated in XML tags. Instead of the long and monolithic string response, now the module provides a proper exploded XML tree; that means the result no longer requires the client to do any custom parsing (beside simple XML parsing, of course). Default value is 1 (do XML wise formating) and not 0 (no formating, be backward compatible).
• params xml node is not anymore mandatory in the XML request (if no parameters are actually provided to the command). This ensures backward compatibility with the outdated mi_xmlrpc module

• mi_xmlrpc_ng_root module parameter renamed as http_root
• mi_xmlrpc_ng_format_version module parameter renamed as format_version

• all flags used for accounting have been removed and replaced with do_accounting() and drop_accounting() functions

SIPTRACE module

• New module design - all the flags and parameters for different types of tracing have now been replaced with only one parameter called trace_id

OpenSIPS core

• global parameters user/uid and group/gid were removed (use the command line options for these settings).

BIN Interface

• new profile_end_dlgs MI command to terminate all the dialogs for a profile (a value may be also provided).

AVPOPS module

• the avp_db_query function returns string "<null>" into multi-fields query for a fields with NULL DB value - this helps keeping the data consistency in multi-row queries, like index n in AVPs will hold the values in row n.

• new parameter full to the ds_list MI command. This new optional parameter additionally print the weight, priority and description for the listed destinations.

• allow retransmissions and wait for reply/timeout on canceled branches - do not do anything about branches with no received reply; better continue the retransmission hoping to get something back; if still not, we will generate the 408 Timeout based on FR timer; this helps with better coping with missed/lated provisional replies in the context of canceling the transaction (see more in the commit log).

• allow retransmissions and wait for reply/timeout on canceled branches - do not do anything about branches with no received reply; better continue the retransmission hoping to get something back; if still not, we will generate the 408 Timeout based on FR timer; this helps with better coping with missed/lated provisional replies in the context of canceling the transaction (see more in the commit log.

• allow unset_dlg_profile(profile,[value]) to be used from REQUEST route too.

CPL-C module

• module is renamed to cpl_c without any additional changes.

Migration from 2.1.x to 2.4.0?

ALIAS_DB module

• allow alias_db_find in STARTUP route
• the functions alias_db_find and alias_db_lookup accept now in the table parameter any combination of variables and strings.

• new debug_mode parameter to replace the outdated fork parameter.

Debugging (core)

• new Documentation/Script-CoreParameters-2-4#debug_mode parameter to replace the outdated Documentation/Script-CoreParameters-2-4#fork parameter.

Logging (core)

• new log_level global parameter to replace debug global parameter (same behavior and values)
• new log_level MI command to replace debug MI command (save functionality, input and output)
• new $log_level script variable to replace the setdebug() script function (save functionality and input)

DISPATCHER module

• new ds_probing_list module parameter allows OpenSIPS to ping/probe only some certain groups of destinations. This optional parameter contains the list of groups (by ID) to be probe; if missing, all groups are probed (it is backward compatible)

TM module

• the behavior for the auto 100 Giving a try reply changed. Instead of sending this reply when performing the SIP relay (usually at the end of the processing), now is done when entering in stateful mode (the SIP transaction is created), usually when t_newtran is called directly from script or indirectly via other functions (like load_balancing, b2b, osp, etc). Now, the 100 reply may be sent quite early in the script, reducing the changes of retransmissions. Also an consistent behavior is achieved now - same 100 reply is automatically sent when doing t_relay() and t_newtran()+t_relay() in script.

DROUTING module

• wildcard support for partitions - when using partitions, the lookup-kind functions (do_routing(), is_from_gw(), goes_to_gw()) accept now a wildcard for the name of the partition - this means the search will be done in all the existing partitions, instead of a single one. This allows you to search prefixes or gateways in all partitions, when you do not have any information to help identifying the right partition to look into.

• lb_is_destination accepts as port parameter a static value, rather than variables only - lb_is_destination("$si","0") is also a valid call now.

• params xml node is not anymore mandatory in the XML request (if no parameters are actually provided to the command). This ensures backward compatibility with the outdated mi_xmlrpc module

BIN Interface (core)

• added millisecond precision for the duration of generated CDRs - a new field ms_duration is populated by the module when CDR-based accounting is done

B2B_ENTITIES module

• fixed the handling for nested requests by properly implementing "491 Pending" support.

NATHELPER module

• stateful pinging for nathelper - each SIP OPTIONS ping reply can now be matched using the branch from the VIA header. Using the new contact_id feature, this allows us to remove the contacts that don't respond to a certain amount of pings, releasing memory and also improving contact search performances, location table size and also memory consumption. You can read the documentation here. Read paragraph two of the Overview section to understand how to use this feature.

TOPOLOGY HIDING module

• the contacts in the final 3xx replies (for initial INVITEs) are not hided any more - this allow SIP redirects (3xx based) to work through the TH module.

ACC module

• added millisecond precision for the duration of generated CDRs

DIALOG module

• added Re-INVITE in-dialog pinging support - TBD

EVENT_VIRTUAL module (new)

The event_virtual module provides a solution for detecting the failure of events delivery and for doing the failover. Even more, beside failure handling, the module addresses the issue of load balancing (or dispatching) for events across multiple backends.
Shortly, the new event_virtual module provides the possibility to create virtual backends for the OpenSIPS Event Interface. A virtual backend can aggregate multiple real backends (transport protocols that are implemented by different OpenSIPS modules) such as: event_xmlrpc, event_rabbitmq etc. The main advantage brought by this module is that when an event is triggered, the virtual module pushes the event to the read backends with different policies (parallel, failover, round-robin) which can be specified in the virtual subscription socket.
See module documentation

URI module

• del_uri_param function - enables you to remove a parameter from SIP URI taking the key name as argument. All parameters from URI are parsed and, if found, the parameter with the given key is removed. If the parameter is not being found or the URI contains no parameters you shall be notified. Docs here

NATHELPER module

• stateful pinging for nathelper - each SIP OPTIONS ping reply can now be matched using the branch from the VIA header. Using the new contact_id feature, this allows us to remove the contacts that don't respond to a certain amount of pings, releasing memory and also improving contact search performances, location table size and also memory consumption. You can read the documentation here. Read paragraph two of the Overview section to understand how to use this feature.

BIN Interface

For detecting incompatibilities at BIN level, a version field was added to the header of the protocol to stop errors from occurring when two OpenSIPS instances with different version of the protocol exchange BIN messages. So please note that BIN in 2.4 is not backward compatible !

OpenSIPS 2.4 switched to TCP transport for BIN interface. (the UDP transport for BIN showed significant package loss under high traffic even in a private network, being unable to meet the requirements for a high-traffic data exchange between multiple OpenSIPS).
Even more, the TCP transport in BIN engine takes advantage of the Asynchronous Reactor, avoiding any potential blocking on reading/writing to the BIN connections.
The old UDP transport support from OpenSIPS core was dropped.\\

PROTO_BIN module (new)

OpenSIPS 2.4 switched to TCP transport for BIN interface. (the UDP transport for BIN showed significant package loss under high traffic even in a private network, being unable to meet the requirements for a high-traffic data exchange between multiple OpenSIPS). Even more, the TCP transport in BIN engine takes advantage of the Asynchronous Reactor, avoiding any potential blocking on reading/writing to the BIN connections. The old UDP transport support from OpenSIPS core was dropped. See module documentation

The old UDP transport support was dropped,

LDAP module

• async ldap_search() - since ldap library has built-in support for async operations, ldap_search can be called at time t, and function result can be checked at t + x time. Also, in the resume route you can also call ldap_result() to retrieve the results from the ldap server. Full documentation here

LOAD BALANCER module

• new flag for lb_start() function to pick a random destinations with equal load, if multiple destinations selected. This could help to offload an excessive load from first destination and distribute load in situations when calls duration is near to zero (like failed calls) and counts in resources are almost always zero and does not reflect an actual calls flow.

MI_XMLRPC_NG

• XML wise formating - the MI content is split (nodes and attributes) and encapsulated in XML tags. Instead of the long and monolithic string response, now the module provides a proper exploded XML tree; that means the result no longer requires the client to do any custom parsing (beside simple XML parsing, of course).

LOAD BALANCER module

• new flag for lb_start() function to pick a random destinations with equal load, if multiple destinations selected. This could help to offload an excessive load from first destination and distribute load in situations when calls duration is near to zero (like failed calls) and counts in resources are almost always zero and does not reflect an actual calls flow.

LDAP module

• async ldap_search() - since ldap library has built-in support for async operations, ldap_search can be called at time t, and function result can be checked at t + x time. Also, in the resume route you can also call ldap_result() to retrieve the results from the ldap server. Full documentation here

DB_TEXT module

• new dbt_reload MI command - causes db_text module to reload cached tables from disk.

REGISTRAR module

• lookup() force lookup on all branches flag - a new flag for lookup() function has been added which allows you to force lookup() function to expand not only the RURI to contacts, but also all the AORs that can be found inside branches. The flag is called r from bRanch lookup and you can readFull documentation here

RADIUS module

• Async authentication and accounting functions for radius_send_auth() and radius_send_acct() functions can now be used asynchronously. In order to do this, one must patch the radius library, because, for the moment, they do not offer async support. You have a full tutorial about how to do this here.

USRLOC module

• introduce the Contact ID concept - each contact created using usrloc module now has a unique identifier called contact_id which dramatically improves the performance mostly when using databases. The contact_id also stands as UNIQUE PRIMARY KEY for the location table which holds all the contacts. The performance improvement comes from the fact that now, when a contact is searched/deleted/updated, a numerical index shall be used instead of a string. Moreover, finding a contact in memory shall take less time since the identifier holds inside indexes that makes moving through data structures a less time consuming operation.
• combine multiple deletes in a single query when timer is called; since we now have the contact_id to identify a contact, we can easily combine multiple database delete requests into a single query based on this identifier. You also have the max_contact_delete parameter to specify how many delete requests shall be put together inside a single query.

Usrloc contact_id

Each contact created using usrloc module now has a unique identifier called contact_id which dramatically improves the performance mostly when using databases. The contact_id also stands as UNIQUE PRIMARY KEY for the location table which holds all the contacts. The performance improvement comes from the fact that now, when a contact is searched/deleted/updated, a numerical index shall be used instead of a string. Moreover, finding a contact in memory shall take less time since the identifier holds inside indexes that makes moving through data structures a less time consuming operation.

Combine multiple deletes in a single query for usrloc module when timer is called

Since we now have the contact_id to identify a contact, we can easily combine multiple database delete requests into a single query based on this identifier. You also have the max_contact_delete parameter to specify how many delete requests shall be put together inside a single query.

Async ldap_search

ldap_search function is now async in version 2.4 . Since ldap library has built-in support for async operations, ldap_search can be called at time t, and function result can be checked at t+x time. Also, in the resume route you can also call ldap_result() to retrieve the results from the ldap server. Full documentation here

REGISTRAR lookup() force lookup on all branches flag

A new flag for lookup() function has been added which allows you to force lookup() function to expand not only the RURI to contacts, but also all the AORs that can be found inside branches. The flag is called r from bRanch lookup and you can readFull documentation here

Async authentification and accounting functions for RADIUS module

radius_send_auth and radius_send_acct functions can now be used asynchronously. In order to do this, one must patch the radius library, because, for the moment, they do not offer async support. You have a full tutorial about how to do this here.

Devel Plan 2.4 release (TODO list)

Migration from 2.1.x to 2.4.0

• A new E_PRESENCE_PUBLISH event has been added that is triggered every time OpenSIPS receives a PUBLISH message. Read mode here ...

• Added support for limiting the number of SIP MESSAGES that will be dumped in one shot ( in order to not overload the client )

• Added per contact events - raised when a new contact is inserted / updated / deleted. Read more here ...
• Added User-Agent filtering capabilities for lookup() - so you can now send calls just to particular UAs, if you need to

A new module that offers topology hiding capabilities. The module strips and restores the headers that contain topology information (Via, Record-Route, Route and Contact headers) , and optionally it can also change the Call-ID of the requests. The module can work on top of the dialog module, or in stand-alone mode, thus allowing to do topology hiding for all types of dialogs ( eg. Presence dialogs ) and also for standalone initial requests ( eg. SIP MESSAGE ).
See the usage tutorial and the module documentation for parameters and functions provided by this module.

• Call-ID topology hiding support was added within the dialog module - there are many cases where the callid contains IPs, thus revealing part of the network topology. More information here ...
• Added the ability to propagate various Contact Header / URI parameters when doing topology hiding - helpful for preserving some end-to-end functionality relying on URI params. Read more here ...

• Added the E_DLG_STATE_CHANGED event, that will be triggered when the dialog state changes (eg. from early to established, from established to ended, etc ).

• sync/async support for event_route - Provides the possibility to run an event route asynchronously. More information here

• Added per contact events - raised when a new contact is inserted / updated / deleted. Read more here ...

• Rework of how the Json string is build in order to properly accommodate arrays - in many MI answers, OpenSIPS returns arrays - and these arrays need to be properly translated from internal MI structure to the json format.

• Added support for external body - the MESSAGE has no actual body, but the Content-Type hdr refers to an external body by an HTTP link.

• New end_sub_on_timeout module parameter - If a presence subscription should be automatically terminated (destroyed) when receiving a SIP timeout (408) for a sent NOTIFY requests.

• avp_db_query() may now be used asynchronously (with MySQL backend). A usage example can be found in the module documentation.

• The db_mysql module is now capable of doing asynchronous raw queries. It implements its own pool of connections (per process), so multiple queries can be done in parallel from the same process.

• Rework of how the LB session is controlled (start, resume, stop) from script:
  • new lb_start(), strictly used to start LB session. if sessions already started, old session will be lost and re-started again.
  • new lb_next(), continues an existing LB session (working as load_balance() from failure route - to do failover)
  • lb_start_and_next() - is simply a shorthand for 'lb_is_started()?lb_next():lb_start()' to simplify scripting. This function logically almost the same as old load_balance() function.
  • new lb_reset() to stop a current LB session
  • new lb_is_started() to check if there is any ongoing LB session
• the LB process (when started) takes one more flag to enable usage of destination with negative availability (exceeded capacity); do not ignore resources with negative availability, and thus able to select for load balancing destinations with exceeded capacity. This might be needed in scenarios where we want to limit generic calls volume and always pass important/high-priority calls.
• lb_count_call() - can take negative values, to revert a previous lb_count_call() action

A new module which performs both SIP message compression and SIP header compaction. The compression module gives you the means to reduce the size of the message, by using the following features:

• message body and the header compression
• unnecessary headers removal
• header name reduction to RFC compact form (such as 'v' for 'Via'); we support a limited set of compact headers from RFC 3261 and RFC 4028 (complete list at [2])
• unnecessary attribute lines removal from the sdp body which represent default values

A comprehensive tutorial is available beside the module documentation.

EXEC module

• Asynchronous exec() - the exec() function may now also be used in the asynchronous mode, via the async() statement.
• New generic exec() function - All "exec"-like functions merged into a single generic function - more information here

LOAD_BALANCER module

• rework of how the LB session is controlled (start, resume, stop) from script

A new module which performs both SIP message compression and SIP header compaction. Read more here ...

The emergency module provides emergency call treatment, following the IETF specs (RFC 6881, RFC6442) and the i2 specification of the American entity NENA(National Emergency Number Association). Module documentation is available here. Also, a comprehensive tutorial is available for describing the usage cases and how to use this module.

A new module that helps you prevent fraud by detecting (in a per user fashion) fraudulent calls based on dialing patterns (using patterns on total number of calls, on average duration, number of parallel calls, maximum cps value and more).\\

A new module that enables media streams to be proxied via RTPENGINE

Module to provide the SCTP transport protocol for SIP. You need to load this module if you want to define SIP listeners over SCTP. See the module documentation for parameters.

• The emergency module provides emergency call treatment, following the IETF specs (RFC 6881, RFC6442) and the i2 specification of the American entity NENA(National Emergency Number Association). Module documentation is available here. Also, a comprehensive tutorial is available for describing the usage cases and how to use this module.

• A new module that helps you prevent fraud by detecting (in a per user fashion) fraudulent calls based on dialing patterns (using patterns on total number of calls, on average duration, number of parallel calls, maximum cps value and more).
  See the complete usage tutorial and the module documentation for parameters and functions provided by this module.

Module to provide the TLS transport protocol for SIP. You need to load this module if you want to define SIP listeners over TLS. See the TLS usage tutorial and the module documentation for parameters.

NEW PROTO_SCTP module

Module to provide the SCTP transport protocol for SIP. You need to load this module if you want to define SIP listeners over SCTP. See the module documentation for parameters.

Module to provide the websocket transport protocol for SIP (server side). You need to load this module if you want to define SIP listeners over WS transport. See the websocket usage tutorial and the module documentation for parameters.

NEW PROTO_TLS module

Module to provide the TLS transport protocol for SIP (server side). You need to load this module if you want to define SIP listeners over WS transport.

Allows new protocols to be added in a much easier way. OpenSIPS 2.4 now comes with two built-in transport modules, TCP and UDP, and three optional protocol-modules: WebSocket, TLS and SCTP. The binary no longer needs to be recompiled every time you choose to support a new protocol.
In order to use one of those protocols (in a SIP listener), you need to load the corresponding module (as any other OpenSIPS module).

OpenSIPS 2.4 had the ability to perform, from script level, various operations in the asynchronous mode. Now you can run DB queries, REST queries or external scripts without the blocking penalty !

The OpenSIPS config file allows you to use certain functions in async way (via the dedicated "async" statement). The suspending and resuming is done at script level. A detailed description of how the async support works in 2.4 is available here: http://www.opensips.org/Documentation/Script-Async-2-4 .

The async scripting support is just the tip of the iceberg (when comes to the work which has been done). To make this possible, radical changes were implemented in OpenSIPS 2.4 (most of them imported from OpenSIPS experimental branch):

• per-process I/O reactors
• timer jobs dispatched across all SIP workers (versus dedicated timer procs)
• updatable transactions in TM (to be able to use the transactions as contexts for the async jump)
• transaction based async support in TM module
• processing context (to make it easier to suspend and resume the script execution)

The first modules providing async functions are:

• avpops for DB mysql queries
• exec for script execution
• rest_client for remote REST queries

NEW PROTO_WS module

SIP transport protocols rework

Allows new protocols to be added in a much easier way. OpenSIPS now comes with two built-in transport modules, TCP and UDP, and three optional modules: WebSocket, TLS and SCTP. The binary no longer needs to be recompiled every time you choose to support a new protocol.

Asynchronous I/O operations

DB core and API (for module developers)''': Primitives for managing asynchronous DB connection pools. To be used by SQL drivers when implementing the async DB API.

• New modparam: persistent_state - prevent OpenSIPS from making any runtime UPDATE queries on the dispatcher table

• New modparam: persistent_state - prevent OpenSIPS from making any runtime UPDATE queries on the dr_gateways and dr_carriers tables

Core

OpenSIPS Core

Config Script

• Internal networking layer rework - allows new protocols to be added in a much easier way. OpenSIPS now comes with two built-in transport modules, TCP and UDP, and three optional modules: WebSocket, TLS and SCTP. The binary no longer needs to be recompiled every time you choose to support a new protocol.

• New assert(statement, message) function - If statement does not hold, OpenSIPS can just print the message or even abort (if abort_on_assert is enabled). More information here ...

• New async() script statement: Dramatically improves the scalability of OpenSIPS config scripts which must perform blocking I/O (e.g. MySQL queries, exec scripts, HTTP queries). Halts current script execution and runs a resume route once the async operation is complete. More information in the OpenSIPS 2.4 async tutorial ...

• New async() script statement: Dramatically improves the scalability of OpenSIPS config scripts which must perform blocking I/O (e.g. MySQL queries, exec scripts, HTTP queries). Halts current script execution and runs a resume route once the async operation is complete. ore information here ...

• New async() script statement: Dramatically improves the scalability of OpenSIPS config scripts which must perform blocking I/O (e.g. MySQL queries, exec scripts, HTTP queries). Halts current script execution and runs a resume route once the async operation is complete. ore information here ...

• A new module which performs both SIP message compression and SIP header compaction. Read more here ...

• New OpenSIPS module which performs both SIP message compression and SIP header compaction. Read more here ...

• Added a new compression module which performs both message compression and compaction. Read more here ...

• New $rT pseudo variable - Holds the current route type as a string. Useful for determining the original route type when inside another route in script - Allows for more generic and reusable routes. More information here ...

• New $rT pseudo variable - Holds the current route type as a string. Useful for determining the original route type when inside another route in script - Allows for more generic and reusable routes. More information here ...

• New TCP parameter: tcp_crlf_drop - set to 1 in order to drop "\r\n" pinging messages

• New TCP parameter: tcp_crlf_drop - set to 1 in order to close TCP connections in case of "\r\n" pinging messages

A manual for how to migrate/update from 1.11.x to 2.4.x is now available on site.

A manual for how to migrate/update from 1.11.x to 2.4.x is now available on site.

A manual for how to migrate/update from 1.10.x to 1.11.x is now available on site.

• Memory profiling with HP_MALLOC - send SIGUSR1 to OpenSIPS processes in order to print a detailed status of optimized shared memory buckets and fragment distribution

• New core parameter: db_max_async_connections - maximum number of connections to a single DB backend from a single worker
• New MI command: list_statistics - prints a list of all available statistics in the current configuration of OpenSIPS

LDAP module

• StartTLS support introduced. For example configurations, please refer to the new parameter documentation

• sync/async support for event_route (e3d37f4 TODO)

• (d84649e TODO)

• Added support for DATE fields when doing raw queries. Date fields are returned as UNIX timestamps at script level.

• cc_calls table added (2f6eb09 TODO)
• last_call_end column (4b366c5 TODO)

• Slight performance improvement for all SELECT queries

• Added the E_DLG_STATE_CHANGED event.

• dp_translate(): the "id" parameter may now also be given as a plain int

• ds_reload MI command updated to support partition-only reloading
• ds_is_in_list(): ip and port must no longer be strictly given as pvars
• Added the destination priority column

• New uri transformation: uri.schema - Extract the given URI's schema. More information here

• Support for multi-part bodies - $cT (Content-Type) and $rb (Request Body) are now indexed - e.g. $(rb[1])

• New uri transformation: uri.schema - Extract the given URI's schema. More information here ...

• New assert(statement, message) function - If statement does not hold, OpenSIPS can just print the message or even abort (if abort_on_assert is enabled).

• New assert(statement, message) function - If statement does not hold, OpenSIPS can just print the message or even abort (if abort_on_assert is set to true).

• loadmodule statement ordering: eliminated! Modules can now be loaded in any order within the config script. Also added an easy-to-use module dependency specification logic for module developers! More information here ...

• loadmodule statement ordering: eliminated! Modules can now be loaded in _any order within the config script. Also added an easy-to-use module dependency specification logic for module developers! More information here ...

• New MI command: list_statistics - prints a list of all available statistics in the current configuration of OpenSIPS (dd03176)

• New shm_check MI function - To be used when running with memory debugging (DBG_QM_MALLOC memory allocator). Does a complete scan of the shared memory pool and aborts OpenSIPS on any encountered sign of memory corruption.

• loadmodule statement ordering: eliminated! Modules can now be loaded in any order within the config script. Also added an easy-to-use module dependency specification logic for module developers! More information here ...

• Asynchronous DB core and API (for module developers): Primitives for managing asynchronous DB connection pools. To be used by SQL drivers when implementing the async DB API.

• Internal networking layer rework - allows new protocols to be added in a much easier way. OpenSIPS now comes with two built-in transport modules, TCP and UDP, and three optional shared libraries: WebSocket, TLS and SCTP. The binary no longer needs to be recompiled every time you choose to support a new protocol.

NEW PROTO_WS module (TODO)

• New static TCP & UDP modules (TODO)

NEW PROTO_TLS module (TODO)

NEW PROTO_SCTP module (TODO)

NEW PROTO_WS module (TODO)

• WebSocket support (TODO)

• New output when dumping the free memory hash table with HP_MALLOC

• when using rest_post(), you may omit the "send_content_type" parameter. It will default to "application/x-www-form-urlencoded"

• New uri transformation: uri.schema - Extract the given URI's schema (TODO) transformations manual for usage examples

NEW TOPOLOGY_HIDING module

• (d84649e)

NEW CALL_EMERGENCY module (TODO)

• (d8cfac6)

CACHEDB_MONGODB module

• Added support for DATE fields when doing raw queries. Date fields are returned as UNIX timestamps (4782d0a)

• New core parameter: db_max_async_connections - maximum number of connections to a single DB backend from a single worker (3eacd98)

• Asynchronous exec() - the exec() call may now also be used asynchronously, in an async() block (e7a090f)

• New core parameter: tcp_crlf_drop - set to 1 in order to close TCP connections in case of "\r\n" pinging messages (487e7b5)

• Support for multi-part body - $cT (Content-Type) and $rb (Request Body) are now indexed - e.g. $(rb[1]) (1986385)

LOAD_BALANCER module (TODO)

• LOTS of changes -> TODO (f43a405)

NATHELPER module

• Ambiguous "oldmediaip" SDP attributes replaced with "oldcip" and "oldoip" (a5900b5)

PRESENCE module

• New end_sub_on_timeout modparam (7aa96b2)

EXEC module (TODO)

LDAP module (TODO)

• StartTLS support introduced (0b61cba)

EXEC module (todo)

• New generic exec() function - More information here ...

DB_UNIXODBC module

• Slight performance improvement for all SELECT queries. (683dfaa)

• load_balance() - two new algorithms (5986074)

• lb_count_call() - new parameter to revert a previous lb_count_call() action (cd0ac14)

• lb_count_call() - new parameter to revert the previous action (cd0ac14)

• new lb_reset() function (301e6d3)

• load_balance() function enhancements (a7549e0)

• Added a new event to be triggered when the state of a gateway is changed (either from MI or via probing triggered from script). More information here...

• Added async event handling - Allows for running the events in an asynchronous mode (in a dedicated process). More information here ...

• Added a new event to be triggered when the state of a gateway is changed (either from MI or via probing triggered from script). More information here ...

• Reworked the FIFO handling - added support for detecting if the FIFO file gets deleted (for re-creating it), and also added SIGHUP signal handling for re-creating and re-opening of the FIFO file.

• sync/async support for event_route (e3d37f4)

• Added the E_DLG_STATE_CHANGED event (10083ed)

• New string transformations: s.fill.left, s.fill.right - Fill a string with a char/string until a given final length is reached. Refer to the transformations manual for usage examples

• New string transformations: (s.fill.left / s.fill.right) - Fill a string with a char/string until a given final length is reached. Refer to the transformations manual for usage examples

• ds_is_in_list(): ip and port must no longer be strictly given as pvars (e7bccda)

• Added the ability to propagate various Contact Header / URI parameters when doing topology hiding - helpful for preserving some end-to-end functionality relying on URI params. Read more here ...

• When using the uac_auth() for having OpenSIPS do SIP authentication, the CSEQ number will be increased for subsequent authentication requests - thus fixing various downstream issues (e.g. Asterisk treating the AUTH request as a retransmission due to the same CSEQ number).

• New MI command: list_statistics - (dd03176)

• ds_reload MI command updated to support partition-only reloading (7a58426)

• last_call_end column (4b366c5)

CALL_CENTER module

• cc_calls table added (2f6eb09)

EVENT_RABBITMQ module

• The rabbitmq module can now send messages to different exchanges . You can simply specify the exchange you want to use in the socket url. More information here ...

MI_JSON module

• Full rework (459dffb)

• Added priority column (6dc7261)

• dp_translate(): the "id" parameter may now also be given as a plain int (2923d41)

• Reworked the FIFO handling - added support for detecting if the FIFO file gets deleted ( for re-creating it ), and also added SIGHUP signal handling for re-creating and re-opening of the FIFO file.

MSILO module

• Added support for external body (2e4b2d5)

RTPPROXY module

• rtpproxy_enable MI command : optional set_id param added (28a974b)

• New shm_check MI function - To be used when running with memory debugging ( DBG_QM_MALLOC memory allocator ). Does a complete scan of the shared memory pool and aborts OpenSIPS on any encountered sign of memory corruption.

• Support for RFC 5031 urn:service URIs

• Support for RFC 5031 urn:service URIs -

• loadmodule statement ordering: eliminated! Modules can now be loaded in any order within the config script. Also added an easy-to-use module dependency specification logic for module developers! More information here ...

• rest_get() and rest_post() may now be used asynchronously. A usage example can be found in the module documentation.

• The emergency module provides emergency call treatment, following the architecture i2 specification of the american entity NENA(National Emergency Number Association). Read more here.

NEW EMERGENCY module

• The emergency module provides emergency call treatment, following the architecture i2 specification of the american entity NENA. (National Emergency Number Association). Read more here.

NEW FRAUD_DETECTION module

• A new module that helps you prevent fraud by detecting fraudulent calls based on dialing patterns. Read more here.

NEW COMPRESSION module

• Added a new compression module which does message compression and compaction. Read more here.

NEW COMPRESSION module

• Added a new compression module which does message compression and compaction. Read more here.

COMPRESSION module

USRLOC module

• Succesfully added compression module which does message compression and compaction. Read more

http://lists.opensips.org/pipermail/devel/2015-February/016340.html

• loadmodule statement ordering: eliminated! Modules can now be loaded in any order within the config script. Also added an easy module dependency specification logic for module developers! More information here ...

REST_CLIENT module

• rest_get() may now be used asynchronously. A usage example can be found in the module documentation.

• Asynchronous DB core and API: Primitives for managing async DB connection pools. To be used by SQL drivers when implementing the async DB API.

• avp_db_query() may now be used asynchronously. A usage example can be found in the module documentation.

• Loadmodule statement ordering: eliminated! Modules can now be loaded in any order within the config script. Also added an easy module dependency specification logic for module developers! More information here ...

• avp_db_query() may now be used asynchronously. For usage examples, please refer to the module documentation.

• The db_mysql module is now capable of doing asynchronous raw queries.

• Async DB core and API: Primitives for managing async DB connection pools. To be used by SQL drivers when implementing the async DB API.

AVPOPS module

• avp_db_query() may now be used asynchronously. For usage examples, please refer to the module documentation.

DB_MYSQL module

• The db_mysql module is now capable of doing asynchronous raw queries.

• Debugging levels: complete rework. They can now be set globally or individually (per process) using the debug MI command. More information here ...

• New $rT pseudo variable - Holds the current route type as a string. Useful for determining the original route type when inside another route in script - Allows for more generic and reusable routes. More information here ...
• New string transformation (s.fill) - Fills a string with a char/string until a given final length is reached. Refer to the transformations manual for usage examples

• You can now specify attributes from the domain names that can be used later on from the script. More information here ...

• The rabbitmq module can now send messages to different exchanges . You can simply specify the exchange you want to use in the socket url. More information here ...

• Call-ID topology hiding support was added within the dialog module - there are many cases where the callid contains IPs, thus revealing part of the network topology. More information here ...
• Added the ability to propagate various Contact URI parameters when doing topology hiding - helpful for preserving some end-to-end functionality relying on URI params. Read more here ...

• Routing is now partition based: you may specify which string translation rules want to use to route certain messages. Thus you can re-use the routing rules for various purposes, while keeping the provisioning and reloading part fully separate. More information here...
• New column: timerec. Allows time recurrence based enabling of dialplan rules (accepted strings are RFC 2445 compatible). Backwards-compatible with the previous DB schema. More information here...

• Routing is now partition based: you may specify by which partition's rules you want to route certain messages. Thus you can re-use the routing rules for various purposes, while keeping the provisioning and reloading part fully separate. More information here...

• Routing is now partition based: you may specify by which partition's rules you want to route certain messages. Thus you can re-use the routing rules for various purposes ( eg: separate routing, prefix matching, etc ), while keeping the provisioning and reloading part fully separate. More information here...
• Using the new MI function dr_reload_status you can get the time of the last "dr_reload" (update) for any partition. The feature is available even if you don't use partitions. More information here...
• A new MI function dr_number_routing was added which allows to simulate a do_routing() call, by fetching the list of the gateways / carriers to which a number would be routed. More information here...
• Added a new event to be triggered when the state of a gateway is changed ( either from MI or via probing triggered from script ). More information here...

• Added async event handling - Allows for running the events in an asynchronous mode ( in a dedicated process ). More information here ...

• Added a new event to be triggered when the state of a gateway is changed ( either from MI or via probing triggered from script ). More information here ...

• The sipmsg_validate function can now be used to check the From, To and Contact headers. More information here...
• All the Codec related functions accepting regexps can now also accept pseudovariables containing the regex - allowing for fetching the REGEXPs from various sources ( eg. Database ). Read more here ...

• Added per contact events - raised when a new contact is inserted / updated / deleted. Read more here ...

Devel Plan 2.4 release (TODO list)

About -> Available Versions -> 2.4.x Releases -> Release 2.4.0

About -> Available Versions -> 1.12.x Releases -> Release 2.4.0

This page has been visited 7124 times. (:toc-float Table of Content:)

Migration from 1.11.x to 2.4.0

To be done on release date.

What is new in 2.4.0

Core

• Debugging levels: complete rework. They can now be set globally or individually (per process) using the debug MI command. More information here ...
• Loadmodule statement ordering: eliminated! Modules can now be loaded in any order within the config script. Also added an easy module dependency specification logic for module developers! More information here ...
• New shm_check MI function - To be used when running with memory debugging ( DBG_QM_MALLOC memory allocator ). Does a complete scan of the shared memory pool and aborts OpenSIPS on any encountered memory error.

Script

• New assert(statement, message) function - If statement does not hold, OpenSIPS can just print the message or even abort (if abort_on_assert is set to true).
• New $rT pseudo variable - Holds the current route type as a string. Useful for determining the original route type when inside another route in script - Allows for more generic and reusable routes. More information here ...
• New string transformation (s.fill) - Fills a string with a char/string until a given final length is reached. Refer to the transformations manual for usage examples

NEW RTPENGINE module

• A new module that enables media streams to be proxied via RTPENGINE

CACHEDB_SQL module

• Full rework of the module, including a better usage of the CACHEDB interface, and also allowing for multiple DB connections to be used from script.

DOMAIN module

• You can now specify attributes from the domain names that can be used later on from the script. More information here ...

EVENT_RABBITMQ module

• The rabbitmq module can now send messages to different exchanges . You can simply specify the exchange you want to use in the socket url. More information here ...

DIALOG module

• Call-ID topology hiding support was added within the dialog module - there are many cases where the callid contains IPs, thus revealing part of the network topology. More information here ...
• Added the ability to propagate various Contact URI parameters when doing topology hiding - helpful for preserving some end-to-end functionality relying on URI params. Read more here ...

DIALPLAN module

• Routing is now partition based: you may specify which string translation rules want to use to route certain messages. Thus you can re-use the routing rules for various purposes, while keeping the provisioning and reloading part fully separate. More information here...
• New column: timerec. Allows time recurrence based enabling of dialplan rules (accepted strings are RFC 2445 compatible). Backwards-compatible with the previous DB schema. More information here...

DISPATCHER module

• Routing is now partition based: you may specify by which partition's rules you want to route certain messages. Thus you can re-use the routing rules for various purposes, while keeping the provisioning and reloading part fully separate. More information here...

DROUTING module

• Routing is now partition based: you may specify by which partition's rules you want to route certain messages. Thus you can re-use the routing rules for various purposes ( eg: separate routing, prefix matching, etc ), while keeping the provisioning and reloading part fully separate. More information here...
• Using the new MI function dr_reload_status you can get the time of the last "dr_reload" (update) for any partition. The feature is available even if you don't use partitions. More information here...
• A new MI function dr_number_routing was added which allows to simulate a do_routing() call, by fetching the list of the gateways / carriers to which a number would be routed. More information here...
• Added a new event to be triggered when the state of a gateway is changed ( either from MI or via probing triggered from script ). More information here...

EVENT_ROUTE module

• Added async event handling - Allows for running the events in an asynchronous mode ( in a dedicated process ). More information here ...

LOAD_BALANCER module

• Added a new event to be triggered when the state of a gateway is changed ( either from MI or via probing triggered from script ). More information here ...

MI_FIFO module

• Reworked the FIFO handling - added support for detecting if the FIFO file gets deleted ( for re-creating it ), and also added SIGHUP signal handling for re-creating and re-opening of the FIFO file.

SIPMSGOPS module

• The sipmsg_validate function can now be used to check the From, To and Contact headers. More information here...
• All the Codec related functions accepting regexps can now also accept pseudovariables containing the regex - allowing for fetching the REGEXPs from various sources ( eg. Database ). Read more here ...

SIPTRACE module

• Split the fromip and toip DB columns ( which previously contained IP & port ) into two separate columns containing IP and port - thus allowing for faster database searches based on IPs.

UAC module

• When using the uac_auth() for having OpenSIPS do SIP authentication, the CSEQ number will be increased for subsequent authentication requests - thus fixing various downstream issues ( eg. Asterisk treating the AUTH request as a retransmission due to the same CSEQ number ).

USRLOC module

• Added per contact events - raised when a new contact is inserted / updated / deleted. Read more here ...

Devel Plan 1.12 release (TODO list)