Skip to content

Commit 9786fc4

Browse files
tomerdtomerd
committed
publish 1.1.0 docs
1 parent 4e6307e commit 9786fc4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+12830
-726
lines changed

‎docs/1.1.0/AsyncHTTPClient/Classes.html

Lines changed: 261 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,261 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<title>Classes Reference</title>
5+
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
6+
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
7+
<meta charset="utf-8">
8+
<script src="js/jquery.min.js" defer></script>
9+
<script src="js/jazzy.js" defer></script>
10+
11+
<script src="js/lunr.min.js" defer></script>
12+
<script src="js/typeahead.jquery.js" defer></script>
13+
<script src="js/jazzy.search.js" defer></script>
14+
</head>
15+
<body>
16+
17+
<a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>
18+
19+
<a title="Classes Reference"></a>
20+
21+
<header class="header">
22+
<p class="header-col header-col--primary">
23+
<a class="header-link" href="index.html">
24+
AsyncHTTPClient 1.1.0 Docs
25+
</a>
26+
(90% documented)
27+
</p>
28+
29+
<p class="header-col--secondary">
30+
<form role="search" action="search.json">
31+
<input type="text" placeholder="Search documentation" data-typeahead>
32+
</form>
33+
</p>
34+
35+
<p class="header-col header-col--secondary">
36+
<a class="header-link" href="https://github.com/swift-server/async-http-client">
37+
<img class="header-icon" src="img/gh.png"/>
38+
View on GitHub
39+
</a>
40+
</p>
41+
42+
<p class="header-col header-col--secondary">
43+
<a class="header-link" href="dash-feed://https%3A%2F%2Fswift%2Dserver%2Egithub%2Eio%2Fasync%2Dhttp%2Dclient%2Fdocs%2F1%2E1%2E0%2FAsyncHTTPClient%2Fdocsets%2FAsyncHTTPClient%2Exml">
44+
<img class="header-icon" src="img/dash.png"/>
45+
Install in Dash
46+
</a>
47+
</p>
48+
</header>
49+
50+
<p class="breadcrumbs">
51+
<a class="breadcrumb" href="index.html">AsyncHTTPClient Reference</a>
52+
<img class="carat" src="img/carat.png" />
53+
Classes Reference
54+
</p>
55+
56+
<div class="content-wrapper">
57+
<nav class="navigation">
58+
<ul class="nav-groups">
59+
<li class="nav-group-name">
60+
<a class="nav-group-name-link" href="Classes.html">Classes</a>
61+
<ul class="nav-group-tasks">
62+
<li class="nav-group-task">
63+
<a class="nav-group-task-link" href="Classes/HTTPClient.html">HTTPClient</a>
64+
</li>
65+
<li class="nav-group-task">
66+
<a class="nav-group-task-link" href="Classes/HTTPClient/Configuration.html">– Configuration</a>
67+
</li>
68+
<li class="nav-group-task">
69+
<a class="nav-group-task-link" href="Classes/HTTPClient/EventLoopGroupProvider.html">– EventLoopGroupProvider</a>
70+
</li>
71+
<li class="nav-group-task">
72+
<a class="nav-group-task-link" href="Classes/HTTPClient/EventLoopPreference.html">– EventLoopPreference</a>
73+
</li>
74+
<li class="nav-group-task">
75+
<a class="nav-group-task-link" href="Classes/HTTPClient/Decompression.html">– Decompression</a>
76+
</li>
77+
<li class="nav-group-task">
78+
<a class="nav-group-task-link" href="Classes/HTTPClient/Cookie.html">– Cookie</a>
79+
</li>
80+
<li class="nav-group-task">
81+
<a class="nav-group-task-link" href="Classes/HTTPClient/Response.html">– Response</a>
82+
</li>
83+
<li class="nav-group-task">
84+
<a class="nav-group-task-link" href="Classes/HTTPClient/Body.html">– Body</a>
85+
</li>
86+
<li class="nav-group-task">
87+
<a class="nav-group-task-link" href="Classes/HTTPClient/Request.html">– Request</a>
88+
</li>
89+
<li class="nav-group-task">
90+
<a class="nav-group-task-link" href="Classes/HTTPClient/Authorization.html">– Authorization</a>
91+
</li>
92+
<li class="nav-group-task">
93+
<a class="nav-group-task-link" href="Classes/HTTPClient/Task.html">– Task</a>
94+
</li>
95+
<li class="nav-group-task">
96+
<a class="nav-group-task-link" href="Classes/HTTPClientCopyingDelegate.html">HTTPClientCopyingDelegate</a>
97+
</li>
98+
<li class="nav-group-task">
99+
<a class="nav-group-task-link" href="Classes/ResponseAccumulator.html">ResponseAccumulator</a>
100+
</li>
101+
</ul>
102+
</li>
103+
<li class="nav-group-name">
104+
<a class="nav-group-name-link" href="Protocols.html">Protocols</a>
105+
<ul class="nav-group-tasks">
106+
<li class="nav-group-task">
107+
<a class="nav-group-task-link" href="Protocols/HTTPClientResponseDelegate.html">HTTPClientResponseDelegate</a>
108+
</li>
109+
</ul>
110+
</li>
111+
<li class="nav-group-name">
112+
<a class="nav-group-name-link" href="Structs.html">Structures</a>
113+
<ul class="nav-group-tasks">
114+
<li class="nav-group-task">
115+
<a class="nav-group-task-link" href="Structs/HTTPClientError.html">HTTPClientError</a>
116+
</li>
117+
</ul>
118+
</li>
119+
</ul>
120+
</nav>
121+
<article class="main-content">
122+
123+
<section class="section">
124+
<div class="section-content top-matter">
125+
<h1>Classes</h1>
126+
<p>The following classes are available globally.</p>
127+
128+
</div>
129+
</section>
130+
131+
<section class="section">
132+
<div class="section-content">
133+
<div class="task-group">
134+
<ul class="item-container">
135+
<li class="item">
136+
<div>
137+
<code>
138+
<a name="/s:15AsyncHTTPClient0B0C"></a>
139+
<a name="//apple_ref/swift/Class/HTTPClient" class="dashAnchor"></a>
140+
<a class="token" href="#/s:15AsyncHTTPClient0B0C">HTTPClient</a>
141+
</code>
142+
</div>
143+
<div class="height-container">
144+
<div class="pointer-container"></div>
145+
<section class="section">
146+
<div class="pointer"></div>
147+
<div class="abstract">
148+
<p>HTTPClient class provides API for request execution.</p>
149+
150+
<p>Example:</p>
151+
<pre class="highlight swift"><code> <span class="k">let</span> <span class="nv">client</span> <span class="o">=</span> <span class="kt">HTTPClient</span><span class="p">(</span><span class="n">eventLoopGroupProvider</span> <span class="o">=</span> <span class="o">.</span><span class="n">createNew</span><span class="p">)</span>
152+
<span class="n">client</span><span class="o">.</span><span class="nf">get</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="s">"https://swift.org"</span><span class="p">,</span> <span class="nv">deadline</span><span class="p">:</span> <span class="o">.</span><span class="nf">now</span><span class="p">()</span> <span class="o">+</span> <span class="o">.</span><span class="nf">seconds</span><span class="p">(</span><span class="mi">1</span><span class="p">))</span><span class="o">.</span><span class="n">whenComplete</span> <span class="p">{</span> <span class="n">result</span> <span class="k">in</span>
153+
<span class="k">switch</span> <span class="n">result</span> <span class="p">{</span>
154+
<span class="k">case</span> <span class="o">.</span><span class="nf">failure</span><span class="p">(</span><span class="k">let</span> <span class="nv">error</span><span class="p">):</span>
155+
<span class="c1">// process error</span>
156+
<span class="k">case</span> <span class="o">.</span><span class="nf">success</span><span class="p">(</span><span class="k">let</span> <span class="nv">response</span><span class="p">):</span>
157+
<span class="k">if</span> <span class="k">let</span> <span class="nv">response</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="o">.</span><span class="n">ok</span> <span class="p">{</span>
158+
<span class="c1">// handle response</span>
159+
<span class="p">}</span> <span class="k">else</span> <span class="p">{</span>
160+
<span class="c1">// handle remote error</span>
161+
<span class="p">}</span>
162+
<span class="p">}</span>
163+
<span class="p">}</span>
164+
</code></pre>
165+
166+
<p>It is important to close the client instance, for example in a defer statement, after use to cleanly shutdown the underlying NIO <code>EventLoopGroup</code>:</p>
167+
<pre class="highlight swift"><code> <span class="k">try</span> <span class="n">client</span><span class="o">.</span><span class="nf">syncShutdown</span><span class="p">()</span>
168+
</code></pre>
169+
170+
<a href="Classes/HTTPClient.html" class="slightly-smaller">See more</a>
171+
</div>
172+
<div class="declaration">
173+
<h4>Declaration</h4>
174+
<div class="language">
175+
<p class="aside-title">Swift</p>
176+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">HTTPClient</span></code></pre>
177+
178+
</div>
179+
</div>
180+
<div class="slightly-smaller">
181+
<a href="https://github.com/swift-server/async-http-client/tree/1.1.0/Sources/AsyncHTTPClient/HTTPClient.swift#L48-L508">Show on GitHub</a>
182+
</div>
183+
</section>
184+
</div>
185+
</li>
186+
<li class="item">
187+
<div>
188+
<code>
189+
<a name="/s:15AsyncHTTPClient19ResponseAccumulatorC"></a>
190+
<a name="//apple_ref/swift/Class/ResponseAccumulator" class="dashAnchor"></a>
191+
<a class="token" href="#/s:15AsyncHTTPClient19ResponseAccumulatorC">ResponseAccumulator</a>
192+
</code>
193+
</div>
194+
<div class="height-container">
195+
<div class="pointer-container"></div>
196+
<section class="section">
197+
<div class="pointer"></div>
198+
<div class="abstract">
199+
<p>Undocumented</p>
200+
201+
<a href="Classes/ResponseAccumulator.html" class="slightly-smaller">See more</a>
202+
</div>
203+
<div class="declaration">
204+
<h4>Declaration</h4>
205+
<div class="language">
206+
<p class="aside-title">Swift</p>
207+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ResponseAccumulator</span> <span class="p">:</span> <span class="kt"><a href="Protocols/HTTPClientResponseDelegate.html">HTTPClientResponseDelegate</a></span></code></pre>
208+
209+
</div>
210+
</div>
211+
<div class="slightly-smaller">
212+
<a href="https://github.com/swift-server/async-http-client/tree/1.1.0/Sources/AsyncHTTPClient/HTTPHandler.swift#L284-L354">Show on GitHub</a>
213+
</div>
214+
</section>
215+
</div>
216+
</li>
217+
<li class="item">
218+
<div>
219+
<code>
220+
<a name="/s:15AsyncHTTPClient0B15CopyingDelegateC"></a>
221+
<a name="//apple_ref/swift/Class/HTTPClientCopyingDelegate" class="dashAnchor"></a>
222+
<a class="token" href="#/s:15AsyncHTTPClient0B15CopyingDelegateC">HTTPClientCopyingDelegate</a>
223+
</code>
224+
</div>
225+
<div class="height-container">
226+
<div class="pointer-container"></div>
227+
<section class="section">
228+
<div class="pointer"></div>
229+
<div class="abstract">
230+
<p>Undocumented</p>
231+
232+
<a href="Classes/HTTPClientCopyingDelegate.html" class="slightly-smaller">See more</a>
233+
</div>
234+
<div class="declaration">
235+
<h4>Declaration</h4>
236+
<div class="language">
237+
<p class="aside-title">Swift</p>
238+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">HTTPClientCopyingDelegate</span> <span class="p">:</span> <span class="kt"><a href="Protocols/HTTPClientResponseDelegate.html">HTTPClientResponseDelegate</a></span></code></pre>
239+
240+
</div>
241+
</div>
242+
<div class="slightly-smaller">
243+
<a href="https://github.com/swift-server/async-http-client/tree/1.1.0/Sources/AsyncHTTPClient/Utils.swift#L31-L47">Show on GitHub</a>
244+
</div>
245+
</section>
246+
</div>
247+
</li>
248+
</ul>
249+
</div>
250+
</div>
251+
</section>
252+
253+
</article>
254+
</div>
255+
<section class="footer">
256+
<p>&copy; 2020 <a class="link" href="https://github.com/swift-server/async-http-client" target="_blank" rel="external">AsyncHTTPClient team</a>. All rights reserved. (Last updated: 2020-02-28)</p>
257+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.1</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
258+
</section>
259+
</body>
260+
</div>
261+
</html>

0 commit comments

Comments
 (0)