sip_add_branchid_to_via(3sip) [opensolaris man page]
sip_add_branchid_to_via(3SIP) Session Initiation Protocol Library Functions 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(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Committed | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ SEE ALSO
libsip(3LIB) SunOS 5.11 25 Jan 2007 sip_add_branchid_to_via(3SIP)
Check Out this Related Man Page
sip_get_num_via(3SIP) Session Initiation Protocol Library Functions sip_get_num_via(3SIP) NAME
sip_get_num_via, sip_get_branchid - get VIA header specific attributes SYNOPSIS
cc [ flag ... ] file ... -lsip [ library ... ] #include <sip.h> int sip_get_num_via(sip_msg_t sip_msg, int *error); char *sip_get_branchid(sip_msg_t sip_msg, int *error); DESCRIPTION
The sip_get_num_via() function returns the number of VIA headers in the SIP message sip_msg. The sip_get_branchid() function returns the branch ID value from the topmost VIA header. The caller is responsible for freeing the returned string. RETURN VALUES
The sip_get_num_via() function returns the number of VIA headers on success. The sip_get_branchid() function returns the branch ID on success and NULL on failure. The value of errno is not changed by these calls in the event of an error. ERRORS
If the error is non-null, one of the following values is set: EINVAL The sip_msg is NULL. ENOENT For the sip_get_branchid function, there is no VIA header or the VIA header has no branch parameter. EPROTO For the sip_sip_get_trans.3sipget_branchid function, the VIA value is invalid. The parser encountered an error or errors while parsing the VIA header. ENOMEM For the sip_get_branchid function, there is an error in allocating memory for the branch ID. On success, the value of the location pointed to by error is set to 0. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Committed | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ SEE ALSO
libsip(3LIB) SunOS 5.11 23 Jan 2007 sip_get_num_via(3SIP)