sip_branchid(3sip) [opensolaris man page]

sip_branchid(3SIP)				   Session Initiation Protocol Library Functions				sip_branchid(3SIP)

NAME

       sip_branchid - generate a RFC 3261 complaint branch ID

SYNOPSIS

       cc [ flag ... ] file ... -lsip [ library ... ]
       #include <sip.h>

       char *sip_branchid(sip_msg_t sip_msg);

DESCRIPTION

       The sip_branchid() function can be used to generate a value for the branch parameter for a VIA header. The returned string is prefixed with
       z9hG4bK to conform to RFC 3261. If sip_msg is null or sip_msg does not have a VIA header, a random value is generated. Otherwise, the value
       is  generated  using  the MD5 hash of the VIA, FROM, CALL-ID, CSEQ headers and the URI from the request line. The caller is responsible for
       freeing the returned string.

RETURN VALUES

       The sip_branchid() function returns a string on success and NULL on failure.

       The value of errno is not changed by these calls in the event of an error.

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_branchid(3SIP)

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)