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_parse_uri, sip_free_parsed_uri - parse a URI and free a parsed URI

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

sip_uri_t sip_parse_uri(sip_str_t *uri_str,
 int *error);

void sip_free_parsed_uri(sip_uri_t sip_uri);

For functions that return a pointer of type sip_str_t, sip_str_t is supplied by:

typedef struct sip_str {
 char *sip_str_ptr;
 int sip_str_len;
}sip_str_t;

The sip_str_ptr parameter points to the start of the returned value and sip_str_len supplies the length of the returned value.

For example, given the following request line in a SIP message input to sip_get_request_uri_str():

INVITE sip:marconi@example.org SIP/2.0

the return is a pointer to sip_str_t with the sip_str_ptr member pointing to "s" of sip:marconi@example.org and sip_str_len being set to 23, the length of sip:marconi@example.org.

The sip_parse_uri() function takes a URI string in the form sip_str_t and returns a parsed URI sip_uri. The syntax of the URI is as specified in RFC 3261, section 25.1. If the parser encounters an error when parsing a component, it sets the appropriate error bit in the error flags and proceeds to the next component, if present.

The sip_free_parsed_uri() function takes a parsed URI sip_uri, obtained from sip_parse_uri(), and frees any associated memory.

The sip_parse_uri() function returns the parsed URI sip_uri on success. It returns a NULL if memory cannot be allocated for the parsed URI.

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

If the error is non-null, the following values is set: EINVAL

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

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

ATTRIBUTE TYPE ATTRIBUTE VALUE

Interface Stability Committed

MT-Level MT-Safe

libsip (3LIB)