URI Functions

const struct uri_t sip_get_uri_parsed(sip_header_value_t value, int *error);

The sip_get_uri_parsed() function returns the parsed URI from the value that is specified by the value parameter. If the value of the *error parameter is not NULL, the function sets the value to zero if the function completes successfully. If the function does not complete successfully, the function sets the value of the *error parameter to the error number.

const struct uri_t sip_get_request_uri(sip_msg_t sip_msg, int *error);

The sip_get_request_uri() function returns the parsed URI from the start line of a SIP request. If the value of the *error parameter is not NULL, the function sets the value to zero if the function completes successfully. If the function does not complete successfully, the function sets the value of the *error parameter to the error number.

const struct uri_t sip_parse_uri(sip_str_t *sip_uri, int *error);

The sip_parse_uri() function accepts the URI string in the sip_uri parameter and returns a parsed URI. If the value of the *error parameter is not NULL, the function sets the value to zero if the function completes successfully. If the function does not complete successfully, the function sets the value of the *error parameter to the error number.

boolean_t sip_is_sipuri(sip_uri_t sip_uri);

The sip_is_sipuri() function returns a value of B_TRUE if the sip_uri parameter contains a SIP URI. This function returns a value of B_FALSE in all other cases. If the value of the *error parameter is not NULL, the function sets the value to zero if the function completes successfully. If the function does not complete successfully, the function sets the value of the *error parameter to the error number.

const sip_str_t sip_uri_scheme(const struct uri_t *uri, int *error);

The sip_uri_scheme() function returns the scheme value of the parsed URI that is contained in the sip_uri parameter. If the value of the *error parameter is not NULL, the function sets the value to zero if the function completes successfully. If the function does not complete successfully, the function sets the value of the *error parameter to the error number.

const sip_str_t sip_get_uri_user(const struct uri_t *uri, int *error);

The sip_get_uri_user() function returns the user value of the parsed URI that is contained in the sip_uri parameter. If the value of the *error parameter is not NULL, the function sets the value to zero if the function completes successfully. If the function does not complete successfully, the function sets the value of the *error parameter to the error number.

const sip_str_t sip_get_uri_password(const struct uri_t *uri, int *error);

The sip_get_uri_password() function returns the password value of the parsed URI that is contained in the sip_uri parameter. If the value of the *error parameter is not NULL, the function sets the value to zero if the function completes successfully. If the function does not complete successfully, the function sets the value of the *error parameter to the error number.

const sip_str_t sip_get_uri_host(const struct uri_t *uri, int *error);

The sip_get_uri_host() function returns the host value of the parsed URI that is contained in the sip_uri parameter. If the value of the *error parameter is not NULL, the function sets the value to zero if the function completes successfully. If the function does not complete successfully, the function sets the value of the *error parameter to the error number.

uint_t sip_get_uri_port(sip_uri_t sip_uri, int *error);

The sip_get_uri_port() function returns the port value of the parsed URI that is contained in the sip_uri parameter. If the value of the *error parameter is not NULL, the function sets the value to zero if the function completes successfully. If the function does not complete successfully, the function sets the value of the *error parameter to the error number.

const sip_param_t sip_get_sip_uri_params(sip_uri_t sip_uri, int *error);

The sip_get_sip_uri_params() function returns the list of URI parameters for the parsed URI that is contained in the sip_uri parameter. If the value of the *error parameter is not NULL, the function sets the value to zero if the function completes successfully. If the function does not complete successfully, the function sets the value of the *error parameter to the error number.

const sip_str_t sip_get_sip_uri_headers(sip_uri_t sip_uri, int *error);

The sip_get_sip_uri_headers() function returns the URI header from the parsed URI that is contained in the sip_uri parameter. If the value of the *error parameter is not NULL, the function sets the value to zero if the function completes successfully. If the function does not complete successfully, the function sets the value of the *error parameter to the error number.

const sip_str_t sip_get_abs_uri_opaque(sip_uri_t sip_uri, int *error);

The sip_get_abs_uri_opaque() function returns the opaque part of the parsed absolute URI that is contained in the sip_uri parameter. If the value of the *error parameter is not NULL, the function sets the value to zero if the function completes successfully. If the function does not complete successfully, the function sets the value of the *error parameter to the error number.

const sip_str_t sip_get_abs_uri_query(sip_uri_t sip_uri, int *error);

The sip_get_abs_uri_query() function returns the query part of the parsed absolute URI that is contained in the sip_uri parameter. If the value of the *error parameter is not NULL, the function sets the value to zero if the function completes successfully. If the function does not complete successfully, the function sets the value of the *error parameter to the error number.

const sip_str_t sip_get_sip_abs_uri_path(sip_uri_t sip_uri, int *error);

The sip_get_sip_abs_uri_path() function returns the path part of the parsed absolute URI that is contained in the sip_uri parameter. If the value of the *error parameter is not NULL, the function sets the value to zero if the function completes successfully. If the function does not complete successfully, the function sets the value of the *error parameter to the error number.

const sip_str_t sip_get_sip_abs_uri_regname(sip_uri_t sip_uri, int *error);

The sip_get_sip_abs_uri_regname() function returns the reg-name part of the parsed absolute URI that is contained in the sip_uri parameter. If the value of the *error parameter is not NULL, the function sets the value to zero if the function completes successfully. If the function does not complete successfully, the function sets the value of the *error parameter to the error number.

boolean_t sip_uri_is_tel_user(sip_uri_t sip_uri);

The sip_uri_is_tel_user() function returns a value of B_TRUE if the user from the URI is a telephone subscriber.

char sip_get_uri_error(uint_t errflags);

The sip_get_uri_error() function returns the string representation of the error flags that are contained in the errflags parameter. The calling thread must free the string that this function returns.