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.

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

Add index pages for posix and niots transports #34

Merged
merged 4 commits into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# ``GRPCNIOTransportHTTP2Posix``

HTTP/2 client and server transports built on top of SwiftNIO's `NIOPosix` module.

## Overview

This module provides HTTP/2 transports for client and server built on top SwiftNIO's `NIOPosix`
module and uses SwiftNIO's `NIOSSL` module to provide TLS.

The two transport types are:
- `HTTP2ClientTransport.Posix`, and
- `HTTP2ServerTransport.Posix`.

### Availability

These transports are available on the following platforms:

- Linux (Ubuntu, CentOS, Amazon Linux, Red Hat Universal Base Image)
- macOS 15.0+
- iOS 18.0+
- tvOS 18.0+
- watchOS 11.0+


### Getting started

Bootstrapping a client or server is made easier using the `.http2NIOPosix` shorthand:

```swift
// Create a server resolving "localhost:31415" using the default transport
// configuration and default TLS security configuration.
try await withGRPCClient(
transport: try .http2NIOPosix(
target: .dns(host: "localhost", port: 31415),
transportSecurity: .tls
)
) { client in
// ...
}

// Create a plaintext server listening on "127.0.0.1" on any available port
// modifying the default configuration to set max concurrent streams to 256.
try await withGRPCServer(
transport: .http2NIOPosix(
address: .ipv4(host: "127.0.0.1", port: 0),
transportSecurity: .plaintext,
config: .defaults { config in
config.http2.maxConcurrentStreams = 256
}
),
services: [...]
) { server in
// ...
}
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# ``GRPCNIOTransportHTTP2TransportServices``

HTTP/2 client and server transports built on top of SwiftNIO's `NIOTransportServices` module.

## Overview

This module provides HTTP/2 transports for client and server built on top SwiftNIO's
`NIOTransportServices` module which provide TLS via Apple's Network framework.

The two transport types are:
- `HTTP2ClientTransport.TransportServices`, and
- `HTTP2ServerTransport.TransportServices`.

### Availability

These transports are available on the following platforms:

- macOS 15.0+
- iOS 18.0+
- tvOS 18.0+
- watchOS 11.0+


### Getting started

Bootstrapping a client or server is made easier using the `.http2NIOTS` shorthand:

```swift
// Create a server resolving "localhost:31415" using the default transport
// configuration and default TLS security configuration.
try await withGRPCClient(
transport: try .http2NIOTS(
target: .dns(host: "localhost", port: 31415),
transportSecurity: .tls
)
) { client in
// ...
}

// Create a server listening on "127.0.0.1" on any available port
// using default plaintext security configuration.
try await withGRPCServer(
transport: .http2NIOTS(
address: .ipv4(host: "127.0.0.1", port: 0),
transportSecurity: .plaintext,
config: .defaults { config in
config.http2.maxConcurrentStreams = 256
}
),
services: [...]
) { server in
// ...
}
```
Loading