Updated README Zig Version to 0.15.2

Update README example to 0.15.2

Signed-off-by: Bernard Assan <[email protected]>

Author: bernardassan

README.md

@@ -17,7 +17,7 @@ tardy is a thread-local, I/O driven runtime for Zig, providing the core implemen
 - Coroutines (internally called Frames).
 
 ## Installing
-Compatible Zig Version: `0.14.0`
+Compatible Zig Version: `0.15.2`
 
 Latest Release: `0.3.0`
 ```
@@ -60,46 +60,51 @@ A basic multi-threaded TCP echo server.
 
 ```zig
 const std = @import("std");
-const log = std.log.scoped(.@"tardy/example/echo");
 
+const AcceptResult = @import("tardy").AcceptResult;
+const Cross = @import("tardy").Cross;
 const Pool = @import("tardy").Pool;
+const RecvResult = @import("tardy").RecvResult;
 const Runtime = @import("tardy").Runtime;
-const Task = @import("tardy").Task;
-const Tardy = @import("tardy").Tardy(.auto);
-const Cross = @import("tardy").Cross;
-
+const SendResult = @import("tardy").SendResult;
 const Socket = @import("tardy").Socket;
+const Task = @import("tardy").Task;
 const Timer = @import("tardy").Timer;
 
-const AcceptResult = @import("tardy").AcceptResult;
-const RecvResult = @import("tardy").RecvResult;
-const SendResult = @import("tardy").SendResult;
+const Tardy = @import("tardy").Tardy(.auto);
+const log = std.log.scoped(.@"tardy/example/echo");
 
 fn echo_frame(rt: *Runtime, server: *const Socket) !void {
     const socket = try server.accept(rt);
     defer socket.close_blocking();
 
-    // you can use the standard Zig Reader/Writer if you want!
-    const reader = socket.reader(rt);
-    const writer = socket.writer(rt);
+    var sock_reader = socket.reader(rt, &.{});
+    const sock_r = &sock_reader.interface;
+
+    var sock_writer = socket.writer(rt, &.{});
+    const sock_w = &sock_writer.interface;
+    defer sock_w.flush() catch unreachable;
 
     log.debug(
-        "{d} - accepted socket [{}]",
+        "{d} - accepted socket [{f}]",
         .{ std.time.milliTimestamp(), socket.addr },
     );
 
+    // spawn off a new frame.
     try rt.spawn(.{ rt, server }, echo_frame, 1024 * 16);
 
-    var buffer: [1024]u8 = undefined;
+    var buffer: [501]u8 = undefined;
     while (true) {
-        const recv_length = reader.read(&buffer) catch |e| {
-            log.err("Failed to recv on socket | {}", .{e});
-            return;
+        const recv_length = sock_r.readSliceShort(&buffer) catch |e| {
+            log.err("Failed to recv on socket | {t}", .{e});
+            break;
         };
 
-        writer.writeAll(buffer[0..recv_length]) catch |e| {
-            log.err("Failed to send on socket | {}", .{e});
-            return;
+        if (recv_length == 0) return;
+
+        sock_w.writeAll(buffer[0..recv_length]) catch |e| {
+            log.err("Failed to send on socket | {t}", .{e});
+            break;
         };
 
         log.debug("Echoed: {s}", .{buffer[0..recv_length]});
@@ -111,21 +116,26 @@ pub fn main() !void {
     const allocator = gpa.allocator();
     defer _ = gpa.deinit();
 
-    // tardy by default is
-    // - multithreaded
-    // - unbounded in terms of spawnable tasks
-    var tardy: Tardy = try .init(allocator, .{});
+    var tardy: Tardy = try .init(allocator, .{
+        .threading = .single,
+        .pooling = .static,
+        .size_tasks_initial = 256,
+        .size_aio_reap_max = 256,
+    });
     defer tardy.deinit();
 
-    const server: Socket = try .init(.{ .tcp = .{ .host = "127.0.0.1", .port = 9862 } });
+    const host = "0.0.0.0";
+    const port = 9862;
+
+    const server: Socket = try .init(.{ .tcp = .{ .host = host, .port = port } });
     try server.bind();
-    try server.listen(256);
+    try server.listen(1024);
 
     try tardy.entry(
         &server,
         struct {
             fn start(rt: *Runtime, tcp_server: *const Socket) !void {
-                try rt.spawn(.{ rt, tcp_server }, echo_frame, 1024 * 1024 * 4);
+                try rt.spawn(.{ rt, tcp_server }, echo_frame, 1024 * 16);
             }
         }.start,
     );

examples/basic/main.zig

@@ -17,7 +17,9 @@ fn log_frame(rt: *Runtime) !void {
 }
 
 pub fn main() !void {
-    const allocator = std.heap.page_allocator;
+    var gpa: std.heap.DebugAllocator(.{}) = .init;
+    const allocator = gpa.allocator();
+    defer _ = gpa.deinit();
 
     var tardy: Tardy = try .init(allocator, .{
         .threading = .single,

examples/echo/main.zig

@@ -32,18 +32,14 @@ fn echo_frame(rt: *Runtime, server: *const Socket) !void {
     // spawn off a new frame.
     try rt.spawn(.{ rt, server }, echo_frame, 1024 * 16);
 
-    //TODO: investigate why using readSliceShort with a buffer bigger
-    // than reader size leads to a connection reset (try to get a repro)
     var buffer: [501]u8 = undefined;
     while (true) {
         const recv_length = sock_r.readSliceShort(&buffer) catch |e| {
             log.err("Failed to recv on socket | {t}", .{e});
             break;
         };
 
-        if (recv_length == 0) {
-            break;
-        }
+        if (recv_length == 0) return;
 
         sock_w.writeAll(buffer[0..recv_length]) catch |e| {
             log.err("Failed to send on socket | {t}", .{e});