Skip to content

Commit 7a71e83

Browse files
dnadobadnadoba
committed
async/await example
1 parent 06b9f98 commit 7a71e83

File tree

6 files changed

+228
-0
lines changed

6 files changed

+228
-0
lines changed

‎Examples/GetHTML/GetHTML.swift

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
//===----------------------------------------------------------------------===//
2+
//
3+
// This source file is part of the AsyncHTTPClient open source project
4+
//
5+
// Copyright (c) 2022 Apple Inc. and the AsyncHTTPClient project authors
6+
// Licensed under Apache License v2.0
7+
//
8+
// See LICENSE.txt for license information
9+
// See CONTRIBUTORS.txt for the list of AsyncHTTPClient project authors
10+
//
11+
// SPDX-License-Identifier: Apache-2.0
12+
//
13+
//===----------------------------------------------------------------------===//
14+
15+
// TODO: remove @testable after async/await API is public
16+
@testable import AsyncHTTPClient
17+
import NIOCore
18+
19+
#if compiler(>=5.5.2) && canImport(_Concurrency)
20+
21+
@main
22+
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
23+
struct GetHTML {
24+
static func main() async throws {
25+
let httpClient = HTTPClient(eventLoopGroupProvider: .createNew)
26+
do {
27+
let request = HTTPClientRequest(url: "https://apple.com")
28+
let response = try await httpClient.execute(request, timeout: .seconds(30))
29+
print("HTTP head", response)
30+
let body = try await response.body.collect(upTo: 1024 * 1024) // 1 MB
31+
print(String(buffer: body))
32+
} catch {
33+
print("request failed:", error)
34+
}
35+
// it is important to shutdown the httpClient after all requests are done, even if one failed
36+
try await httpClient.shutdown()
37+
}
38+
}
39+
40+
#endif

‎Examples/GetJSON/GetJSON.swift

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
//===----------------------------------------------------------------------===//
2+
//
3+
// This source file is part of the AsyncHTTPClient open source project
4+
//
5+
// Copyright (c) 2022 Apple Inc. and the AsyncHTTPClient project authors
6+
// Licensed under Apache License v2.0
7+
//
8+
// See LICENSE.txt for license information
9+
// See CONTRIBUTORS.txt for the list of AsyncHTTPClient project authors
10+
//
11+
// SPDX-License-Identifier: Apache-2.0
12+
//
13+
//===----------------------------------------------------------------------===//
14+
15+
// TODO: remove @testable after async/await API is public
16+
@testable import AsyncHTTPClient
17+
import NIOCore
18+
import Foundation
19+
import NIOFoundationCompat
20+
21+
#if compiler(>=5.5.2) && canImport(_Concurrency)
22+
23+
struct Comic: Codable {
24+
var num: Int
25+
var title: String
26+
var day: String
27+
var month: String
28+
var year: String
29+
var img: String
30+
var alt: String
31+
var news: String
32+
var link: String
33+
var transcript: String
34+
}
35+
36+
@main
37+
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
38+
struct GetJSON {
39+
static func main() async throws {
40+
let httpClient = HTTPClient(eventLoopGroupProvider: .createNew)
41+
do {
42+
let request = HTTPClientRequest(url: "https://xkcd.com/info.0.json")
43+
let response = try await httpClient.execute(request, timeout: .seconds(30))
44+
print("HTTP head", response)
45+
let body = try await response.body.collect(upTo: 1024 * 1024) // 1 MB
46+
let comic = try JSONDecoder().decode(Comic.self, from: body)
47+
dump(comic)
48+
} catch {
49+
print("request failed:", error)
50+
}
51+
// it is important to shutdown the httpClient after all requests are done, even if one failed
52+
try await httpClient.shutdown()
53+
}
54+
}
55+
56+
#endif

‎Examples/Package.swift

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
// swift-tools-version:5.5
2+
//===----------------------------------------------------------------------===//
3+
//
4+
// This source file is part of the AsyncHTTPClient open source project
5+
//
6+
// Copyright (c) 2018-2022 Apple Inc. and the AsyncHTTPClient project authors
7+
// Licensed under Apache License v2.0
8+
//
9+
// See LICENSE.txt for license information
10+
// See CONTRIBUTORS.txt for the list of AsyncHTTPClient project authors
11+
//
12+
// SPDX-License-Identifier: Apache-2.0
13+
//
14+
//===----------------------------------------------------------------------===//
15+
16+
import PackageDescription
17+
18+
let package = Package(
19+
name: "async-http-client-examples",
20+
products: [
21+
.executable(name: "GetHTML", targets: ["GetHTML"]),
22+
.executable(name: "GetJSON", targets: ["GetJSON"]),
23+
.executable(name: "StreamingByteCounter", targets: ["StreamingByteCounter"]),
24+
],
25+
dependencies: [
26+
.package(url: "https://github.com/apple/swift-nio.git", .branch("main")),
27+
28+
// in real-world projects this would be
29+
// .package(url: "https://github.com/swift-server/async-http-client.git", from: "1.9.0")
30+
.package(name: "async-http-client", path: "../"),
31+
],
32+
targets: [
33+
// MARK: - Examples
34+
.executableTarget(
35+
name: "GetHTML",
36+
dependencies: [
37+
.product(name: "AsyncHTTPClient", package: "async-http-client"),
38+
.product(name: "NIOCore", package: "swift-nio"),
39+
], path: "GetHTML"
40+
),
41+
.executableTarget(
42+
name: "GetJSON",
43+
dependencies: [
44+
.product(name: "AsyncHTTPClient", package: "async-http-client"),
45+
.product(name: "NIOCore", package: "swift-nio"),
46+
.product(name: "NIOFoundationCompat", package: "swift-nio"),
47+
], path: "GetJSON"
48+
),
49+
.executableTarget(
50+
name: "StreamingByteCounter",
51+
dependencies: [
52+
.product(name: "AsyncHTTPClient", package: "async-http-client"),
53+
.product(name: "NIOCore", package: "swift-nio"),
54+
], path: "StreamingByteCounter"
55+
),
56+
]
57+
)

‎Examples/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Examples
2+
This folder includes a couple of Examples for `AsyncHTTPClient`.
3+
You can run them by opening the `Package.swift` in this folder through Xcode.
4+
In Xcode you can then select the scheme for the example you want run e.g. `GetHTML`.
5+
6+
You can also run the examples from the command line by executing the follow command in this folder:
7+
```
8+
swift run GetHTML
9+
```
10+
To run other examples you can just replace `GetHTML` with the name of the example you want to run.
11+

‎Examples/StreamingByteCounter/StreamingByteCounter.swift

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
//===----------------------------------------------------------------------===//
2+
//
3+
// This source file is part of the AsyncHTTPClient open source project
4+
//
5+
// Copyright (c) 2022 Apple Inc. and the AsyncHTTPClient project authors
6+
// Licensed under Apache License v2.0
7+
//
8+
// See LICENSE.txt for license information
9+
// See CONTRIBUTORS.txt for the list of AsyncHTTPClient project authors
10+
//
11+
// SPDX-License-Identifier: Apache-2.0
12+
//
13+
//===----------------------------------------------------------------------===//
14+
15+
// TODO: remove @testable after async/await API is public
16+
@testable import AsyncHTTPClient
17+
import NIOCore
18+
19+
#if compiler(>=5.5.2) && canImport(_Concurrency)
20+
21+
@main
22+
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
23+
struct StreamingByteCounter {
24+
static func main() async throws {
25+
let httpClient = HTTPClient(eventLoopGroupProvider: .createNew)
26+
do {
27+
let request = HTTPClientRequest(url: "https://apple.com")
28+
let response = try await httpClient.execute(request, timeout: .seconds(30))
29+
print("HTTP head", response)
30+
31+
// if defined, the content-length headers announces the size of the body
32+
let expectedBytes = response.headers.first(name: "content-length").flatMap(Int.init)
33+
34+
var receivedBytes = 0
35+
// asynchronously iterates over all body fragments
36+
// this loop will automatically propagate backpressure correctly
37+
for try await buffer in response.body {
38+
// For this example, we are just interested in the size of the fragment
39+
receivedBytes += buffer.readableBytes
40+
41+
if let expectedBytes = expectedBytes {
42+
// if the body size is known, we calculate a progress indicator
43+
let progress = Double(receivedBytes)/Double(expectedBytes)
44+
print("progress: \(Int(progress * 100))%")
45+
}
46+
// in case backpressure is needed, all reads will be paused until returned future is resolved
47+
}
48+
print("did receive \(receivedBytes) bytes")
49+
} catch {
50+
print("request failed:", error)
51+
}
52+
// it is important to shutdown the httpClient after all requests are done, even if one failed
53+
try await httpClient.shutdown()
54+
}
55+
}
56+
57+
#endif

‎Sources/AsyncHTTPClient/AsyncAwait/HTTPClientResponse.swift

+7
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,13 @@ public struct HTTPClientResponse {
4646
}
4747
}
4848

49+
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
50+
extension HTTPClientResponse: CustomStringConvertible {
51+
public var description: String {
52+
return "HTTPClientResponse(version: \(self.version), status: \(self.status), headers: \(self.headers))"
53+
}
54+
}
55+
4956
@available(macOS 10.15, iOS 13.0, watchOS 6.0, tvOS 13.0, *)
5057
extension HTTPClientResponse.Body: AsyncSequence {
5158
public typealias Element = AsyncIterator.Element

0 commit comments

Comments
 (0)