Browse Source

mqueue: README update

Olle E. Johansson 12 years ago
parent
commit
e09b92893f
1 changed files with 13 additions and 12 deletions
  1. 13 12
      modules/mqueue/README

+ 13 - 12
modules/mqueue/README

@@ -72,12 +72,13 @@ Chapter 1. Admin Guide
 
 
 1. Overview
 1. Overview
 
 
-   This module offers generic message queue system in shared memory for
-   inter-process communication via config file. One example of usage is to
-   send time consuming operations to a timer process that consumes items
-   in the queue, without affecting SIP message handling.
+   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 defined many queues, access to values being done via
+   There can be many defined queues. Access to queued values is done via
    pseudo variables.
    pseudo variables.
 
 
 2. Dependencies
 2. Dependencies
@@ -102,7 +103,7 @@ Chapter 1. Admin Guide
 
 
 3.1. mqueue (string)
 3.1. mqueue (string)
 
 
-   Definition of memory queue
+   Definition of a memory queue
 
 
    Default value is "none".
    Default value is "none".
 
 
@@ -111,7 +112,7 @@ Chapter 1. Admin Guide
    specifies the maximum number of items in queue, if it is execeeded the
    specifies the maximum number of items in queue, if it is execeeded the
    oldest one is removed.
    oldest one is removed.
 
 
-   The parameter can be set many time, each holding the definition of one
+   The parameter can be set many times, each holding the definition of one
    queue.
    queue.
 
 
    Example 1.1. Set mqueue parameter
    Example 1.1. Set mqueue parameter
@@ -127,7 +128,7 @@ modparam("mqueue", "mqueue", "name=qaz")
    4.3. mq_pv_free(queue)
    4.3. mq_pv_free(queue)
    4.4. mq_size(queue)
    4.4. mq_size(queue)
 
 
-4.1. mq_add(queue, key, value)
+4.1.  mq_add(queue, key, value)
 
 
    Add a new item (key, value) in the queue. If max size of queue is
    Add a new item (key, value) in the queue. If max size of queue is
    exceeded, the oldest one is removed.
    exceeded, the oldest one is removed.
@@ -137,7 +138,7 @@ modparam("mqueue", "mqueue", "name=qaz")
 mq_add("myq", "$rU", "call from $fU");
 mq_add("myq", "$rU", "call from $fU");
 ...
 ...
 
 
-4.2. mq_fetch(queue)
+4.2.  mq_fetch(queue)
 
 
    Take oldest item from queue and fill $mqk(queue) and $mqv(queue) pseudo
    Take oldest item from queue and fill $mqk(queue) and $mqv(queue) pseudo
    variables.
    variables.
@@ -153,17 +154,17 @@ while(mq_fetch("myq"))
 }
 }
 ...
 ...
 
 
-4.3. mq_pv_free(queue)
+4.3.  mq_pv_free(queue)
 
 
    Free the item fetched in pseudo-variables. It is optional, a new fetch
    Free the item fetched in pseudo-variables. It is optional, a new fetch
-   frees the old values.
+   frees the previous values.
 
 
    Example 1.4. mq_pv_free usage
    Example 1.4. mq_pv_free usage
 ...
 ...
 mq_pv_free("myq");
 mq_pv_free("myq");
 ...
 ...
 
 
-4.4. mq_size(queue)
+4.4.  mq_size(queue)
 
 
    Returns the current number of elements in the mqueue.
    Returns the current number of elements in the mqueue.