The main goal of the module is to offload the intermediate header processing into the XAVI dynamic container as well as provide with high level methods and pseudovariables to simplify SIP message header modifications.
| Parámetro | Tipo | Descripción |
|---|---|---|
| xavi_name | string | 3.2. header_value_size (int) 3.3. header_collect_flag (int) 3.4. header_apply_flag (int) 3.5. skip_headers (string) 3.6. split_headers (string) 3.7. auto_msg (int) |
| header_value_size | int | 3.3. header_collect_flag (int) 3.4. header_apply_flag (int) 3.5. skip_headers (string) 3.6. split_headers (string) 3.7. auto_msg (int) |
| header_collect_flag | int | 3.4. header_apply_flag (int) 3.5. skip_headers (string) 3.6. split_headers (string) 3.7. auto_msg (int) |
| header_apply_flag | int | 3.5. skip_headers (string) 3.6. split_headers (string) 3.7. auto_msg (int) |
| skip_headers | string | 3.6. split_headers (string) 3.7. auto_msg (int) |
| split_headers | string | 3.7. auto_msg (int) |
| auto_msg | int | 3.1. xavi_name (string) |
| xavi_name | string | Name of the XAVI where the collected headers are stored. |
| header_value_size | int | Defines an internal maximum SIP header value size. Header values longer than this setting will be stripped down when collected or applied. |
| header_collect_flag | int | Used to mark that headers are collected for the SIP message, leading to subsequent headers collection on this message to be declined with an error. Should be used only in branches and replies. |
| header_apply_flag | int | Used to mark that headers are applied for the SIP message, leading to subsequent headers applies on this message to be declined with an error. Should be used only in branches and replies. |
| skip_headers | string | A comma separated headers list that must be excluded from processing (they are skipped when pvh_apply_headers() changes the SIP message headers). |
| split_headers | string | A comma separated headers list that must be split into multi headers if their value is a comma separated list. |
| auto_msg | int | Defines whether the headers are automatically collected for incoming messages, as well as automatically applied for forwarded messages. |
4.2. pvh_apply_headers() 4.3. pvh_reset_headers() 4.4. pvh_check_header(hname) 4.5. pvh_append_header(hname, hvalue) 4.6. pvh_modify_header(hname, hvalue, [idx]) 4.7. pvh_remove_header(hname, [idx]) 4.8. pvh_remove_all_headers() 4.9. pvh_header_param
4.3. pvh_reset_headers() 4.4. pvh_check_header(hname) 4.5. pvh_append_header(hname, hvalue) 4.6. pvh_modify_header(hname, hvalue, [idx]) 4.7. pvh_remove_header(hname, [idx]) 4.8. pvh_remove_all_headers() 4.9. pvh_header_param_exists(hname, hparameter
4.4. pvh_check_header(hname) 4.5. pvh_append_header(hname, hvalue) 4.6. pvh_modify_header(hname, hvalue, [idx]) 4.7. pvh_remove_header(hname, [idx]) 4.8. pvh_remove_all_headers() 4.9. pvh_header_param_exists(hname, hparameter) 4.10. pvh_remove_header
4.5. pvh_append_header(hname, hvalue) 4.6. pvh_modify_header(hname, hvalue, [idx]) 4.7. pvh_remove_header(hname, [idx]) 4.8. pvh_remove_all_headers() 4.9. pvh_header_param_exists(hname, hparameter) 4.10. pvh_remove_header_param(hname, hparameter)
4.6. pvh_modify_header(hname, hvalue, [idx]) 4.7. pvh_remove_header(hname, [idx]) 4.8. pvh_remove_all_headers() 4.9. pvh_header_param_exists(hname, hparameter) 4.10. pvh_remove_header_param(hname, hparameter)
4.7. pvh_remove_header(hname, [idx]) 4.8. pvh_remove_all_headers() 4.9. pvh_header_param_exists(hname, hparameter) 4.10. pvh_remove_header_param(hname, hparameter)
4.8. pvh_remove_all_headers() 4.9. pvh_header_param_exists(hname, hparameter) 4.10. pvh_remove_header_param(hname, hparameter)
4.9. pvh_header_param_exists(hname, hparameter) 4.10. pvh_remove_header_param(hname, hparameter)
4.10. pvh_remove_header_param(hname, hparameter)
4.1. pvh_collect_headers()
Collects all headers from the message into the XAVP. It should be used preferably just when the SIP message is received by Kamailio.
Applies the current XAVP headers state to the real headers. Should be called only once per branch when the message is about to leave Kamailio.
Collects all headers from the message into the XAVP. It should be used preferably just when the SIP message is received by >Kamailio.
Checks if the header “hname” already exists in the XAVP.
Appends a new header “hname” with the value “hvalue” into the XAVP. Please note that subsequent "pv_append_header" calls will result in multiple headers.
Modifies an existing header in the XAVP “hname” with the value “hvalue” into the XAVP. Index order is top to bottom. Please note that subsequent pvh_append_header calls will result in multiple headers.
Removes an existing header “hname” from the XAVP. Index order is top to bottom.
Removes all sip message headers.
Checks if the parameter “hparameter” is present in the header “hname” from XAVP.
Removes an existing parameter “hparameter” in the header “hname” from the XAVP.
Copyright © 2018 Sipwise GmbH
