Table of Contents
List of Examples
mqueue parametermq_add usagemq_fetch usagemq_pv_free usagemq_size usagemqueue.get_size usageTable of Contents
The mqueue module offers a generic message queue system in shared memory for inter-process communication using the config file. One example of usage is to send time consuming operations to one or several timer processes that consumes items in the queue, without affecting SIP message handling in the socket-listening process.
There can be many defined queues. Access to queued values is done via pseudo variables.
Definition of a memory queue
Default value is “none”.
Value must be a list of parameters: attr=value;...
Mandatory attributes:
name: name of the queue.
Optional attributes:
size: size of the queue. Specifies the maximum number of items in queue. If execeeded the oldest one is removed. If not set the queue will be limitless.
The parameter can be set many times, each holding the definition of one queue.
Example 1.1. Set mqueue parameter
...
modparam("mqueue", "mqueue", "name=myq;size=20;")
modparam("mqueue", "mqueue", "name=qaz")
...
Add a new item (key, value) in the queue. If max size of queue is exceeded, the oldest one is removed.
Take oldest item from queue and fill $mqk(queue) and $mqv(queue) pseudo variables.
Return: true on success (1); false on failure (-1) or no item fetched (-2).
Free the item fetched in pseudo-variables. It is optional, a new fetch frees the previous values.
Exported pseudo-variables are documented at https://www.kamailio.org/wiki/.