1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
---
version: v1.2
layout: refman
---
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.10">
<title>nng_url_parse(3)</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
<link rel="stylesheet" href="./asciidoctor.css">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
</head>
<body class="manpage toc2 toc-left">
<div id="header">
<h1>nng_url_parse(3) Manual Page</h1>
<div id="toc" class="toc2">
<div id="toctitle">Table of Contents</div>
<ul class="sectlevel1">
<li><a href="#_synopsis">SYNOPSIS</a></li>
<li><a href="#_description">DESCRIPTION</a>
<ul class="sectlevel2">
<li><a href="#_url_canonicalization">URL Canonicalization</a></li>
</ul>
</li>
<li><a href="#_return_values">RETURN VALUES</a></li>
<li><a href="#_errors">ERRORS</a></li>
<li><a href="#_see_also">SEE ALSO</a></li>
</ul>
</div>
<h2 id="_name">NAME</h2>
<div class="sectionbody">
<p>nng_url_parse - create URL structure from a string</p>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="c"><span></span><span class="tok-cp">#include</span> <span class="tok-cpf"><nng/nng.h></span><span class="tok-cp"></span>
<span class="tok-kt">int</span> <span class="tok-nf">nng_url_parse</span><span class="tok-p">(</span><span class="tok-n">nng_url</span> <span class="tok-o">**</span><span class="tok-n">urlp</span><span class="tok-p">,</span> <span class="tok-k">const</span> <span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">str</span><span class="tok-p">);</span></code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The <code>nng_url_parse()</code> function parses the string <em>str</em> containing an
<a href="https://tools.ietf.org/html/rfc3986">RFC 3986</a> compliant URL, and creates
a structure containing the results. A pointer to the resulting structure
is stored in <em>urlp</em>.</p>
</div>
<div class="paragraph">
<p>The <code>nng_url</code> structure has at least the following members:</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="pygments highlight"><code data-lang="c"><span></span><span class="tok-k">struct</span> <span class="tok-n">nng_url</span> <span class="tok-p">{</span>
<span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">u_rawurl</span><span class="tok-p">;</span> <span class="tok-c1">// Unparsed URL, with minimal canonicalization.</span>
<span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">u_scheme</span><span class="tok-p">;</span> <span class="tok-c1">// Scheme, such as "http"; always lower case.</span>
<span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">u_userinfo</span><span class="tok-p">;</span> <span class="tok-c1">// Userinfo component, or NULL.</span>
<span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">u_host</span><span class="tok-p">;</span> <span class="tok-c1">// Full host, including port if present.</span>
<span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">u_hostname</span><span class="tok-p">;</span> <span class="tok-c1">// Hostname only (or address), or empty string.</span>
<span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">u_port</span><span class="tok-p">;</span> <span class="tok-c1">// Port number, may be default or empty string.</span>
<span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">u_path</span><span class="tok-p">;</span> <span class="tok-c1">// Path if present, empty string otherwise.</span>
<span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">u_query</span><span class="tok-p">;</span> <span class="tok-c1">// Query info if present, NULL otherwise.</span>
<span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">u_fragment</span><span class="tok-p">;</span> <span class="tok-c1">// Fragment if present, NULL otherwise.</span>
<span class="tok-kt">char</span> <span class="tok-o">*</span><span class="tok-n">u_requri</span><span class="tok-p">;</span> <span class="tok-c1">// Request-URI (path[?query][#fragment])</span>
<span class="tok-p">};</span></code></pre>
</div>
</div>
<div class="sect2">
<h3 id="_url_canonicalization">URL Canonicalization</h3>
<div class="paragraph">
<p>The <code>nng_url_parse()</code> function also canonicalizes the results, as
follows:</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>The URL is parsed into the various components.</p>
</li>
<li>
<p>The <code>u_scheme</code>, <code>u_hostname</code>, <code>u_host</code>, and <code>u_port</code> members are
converted to lower case.</p>
</li>
<li>
<p>Percent-encoded values for
<a href="https://tools.ietf.org/html/rfc3986#section-2.3">unreserved characters</a>
converted to their unencoded forms.</p>
</li>
<li>
<p>Additionally URL percent-encoded values for characters in the path
and with numeric values larger than 127 (i.e. not ASCII) are decoded.</p>
</li>
<li>
<p>The resulting <code>u_path</code> is 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 returns <code>NNG_EINVAL</code>.</p>
</li>
<li>
<p>Path segments consisting of <code>.</code> and <code>..</code> are resolved as per
<a href="https://tools.ietf.org/html/rfc3986#section-6.2.2.3">RFC 3986 6.2.2.3</a>.</p>
</li>
<li>
<p>Further, empty path segments are removed, meaning that duplicate
slash (<code>/</code>) separators are removed from the path.</p>
</li>
<li>
<p>If a port was not specified, but the scheme defines a default
port, then <code>u_port</code> will be filled in with the value of the default port.</p>
</li>
</ol>
</div>
<div class="admonitionblock tip">
<table>
<tr>
<td class="icon">
<i class="fa icon-tip" title="Tip"></i>
</td>
<td class="content">
Only the <code>u_userinfo</code>, <code>u_query</code>, and <code>u_fragment</code> members will ever be
<code>NULL</code>. The other members will be filled in with either default values
or the empty string if they cannot be determined from <em>str</em>.
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_return_values">RETURN VALUES</h2>
<div class="sectionbody">
<div class="paragraph">
<p>This function returns 0 on success, and non-zero otherwise.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_errors">ERRORS</h2>
<div class="sectionbody">
<div class="hdlist">
<table>
<tr>
<td class="hdlist1">
<code>NNG_ENOMEM</code>
</td>
<td class="hdlist2">
<p>Insufficient free memory exists to allocate a message.</p>
</td>
</tr>
<tr>
<td class="hdlist1">
<code>NNG_EINVAL</code>
</td>
<td class="hdlist2">
<p>An invalid URL was supplied.</p>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_see_also">SEE ALSO</h2>
<div class="sectionbody">
<div class="paragraph text-left">
<p><a href="nng_url_clone.3.html">nng_url_clone(3)</a>,
<a href="nng_url_free.3.html">nng_url_free(3)</a>,
<a href="nng_strerror.3.html">nng_strerror(3)</a>,
<a href="nng.7.html">nng(7)</a></p>
</div>
</div>
</div>
</div>
<link rel="stylesheet" href="./pygments-default.css">
</body>
</html>
|
