Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

sip_hdr_to_str(3sip) [opensolaris man page]

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

NAME

       sip_msg_to_str, sip_hdr_to_str, sip_reqline_to_str, sip_respline_to_str, sip_sent_by_to_str - return string representations

SYNOPSIS

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

       char *sip_msg_to_str(sip_msg_t sip_msg,
	    int *error);

       char *sip_hdr_to_str(sip_header_t sip_header,
	    int *error);

       char *sip_reqline_to_str(sip_msg_t sip_msg,
	    int *error);

       char *sip_respline_to_str(sip_msg_t sip_msg,
	    int *error);

       char *sip_sent_by_to_str(int *error);

DESCRIPTION

       The  sip_msg_to_str()  function	returns  the  string  representation  of  the SIP message sip_msg. Deleted headers are not included in the
       returned string. The caller is responsible for freeing the returned string.

       The sip_hdr_to_str() function returns the string representation of the SIP header sip_header. The caller is  responsible  for  freeing  the
       returned string.

       The sip_reqline_to_str() function returns the string representation of the request line from the SIP message sip_msg. The caller is respon-
       sible for freeing the returned string.

       The sip_respline_to_str() function returns the string representation of the response line from the  SIP	message  sip_msg.  The	caller	is
       responsible for freeing the returned string.

       The  sip_sent_by_to_str()  function  can be used to retrieve the list of sent-by values registered with the stack. The returned string is a
       comma separated list of sent-by values. The caller is responsible for freeing the returned string.

RETURN VALUES

       The sip_msg_to_str(), sip_hdr_to_str(), sip_reqline_to_str(), sip_respline_to_str(), and sip_sent_by_to_str() functions return the relevant
       string on success and NULL on failure.

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

ERRORS

       For  the  sip_msg_to_str(),  sip_hdr_to_str(),  sip_reqline_to_str(),  and sip_respline_to_str(), one of the following values is set if the
       error is non-null:

       EINVAL	 Input is null.

       ENOMEM	 Memory allocation failure.

       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							    25 Jan 2007 					      sip_msg_to_str(3SIP)

Check Out this Related Man Page

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

NAME

       sip_delete_start_line, sip_delete_header, sip_delete_header_by_name, sip_delete_value - delete a SIP header or a header value

SYNOPSIS

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

       int sip_delete_start_line(sip_msg_t sip_msg);

       int sip_delete_header(sip_msg_t sip_header);

       int sip_delete_header_by_name(sip_msg_t msg,
	    char *header_name);

       int sip_delete_value(sip_header_t sip_header,
	    sip_header_value_t sip_header_value);

DESCRIPTION

       The sip_delete_start_line() function deletes the start line, a request or a response line, from the SIP message sip_msg.

       The sip_delete_header() function deletes the SIP header specified by sip_header from the associated SIP message sip_msg.

       The  sip_delete_header_by_name()  function deletes the SIP header name specified by header_name (long or compact form) from the SIP message
       sip_msg.

       The sip_delete_value() deletes the SIP header value specified by sip_header_value from the SIP header sip_header.

       When a SIP header or value is deleted, the corresponding header or value is marked as deleted.  Lookups ignore headers or values  that  are
       marked as deleted.

RETURN VALUES

       These functions return 0 on success and the appropriate error on failure.

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

ERRORS

       On failure, the returned error could be one of the following:

       EINVAL	 If any of the required input is NULL.

		 If the header or value to be deleted does not exist.

		 If the header or value to be deleted has already been deleted.

       EPERM	 If the SIP message cannot be modified.

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							    20 Jan 2007 				       sip_delete_start_line(3SIP)
Man Page