2
0
Эх сурвалжийг харах

corex: readme regenerated

Daniel-Constantin Mierla 10 жил өмнө
parent
commit
670fab03c6
1 өөрчлөгдсөн 14 нэмэгдсэн , 16 устгасан
  1. 14 16
      modules/corex/README

+ 14 - 16
modules/corex/README

@@ -16,7 +16,7 @@ Muhammad Shahzad Shafi
 
 
    <[email protected]>
    <[email protected]>
 
 
-   Copyright (c) 2012 asipto.com
+   Copyright © 2012 asipto.com
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -229,7 +229,7 @@ modparam("corex", "msg_avp", "$avp(msg)")
    4.7. msg_iflag_reset(flagname)
    4.7. msg_iflag_reset(flagname)
    4.8. msg_iflag_is_set(flagname)
    4.8. msg_iflag_is_set(flagname)
 
 
-4.1.  append_branch([ uri, [ q ] ])
+4.1. append_branch([ uri, [ q ] ])
 
 
    Append a new branch to the destination set, useful to build the set of
    Append a new branch to the destination set, useful to build the set of
    destination addresses for parallel forking or redirect replies.
    destination addresses for parallel forking or redirect replies.
@@ -251,7 +251,7 @@ modparam("corex", "msg_avp", "$avp(msg)")
     append_branch("$avp(uri)", "0.5");
     append_branch("$avp(uri)", "0.5");
 ...
 ...
 
 
-4.2.  send([ host [ :port ] ])
+4.2. send([ host [ :port ] ])
 
 
    Send the original SIP message to a specific destination in stateless
    Send the original SIP message to a specific destination in stateless
    mode. No changes are applied to received message, no Via header is
    mode. No changes are applied to received message, no Via header is
@@ -273,12 +273,12 @@ modparam("corex", "msg_avp", "$avp(msg)")
         send("$var(res)");
         send("$var(res)");
 ...
 ...
 
 
-4.3.  send_tcp([ host [ :port ] ])
+4.3. send_tcp([ host [ :port ] ])
 
 
    This function is identical to send() described above, except that it
    This function is identical to send() described above, except that it
    sends the SIP message using the TCP protocol instead of UDP.
    sends the SIP message using the TCP protocol instead of UDP.
 
 
-4.4.  send_data(uri, data)
+4.4. send_data(uri, data)
 
 
    Send the data to address specified by uri. Both parameters can contain
    Send the data to address specified by uri. Both parameters can contain
    pseudo-variables. The uri parameter has to be a valid SIP URI. The data
    pseudo-variables. The uri parameter has to be a valid SIP URI. The data
@@ -291,7 +291,7 @@ modparam("corex", "msg_avp", "$avp(msg)")
         send_data("sip:example.com:5070;transport=sctp", "Message at $Ts");
         send_data("sip:example.com:5070;transport=sctp", "Message at $Ts");
 ...
 ...
 
 
-4.5.  is_incoming()
+4.5. is_incoming()
 
 
    Returns true if contents of message buffer $mb are the data received
    Returns true if contents of message buffer $mb are the data received
    from remote host, otherwise false indicating that the contents of $mb
    from remote host, otherwise false indicating that the contents of $mb
@@ -313,7 +313,7 @@ event_route[network:msg] {
 }
 }
 ...
 ...
 
 
-4.6.  msg_iflag_set(flagname)
+4.6. msg_iflag_set(flagname)
 
 
    Set internal SIP message flag. The parameter flagname can be:
    Set internal SIP message flag. The parameter flagname can be:
    USE_UAC_FROM, USE_UAC_TO or UAC_AUTH.
    USE_UAC_FROM, USE_UAC_TO or UAC_AUTH.
@@ -330,7 +330,7 @@ event_route[network:msg] {
     msg_iflag_set("UAC_AUTH");
     msg_iflag_set("UAC_AUTH");
 ...
 ...
 
 
-4.7.  msg_iflag_reset(flagname)
+4.7. msg_iflag_reset(flagname)
 
 
    Reset the internal flag given as parameter.
    Reset the internal flag given as parameter.
 
 
@@ -341,7 +341,7 @@ event_route[network:msg] {
     msg_iflag_reset("UAC_AUTH");
     msg_iflag_reset("UAC_AUTH");
 ...
 ...
 
 
-4.8.  msg_iflag_is_set(flagname)
+4.8. msg_iflag_is_set(flagname)
 
 
    Test if the internal flag given as parameter is set.
    Test if the internal flag given as parameter is set.
 
 
@@ -352,8 +352,6 @@ event_route[network:msg] {
     if(msg_iflag_is_set("UAC_AUTH")) { ... }
     if(msg_iflag_is_set("UAC_AUTH")) { ... }
 ...
 ...
 
 
-   - ("flagname") - ("flagname")
-
 5. RPC Commands
 5. RPC Commands
 
 
    5.1. corex.list_sockets
    5.1. corex.list_sockets
@@ -361,28 +359,28 @@ event_route[network:msg] {
    5.3. corex.shm_status
    5.3. corex.shm_status
    5.4. corex.shm_summary
    5.4. corex.shm_summary
 
 
-5.1.  corex.list_sockets
+5.1. corex.list_sockets
 
 
    Print the list of sockets the application is listening on.
    Print the list of sockets the application is listening on.
 
 
    Example:
    Example:
                 kamcmd corex.list_sockets
                 kamcmd corex.list_sockets
 
 
-5.2.  corex.list_aliases
+5.2. corex.list_aliases
 
 
    Print the list of hostname aliases used to match the myself condition.
    Print the list of hostname aliases used to match the myself condition.
 
 
    Example:
    Example:
                 kamcmd corex.list_aliases
                 kamcmd corex.list_aliases
 
 
-5.3.  corex.shm_status
+5.3. corex.shm_status
 
 
    Trigger shm status dump to syslog.
    Trigger shm status dump to syslog.
 
 
    Example:
    Example:
                 kamcmd corex.shm_status
                 kamcmd corex.shm_status
 
 
-5.4.  corex.shm_summary
+5.4. corex.shm_summary
 
 
    Trigger shm summary dump to syslog.
    Trigger shm summary dump to syslog.
 
 
@@ -393,7 +391,7 @@ event_route[network:msg] {
 
 
    6.1. event_route[network:msg]
    6.1. event_route[network:msg]
 
 
-6.1.  event_route[network:msg]
+6.1. event_route[network:msg]
 
 
    Event route block to be executed when new data is received from network
    Event route block to be executed when new data is received from network
    or the data that is about to be sent to a remote host by a SIP worker
    or the data that is about to be sent to a remote host by a SIP worker