Module: kamailio
Branch: master
Commit: 39f2053769ea45b1d75a0b73f7f7c14397546b4e
URL: 
https://github.com/kamailio/kamailio/commit/39f2053769ea45b1d75a0b73f7f7c14397546b4e

Author: Kamailio Dev <kamailio....@kamailio.org>
Committer: Kamailio Dev <kamailio....@kamailio.org>
Date: 2024-10-15T14:01:10+02:00

modules: readme files regenerated - siputils ... [skip ci]

---

Modified: src/modules/siputils/README

---

Diff:  
https://github.com/kamailio/kamailio/commit/39f2053769ea45b1d75a0b73f7f7c14397546b4e.diff
Patch: 
https://github.com/kamailio/kamailio/commit/39f2053769ea45b1d75a0b73f7f7c14397546b4e.patch

---

diff --git a/src/modules/siputils/README b/src/modules/siputils/README
index f66c7391747..2ab1d707a9a 100644
--- a/src/modules/siputils/README
+++ b/src/modules/siputils/README
@@ -36,6 +36,8 @@ Bogdan-Andrei Iancu
 
 Gabriel Vasile
 
+Eik Rentzow
+
    Copyright ?? 2008, 2005, 2003 1&1 Internet AG, FhG Fokus, Voice Sistem
    SRL
      __________________________________________________________________
@@ -116,6 +118,7 @@ Gabriel Vasile
               5.3. $pcv(genaddr)
               5.4. $pcv(orig)
               5.5. $pcv(term)
+              5.6. $pcv(status)
 
    List of Examples
 
@@ -249,6 +252,7 @@ Chapter 1. Admin Guide
         5.3. $pcv(genaddr)
         5.4. $pcv(orig)
         5.5. $pcv(term)
+        5.6. $pcv(status)
 
 1. Overview
 
@@ -1089,7 +1093,19 @@ if(is_first_hop("1")) { ... }
 4.37.  sip_p_charging_vector(flags)
 
    Manage the P-Charging-Vector header (RFC7315). The flags can be: 'r' -
-   remove; 'g' - generate; 'f' - force (remove + generate).
+   remove; 'g' - generate; 'f' - force (remove + generate). Once a new PCV
+   has been generated by 'g' or 'f' the PCV cannot be changed again. The
+   icid-generated-at parameter of a generated PCV will be set to the
+   sending interface.IP address.
+
+   Return Codes:
+     * 1 - Nothing was done.
+     * (2 - intentionally left out)
+     * 3 - P-Charging-Vector header has been newly generated.
+     * 4 - P-Charging-Vector header has been deleted.
+     * 5 - P-Charging-Vector header has been replaced or inserted after
+       deletion.
+     * negative - Any error occured during execution.
 
    This function can be used from ANY_ROUTE.
 
@@ -1227,6 +1243,7 @@ if (sip_parse_headers()) {
    5.3. $pcv(genaddr)
    5.4. $pcv(orig)
    5.5. $pcv(term)
+   5.6. $pcv(status)
 
 5.1. $pcv(all)
 
@@ -1247,3 +1264,16 @@ if (sip_parse_headers()) {
 5.5. $pcv(term)
 
    term-ioi field (see RFC7315 section 5.6)
+
+5.6. $pcv(status)
+
+   Returns whether the PCV header was successfully parsed, deleted, newly
+   generated or other.
+     * 0 - No P-Charging-Vector header in message.
+     * 1 - P-Charging-Vector header in message and parsed successfully.
+     * 2 - P-Charging-Vector is present, but has no valid icid-value
+       parameter.
+     * 3 - P-Charging-Vector header has been newly generated or replaced.
+     * 4 - P-Charging-Vector header has been deleted.
+
+   Negative values indicate an internal error during the parsing process.

_______________________________________________
Kamailio (SER) - Development Mailing List
To unsubscribe send an email to sr-dev-le...@lists.kamailio.org

Reply via email to