SYNOPSIS
#include <nng/nng.h>
int nng_url_parse(nng_url **urlp, const char *str);DESCRIPTION
The nng_url_parse() function parses the string str containing an
RFC 3986 compliant URL, and creates
a structure containing the results. A pointer to the resulting structure
is stored in urlp.
The nng_url structure has at least the following members:
struct nng_url {
char *u_scheme; // Scheme, such as "http"; always lower case.
char *u_rawurl; // Unparsed URL, with minimal canonicalization.
char *u_userinfo; // Userinfo component, or NULL.
char *u_host; // Full host, including port if present.
char *u_hostname; // Hostname only (or address), or empy string.
char *u_port; // Port number, may be default or empty string.
char *u_path; // Path if present, empty string otherwise.
char *u_query; // Query info if present, NULL otherwise.
char *u_fragment; // Fragment if present, NULL otherwise.
char *u_requri; // Request-URI (path[?query][#fragment])
};URL Canonicalization
The nng_url_parse() function also canonicalizes the results, as
follows:
-
The URL is parsed into the various components.
-
The
u_scheme,u_hostname,u_host, andu_portmembers are converted to lower case. -
Percent-encoded values for unreserved characters converted to their unencoded forms.
-
Additionally URL percent-encoded values for characters in the path and with numeric values larger than 127 (i.e. not ASCII) are decoded.
-
The resulting
u_pathis checked for invalid UTF-8 sequences, consisting of surrogate pairs, illegal byte sequences, or overlong encodings. If this check fails, then the entire URL is considered invalid, and the function returnsNNG_EINVAL. -
Path segments consisting of
.and..are resolved as per RFC 3986 6.2.2.3. -
Further, empty path segments are removed, meaning that duplicate slash (
/) separators are removed from the path. -
If a port was not specified, but the scheme defines a default port, then
u_portwill be filled in with the value of the default port.
Only the u_userinfo, u_query, and u_fragment members will ever be
NULL. The other members will be filled in with either default values
or the empty string if they cannot be determined from str.
|
RETURN VALUES
This function returns 0 on success, and non-zero otherwise.
ERRORS
NNG_ENOMEM-
Insufficient free memory exists to allocate a message.
NNG_EINVAL-
An invalid URL was supplied.