te
Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
sip_msg_to_str, sip_hdr_to_str, sip_reqline_to_str, sip_respline_to_str, sip_sent_by_to_str - return string representations

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);

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 responsible 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.

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.

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

ENOMEM

On success, the value of the location pointed to by error is set to 0.

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Interface Stability	Committed
MT-Level	MT-Safe

libsip(3LIB)