Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation to create HTTP connections #226

Merged
merged 2 commits into from
Jan 22, 2024
Merged

Improve documentation to create HTTP connections #226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eff3e67
Improve documentation for HTTP connections
waahm7 Jan 22, 2024
ba700f9
Improve comments
waahm7 Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Source/AwsCommonRuntimeKit/http/HTTP2StreamManagerOptions.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ public struct HTTP2StreamManagerOptions: CStructWithShutdownOptions {
public var proxyEnvSettings: HTTPProxyEnvSettings?
/// The socket options to use for connections in the connection pool
public var socketOptions: SocketOptions
/// The tls options to use for connections in the connection pool
/// The TLS options for creating secure (HTTPS) connections.
/// Leave as NULL to create cleartext (HTTP) connections. For H2, `http2_prior_knowledge` must also be set (see RFC-7540 3.4).
public var tlsOptions: TLSConnectionOptions?

/// HTTP/2 Stream window control.
Expand Down
3 changes: 2 additions & 1 deletion Source/AwsCommonRuntimeKit/http/HTTPClientConnectionOptions.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ public struct HTTPClientConnectionOptions: CStructWithShutdownOptions {
public var proxyEnvSettings: HTTPProxyEnvSettings?
/// The socket options to use for connections in the connection pool
public var socketOptions: SocketOptions
/// The tls options to use for connections in the connection pool
/// The TLS options for creating secure (HTTPS) connections.
/// Leave as NULL to create cleartext (HTTP) connections.
public var tlsOptions: TLSConnectionOptions?

/// If set to true, then the TCP read back pressure mechanism will be enabled. You should
Expand Down