Distributed Message Queue Module

Marius Ovidiu Bucur

Charles Chance

   Sipcentric Ltd.

Olle E. Johansson

   Edvina AB

Edited by

Marius Ovidiu Bucur

Charles Chance

   Copyright © 2011 Marius Bucur

   Copyright © 2013 Charles Chance, Sipcentric Ltd.

   Copyright © 2015 Olle E. Johansson, Edvina AB
     __________________________________________________________________

   Table of Contents

   1. Admin Guide

        1. Overview
        2. Dependencies

              2.1. Kamailio Modules
              2.2. External Libraries or Applications

        3. Parameters

              3.1. server_address(str)
              3.2. notification_address(str)
              3.3. multi_notify(int)
              3.4. num_workers(int)
              3.5. worker_usleep(int)
              3.6. ping_interval(int)

        4. Functions

              4.1. dmq_handle_message([continue])
              4.2. dmq_send_message(peer, node, body, content_type)
              4.3. dmq_bcast_message(peer, body, content_type)
              4.4. dmq_t_replicate([skip_loop_test])
              4.5. dmq_is_from_node()

        5. RPC Commands

              5.1. dmq.list_nodes

   2. Developer Guide

        1. dmq_load_api(dmq_api_t* api)
        2. register_dmq_peer(dmq_peer_t* peer)
        3. bcast_message(dmq_peer_t* peer, str* body, dmq_node_t* except,
                dmq_resp_cback_t* resp_cback, int max_forwards, str*
                content_type)

        4. send_message(dmq_peer_t* peer, str* body, dmq_node_t* node,
                dmq_resp_cback_t* resp_cback, int max_forwards, str*
                content_type)

   List of Examples

   1.1. Example of a KDMQ message
   1.2. Set server_address parameter
   1.3. Set notification_address parameter
   1.4. Set multi_notify parameter
   1.5. Set num_workers parameter
   1.6. Set worker_usleep parameter
   1.7. Set ping_interval parameter
   1.8. dmq_handle_message usage
   1.9. dmq_send_message usage
   1.10. dmq_bcast_message usage
   1.11. dmq_t_replicate usage
   1.12. dmq_is_from_node usage
   1.13. dmq.list_nodes usage
   2.1. dmq_api_t structure
   2.2. register_dmq_peer usage
   2.3. bcast_message usage
   2.4. send_message usage

Chapter 1. Admin Guide

   Table of Contents

   1. Overview
   2. Dependencies

        2.1. Kamailio Modules
        2.2. External Libraries or Applications

   3. Parameters

        3.1. server_address(str)
        3.2. notification_address(str)
        3.3. multi_notify(int)
        3.4. num_workers(int)
        3.5. worker_usleep(int)
        3.6. ping_interval(int)

   4. Functions

        4.1. dmq_handle_message([continue])
        4.2. dmq_send_message(peer, node, body, content_type)
        4.3. dmq_bcast_message(peer, body, content_type)
        4.4. dmq_t_replicate([skip_loop_test])
        4.5. dmq_is_from_node()

   5. RPC Commands

        5.1. dmq.list_nodes

1. Overview

   The DMQ module implements a distributed message queue on top of
   Kamailio in order to enable the passing/replication of data between
   multiple instances. The DMQ "nodes" within the system are grouped in a
   logical entity called the DMQ "bus" and are able to communicate with
   each other by sending/receiving messages (either by broadcast or
   directly to a specific node). The system transparently deals with node
   discovery, consistency, retransmissions, etc.

   Other entities ("peers") are then able to utilize the DMQ bus to pass
   messages between themselves. Peers are grouped by name in order to
   ensure the correct messages are passed to the relevant peers. This
   grouping of peers can be compared to a topic in a typical pub/sub
   system.

   DMQ sends SIP requests using the KDMQ request method, that is private
   to Kamailio.

   Example 1.1. Example of a KDMQ message

   This message is for basic DMQ bus handling. Other messages are produced
   by other modules, like the htable module.
KDMQ sip:notification_peer@192.168.40.15:5090 SIP/2.0
Via: SIP/2.0/UDP 192.168.40.15;branch=z9hG4bK55e5.423d95110000
To: <sip:notification_peer@192.168.40.15:5090>
From: <sip:notification_peer@192.168.40.15:5060>;tag=2cdb7a33a7f21abb98fd3a44968
e3ffd-5b01
CSeq: 10 KDMQ
Call-ID: 1fe138e07b5d0a7a-50419@192.168.40.15
Content-Length: 116
User-Agent: kamailio (4.3.0 (x86_64/linneaus))
Max-Forwards: 1
Content-Type: text/plain

sip:192.168.40.16:5060;status=active
sip:192.168.40.15:5060;status=disabled
sip:192.168.40.17:5060;status=active

2. Dependencies

   2.1. Kamailio Modules
   2.2. External Libraries or Applications

2.1. Kamailio Modules

   The following modules must be loaded before this module:
     * sl.
     * tm.

2.2. External Libraries or Applications

     * The DMQ module itself has no external dependencies. However, each
       peer will need to use its own (de)serialization mechanism. Some
       examples are libtpl, protobuf. .

3. Parameters

   3.1. server_address(str)
   3.2. notification_address(str)
   3.3. multi_notify(int)
   3.4. num_workers(int)
   3.5. worker_usleep(int)
   3.6. ping_interval(int)

3.1. server_address(str)

   The local server address. This is the interface over which the DMQ
   engine will send/receive messages.

   Default value is “NULL”.

   Example 1.2. Set server_address parameter
...
modparam("dmq", "server_address", "sip:10.0.0.20:5060")
...

3.2. notification_address(str)

   The address of another DMQ node from which the local node should
   retrieve initial information about all other nodes.

   Default value is “NULL”.

   Example 1.3. Set notification_address parameter
...
modparam("dmq", "notification_address", "sip:10.0.0.21:5060")
...

3.3. multi_notify(int)

   Enables the ability to resolve multiple IPv4/IPv6 addresses for a
   single notification address.

   A value of zero resolves to the first IP address found. A non-zero
   value resolves to all IP addresses associated with the host. This
   includes addresses from DNS SRV records, A and AAAA records.

   Default value is “0”.

   Example 1.4. Set multi_notify parameter
...
modparam("dmq", "multi_notify", 1)
...

3.4. num_workers(int)

   The number of worker threads for sending/receiving messages.

   Default value is “2”.

   Example 1.5. Set num_workers parameter
...
modparam("dmq", "num_workers", 4)
...

3.5. worker_usleep(int)

   The default locking/synchronisation mechanism between producer/consumer
   threads is the optimum for most environments. On some systems (e.g.
   FreeBSD) it can cause high CPU load and in such cases, it can be useful
   to disable locking and switch to polling for tasks at set intervals
   instead - putting the thread to sleep in-between and taking it out of
   process during that time.

   A value >0 will disable the default locking and set the polling
   interval (in microseconds), which can be tuned to suit the specific
   environment.

   Default value is 0 (recommended for most systems).

   Example 1.6. Set worker_usleep parameter
...
modparam("dmq", "worker_usleep", 1000)
...

3.6. ping_interval(int)

   The number of seconds between node pings (for checking status of other
   nodes).

   Minimum value is “60” (default).

   Example 1.7. Set ping_interval parameter
...
modparam("dmq", "ping_interval", 90)
...

4. Functions

   4.1. dmq_handle_message([continue])
   4.2. dmq_send_message(peer, node, body, content_type)
   4.3. dmq_bcast_message(peer, body, content_type)
   4.4. dmq_t_replicate([skip_loop_test])
   4.5. dmq_is_from_node()

4.1.  dmq_handle_message([continue])

   Handles a DMQ message by passing it to the appropriate local peer
   (module). The peer is identified by the user part of the To header.

   Meaning of parameters:
     * continue - by default, dmq_handle_message() will end execution of
       routing script. If this optional parameter is set to "1",
       dmq_handle_message() will continue executing the routing script
       after it's been called.

   This function can be used from REQUEST_ROUTE.

   Example 1.8. dmq_handle_message usage
...
        if(is_method("KDMQ"))
        {
                dmq_handle_message();
        }
...

4.2.  dmq_send_message(peer, node, body, content_type)

   Sends a DMQ message directly from config file to a single node.

   Meaning of parameters:
     * peer - name of peer that should handle the message.
     * node - the node to which the message should be sent.
     * body - the message body.
     * content_type - the MIME type of the message body.

   This function can be used from any route.

   Example 1.9. dmq_send_message usage
...
        dmq_send_message("peer_name", "sip:10.0.0.21:5060", "Message body...", "
text/plain");
...

4.3.  dmq_bcast_message(peer, body, content_type)

   Broadcasts a DMQ message from config file to all active nodes (except
   self).

   Meaning of parameters:
     * peer - name of peer that should handle the message.
     * body - the message body.
     * content_type - the MIME type of the message body.

   This function can be used from any route.

   Example 1.10. dmq_bcast_message usage
...
        dmq_bcast_message("peer_name", "Message body...", "text/plain");
...

4.4.  dmq_t_replicate([skip_loop_test])

   Replicates the current SIP message to all active nodes (except self).
   Useful for replicating REGISTER, PUBLISH etc. in a clustered
   environment.

   Meaning of parameters:
     * skip_loop_test - by default, DMQ checks the source IP of the
       message prior to replication, to ensure it has not been sent by
       another DMQ node (to avoid infinite loops). If this optional
       parameter is set to "1", the loop test is not performed. This makes
       sense, from a performance perspective, if you have already
       performed the necessary checks in the config script (see
       dmq_is_from_node()).

   This function can be used from REQUEST_ROUTE only.

   Example 1.11. dmq_t_replicate usage
...
        dmq_t_replicate();
...

4.5.  dmq_is_from_node()

   Checks whether the current message has been sent by another DMQ node in
   the cluster.

   This function can be used from REQUEST_ROUTE only.

   Example 1.12. dmq_is_from_node usage
...
        # Example REGISTER block
        if (dmq_is_from_node()) {
                # Already authenticated, just save contact...
        } else {
                # Authenticate, save contact etc.
                # Assuming all successful...
                dmq_t_replicate("1"); # Already checked source, don't perform lo
op test again
        }
...

5. RPC Commands

   5.1. dmq.list_nodes

5.1. dmq.list_nodes

   List the DMQ nodes. It has no parameters.

   Example 1.13. dmq.list_nodes usage
...
kamcmd dmq.list_nodes
...

Chapter 2. Developer Guide

   Table of Contents

   1. dmq_load_api(dmq_api_t* api)
   2. register_dmq_peer(dmq_peer_t* peer)
   3. bcast_message(dmq_peer_t* peer, str* body, dmq_node_t* except,
          dmq_resp_cback_t* resp_cback, int max_forwards, str*
          content_type)

   4. send_message(dmq_peer_t* peer, str* body, dmq_node_t* node,
          dmq_resp_cback_t* resp_cback, int max_forwards, str*
          content_type)

   The module provides the following functions that can be used in other
   Kamailio modules.

1.  dmq_load_api(dmq_api_t* api)

   This function binds the DMQ module and fills the structure with the
   exported functions below.

   Example 2.1. dmq_api_t structure
...
typedef struct dmq_api {
        register_dmq_peer_t register_dmq_peer;
        bcast_message_t bcast_message;
        send_message_t send_message;
} dmq_api_t;
...

2.  register_dmq_peer(dmq_peer_t* peer)

   Registers an entity as a DMQ peer which permits receiving/sending
   messages between nodes which support the same peer.

   Example 2.2. register_dmq_peer usage
...
        Example to follow.
...

3.  bcast_message(dmq_peer_t* peer, str* body, dmq_node_t* except,
dmq_resp_cback_t* resp_cback, int max_forwards, str* content_type)

   Broadcast a DMQ message to all nodes in the DMQ bus excluding self,
   inactive nodes and "except" if specified.

   Example 2.3. bcast_message usage
...
        Example to follow.
...

4.  send_message(dmq_peer_t* peer, str* body, dmq_node_t* node,
dmq_resp_cback_t* resp_cback, int max_forwards, str* content_type)

   Send a DMQ message to a single node.

   Example 2.4. send_message usage
...
        Example to follow.
...