Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hendriknielaender/http2.zig
🌐 HTTP/2 server for zig
https://github.com/hendriknielaender/http2.zig
http-server http2 zig zig-library zig-package
Last synced: 3 months ago
JSON representation
🌐 HTTP/2 server for zig
- Host: GitHub
- URL: https://github.com/hendriknielaender/http2.zig
- Owner: hendriknielaender
- License: mit
- Created: 2024-01-30T17:22:10.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-10-23T15:36:07.000Z (3 months ago)
- Last Synced: 2024-10-23T20:46:40.912Z (3 months ago)
- Topics: http-server, http2, zig, zig-library, zig-package
- Language: Zig
- Homepage:
- Size: 275 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> [!WARNING]
> Still work in progress.
A HTTP/2 Zig library according to the HTTP/2 RFCs.
[](https://github.com/hendriknielaender/http2.zig/blob/HEAD/LICENSE)
[](https://github.com/hendriknielaender/http2.zig/blob/HEAD/CONTRIBUTING.md)
## Features
- Connection management
- Stream handling
- Frame parsing and serialization
- Compliance with HTTP/2 specifications
## Installation
You can use `zig fetch` to conveniently set the hash in the `build.zig.zon` file and update an existing dependency.
Run the following command to fetch the http2.zig package:
```shell
zig fetch https://github.com/hendriknielaender/http2.zig/archive/.tar.gz --save
```
Using `zig fetch` simplifies managing dependencies by automatically handling the package hash, ensuring your `build.zig.zon` file is up to date.
### Option 1 (build.zig.zon)
1. Declare http2.zig as a dependency in `build.zig.zon`:
```diff
.{
.name = "my-project",
.version = "1.0.0",
.paths = .{""},
.dependencies = .{
+ .http2 = .{
+ .url = "https://github.com/hendriknielaender/http2.zig/archive/.tar.gz",
+ },
},
}
```
2. Add the module in `build.zig`:
```diff
const std = @import("std");
pub fn build(b: *std.Build) void {
const target = b.standardTargetOptions(.{});
const optimize = b.standardOptimizeOption(.{});
+ const opts = .{ .target = target, .optimize = optimize };
+ const http2_module = b.dependency("http2", opts).module("http2");
const exe = b.addExecutable(.{
.name = "test",
.root_source_file = b.path("src/main.zig"),
.target = target,
.optimize = optimize,
});
+ exe.root_module.addImport("http2", http2_module);
exe.install();
...
}
```
3. Get the package hash:
```shell
$ zig build
my-project/build.zig.zon:6:20: error: url field is missing corresponding hash field
.url = "https://github.com/hendriknielaender/http2.zig/archive/.tar.gz",
^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
note: expected .hash = "",
```
4. Update `build.zig.zon` package hash value:
```diff
.{
.name = "my-project",
.version = "1.0.0",
.paths = .{""},
.dependencies = .{
.http2 = .{
.url = "https://github.com/hendriknielaender/http2.zig/archive/.tar.gz",
+ .hash = "",
},
},
}
```
## Usage
### Connection
To create an HTTP/2 connection, use the `Connection` struct. This struct handles the initialization, sending of the HTTP/2 preface, settings, and managing streams.
```zig
const std = @import("std");
const http2 = @import("http2");
const Connection = http2.Connection(std.io.AnyReader, std.io.AnyWriter);
pub fn main() !void {
const address = try std.net.Address.resolveIp("0.0.0.0", 8081);
var listener = try address.listen(.{ .reuse_address = true });
defer listener.deinit();
std.debug.print("Listening on 127.0.0.1:8081...\n", .{});
while (true) {
var conn = try listener.accept();
defer conn.stream.close();
std.debug.print("Accepted connection from: {any}\n", .{conn.address});
var server_conn = Connection.init(@constCast(&std.heap.page_allocator), conn.stream.reader().any(), conn.stream.writer().any(), true) catch |err| {
std.debug.print("Failed to initialize connection: {}\n", .{err});
continue;
};
defer server_conn.deinit();
// Handle connection and errors during the process
server_conn.handleConnection() catch |err| {
std.debug.print("Error handling connection: {}\n", .{err});
};
std.debug.print("Connection from {any} closed\n", .{conn.address});
}
}
```