SIP_ADD_BRANCHID_TO_VIA(3SIP) Session Initiation Protocol Library Functions
sip_add_branchid_to_via - add a branch parameter to the topmost VIA
header in the SIP message
cc [ flag ... ] file ... -lsip [ library ... ]
#include <sip.h>
int sip_add_branchid_to_via(sip_msg_t sip_msg, char *branchid);
The sip_add_branchid_to_via() function adds a branch param to the
topmost VIA header in the SIP message sip_msg. Note that a new header
is created as a result of adding the branch parameter and the old
header is marked deleted. Applications with multiple threads working
on the same VIA header need to take note of this.
These functions return 0 on success and the appropriate error value
on failure.
On failure, functions that return an error value may return one of
the following:
EINVAL
Mandatory parameters are not provided or are NULL.
For sip_add_branchid_to_via(), the topmost VIA header
already has a branch param or the SIP message does not have
a VIA header.
EPERM
The message cannot be modified.
ENOMEM
There is an error allocating memory for creating
headers/parameters.
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+
libsip(3LIB)
January 25, 2007 SIP_ADD_BRANCHID_TO_VIA(3SIP)
NAME
sip_add_branchid_to_via - add a branch parameter to the topmost VIA
header in the SIP message
SYNOPSIS
cc [ flag ... ] file ... -lsip [ library ... ]
#include <sip.h>
int sip_add_branchid_to_via(sip_msg_t sip_msg, char *branchid);
DESCRIPTION
The sip_add_branchid_to_via() function adds a branch param to the
topmost VIA header in the SIP message sip_msg. Note that a new header
is created as a result of adding the branch parameter and the old
header is marked deleted. Applications with multiple threads working
on the same VIA header need to take note of this.
RETURN VALUES
These functions return 0 on success and the appropriate error value
on failure.
ERRORS
On failure, functions that return an error value may return one of
the following:
EINVAL
Mandatory parameters are not provided or are NULL.
For sip_add_branchid_to_via(), the topmost VIA header
already has a branch param or the SIP message does not have
a VIA header.
EPERM
The message cannot be modified.
ENOMEM
There is an error allocating memory for creating
headers/parameters.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+--------------------+-----------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-----------------+
|Interface Stability | Committed |
+--------------------+-----------------+
|MT-Level | MT-Safe |
+--------------------+-----------------+
SEE ALSO
libsip(3LIB)
January 25, 2007 SIP_ADD_BRANCHID_TO_VIA(3SIP)