zambyte/zaprus
1
0
Fork 0
mirror of https://git.robbyzambito.me/zaprus synced 2025-12-20 16:24:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Break out the impl to a lib

Browse Source 
This will make it easier to make a C library.
This commit is contained in:
Robby Zambito
2025-04-13 16:50:52 -04:00
parent 8779b29149
commit 23f7ad8f94
5 changed files with 50 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/saprus.zig → src/Saprus.zig
View File

@@ -112,7 +112,7 @@ pub fn connect(payload: []const u8, allocator: Allocator) !?SaprusMessage {
return initial_conn_res;
}
pub const SaprusMessage = @import("./saprus_message.zig").SaprusMessage;
const SaprusMessage = @import("message.zig").Message;
const std = @import("std");
const Random = std.Random;

13
src/main.zig
View File

@@ -41,19 +41,19 @@ pub fn main() !void {
};
defer res.deinit();
try Saprus.init();
defer Saprus.deinit();
try SaprusClient.init();
defer SaprusClient.deinit();
if (res.args.help != 0) {
return clap.help(std.io.getStdErr().writer(), clap.Help, &params, .{});
}
if (res.args.relay) |r| {
try Saprus.sendRelay(if (r.len > 0) r else "Hello darkness my old friend", gpa);
try SaprusClient.sendRelay(if (r.len > 0) r else "Hello darkness my old friend", gpa);
// std.debug.print("Sent: {s}\n", .{r});
return;
} else if (res.args.connect) |c| {
const conn_res: ?SaprusMessage = Saprus.connect(if (c.len > 0) c else "Hello darkness my old friend", gpa) catch |err| switch (err) {
const conn_res: ?SaprusMessage = SaprusClient.connect(if (c.len > 0) c else "Hello darkness my old friend", gpa) catch |err| switch (err) {
error.WouldBlock => null,
else => return err,
};
@@ -74,7 +74,8 @@ const std = @import("std");
const DebugAllocator = std.heap.DebugAllocator(.{});
const ArrayList = std.ArrayList;
const Saprus = @import("./saprus.zig");
const SaprusMessage = Saprus.SaprusMessage;
const zaprus = @import("zaprus");
const SaprusClient = zaprus.Client;
const SaprusMessage = zaprus.Message;
const clap = @import("clap");

46
src/saprus_message.zig → src/message.zig
View File

@@ -1,9 +1,9 @@
const base64Enc = std.base64.Base64Encoder.init(std.base64.standard_alphabet_chars, '=');
const base64Dec = std.base64.Base64Decoder.init(std.base64.standard_alphabet_chars, '=');
/// Type tag for SaprusMessage union.
/// Type tag for Message union.
/// This is the first value in the actual packet sent over the network.
pub const SaprusPacketType = enum(u16) {
pub const PacketType = enum(u16) {
relay = 0x003C,
file_transfer = 0x8888,
connection = 0x00E9,
@@ -12,7 +12,7 @@ pub const SaprusPacketType = enum(u16) {
/// Reserved option values.
/// Currently unused.
pub const SaprusConnectionOptions = packed struct(u8) {
pub const ConnectionOptions = packed struct(u8) {
opt1: bool = false,
opt2: bool = false,
opt3: bool = false,
@@ -23,13 +23,13 @@ pub const SaprusConnectionOptions = packed struct(u8) {
opt8: bool = false,
};
pub const SaprusError = error{
pub const Error = error{
NotImplementedSaprusType,
UnknownSaprusType,
};
/// All Saprus messages
pub const SaprusMessage = union(SaprusPacketType) {
pub const Message = union(PacketType) {
pub const Relay = struct {
pub const Header = packed struct {
dest: @Vector(4, u8),
@@ -44,7 +44,7 @@ pub const SaprusMessage = union(SaprusPacketType) {
seq_num: u32 = 0,
msg_id: u32 = 0,
reserved: u8 = 0,
options: SaprusConnectionOptions = .{},
options: ConnectionOptions = .{},
};
header: Header,
payload: []const u8,
@@ -53,8 +53,8 @@ pub const SaprusMessage = union(SaprusPacketType) {
file_transfer: void, // unimplemented
connection: Connection,
/// Should be called for any SaprusMessage that was declared using a function that you pass an allocator to.
pub fn deinit(self: SaprusMessage, allocator: Allocator) void {
/// Should be called for any Message that was declared using a function that you pass an allocator to.
pub fn deinit(self: Message, allocator: Allocator) void {
switch (self) {
.relay => |r| allocator.free(r.payload),
.connection => |c| allocator.free(c.payload),
@@ -96,7 +96,7 @@ pub const SaprusMessage = union(SaprusPacketType) {
}
/// Caller is responsible for freeing the returned bytes.
pub fn toBytes(self: SaprusMessage, allocator: Allocator) ![]u8 {
pub fn toBytes(self: Message, allocator: Allocator) ![]u8 {
// Create a growable list of bytes to store the output in.
var buf = std.ArrayList(u8).init(allocator);
errdefer buf.deinit();
@@ -108,7 +108,7 @@ pub const SaprusMessage = union(SaprusPacketType) {
switch (self) {
.relay => |r| try toBytesAux(r.header, r.payload, &buf, allocator),
.connection => |c| try toBytesAux(c.header, c.payload, &buf, allocator),
.file_transfer => return SaprusError.NotImplementedSaprusType,
.file_transfer => return Error.NotImplementedSaprusType,
}
// Collect the growable list as a slice and return it.
@@ -116,12 +116,12 @@ pub const SaprusMessage = union(SaprusPacketType) {
}
fn fromBytesAux(
comptime packet: SaprusPacketType,
comptime packet: PacketType,
len: u16,
r: std.io.FixedBufferStream([]const u8).Reader,
allocator: Allocator,
) !SaprusMessage {
const Header = @field(@FieldType(SaprusMessage, @tagName(packet)), "Header");
) !Message {
const Header = @field(@FieldType(Message, @tagName(packet)), "Header");
// Read the header for the current message type.
var header_bytes: [@sizeOf(Header)]u8 = undefined;
@@ -138,20 +138,20 @@ pub const SaprusMessage = union(SaprusPacketType) {
const payload = try allocator.alloc(u8, try base64Dec.calcSizeForSlice(payload_buf));
try base64Dec.decode(payload, payload_buf);
// Return the type of SaprusMessage specified by the `packet` argument.
return @unionInit(SaprusMessage, @tagName(packet), .{
// Return the type of Message specified by the `packet` argument.
return @unionInit(Message, @tagName(packet), .{
.header = header,
.payload = payload,
});
}
/// Caller is responsible for calling .deinit on the returned value.
pub fn fromBytes(bytes: []const u8, allocator: Allocator) !SaprusMessage {
pub fn fromBytes(bytes: []const u8, allocator: Allocator) !Message {
var s = std.io.fixedBufferStream(bytes);
const r = s.reader();
// Read packet type
const packet_type = @as(SaprusPacketType, @enumFromInt(try r.readInt(u16, .big)));
const packet_type = @as(PacketType, @enumFromInt(try r.readInt(u16, .big)));
// Read the length of the header + base64 encoded payload.
const len = try r.readInt(u16, .big);
@@ -159,8 +159,8 @@ pub const SaprusMessage = union(SaprusPacketType) {
switch (packet_type) {
.relay => return fromBytesAux(.relay, len, r, allocator),
.connection => return fromBytesAux(.connection, len, r, allocator),
.file_transfer => return SaprusError.NotImplementedSaprusType,
else => return SaprusError.UnknownSaprusType,
.file_transfer => return Error.NotImplementedSaprusType,
else => return Error.UnknownSaprusType,
}
}
};
@@ -173,7 +173,7 @@ const nativeToBig = std.mem.nativeToBig;
test "Round trip Relay toBytes and fromBytes" {
const gpa = std.testing.allocator;
const msg = SaprusMessage{
const msg = Message{
.relay = .{
.header = .{ .dest = .{ 255, 255, 255, 255 } },
.payload = "Hello darkness my old friend",
@@ -183,7 +183,7 @@ test "Round trip Relay toBytes and fromBytes" {
const to_bytes = try msg.toBytes(gpa);
defer gpa.free(to_bytes);
const from_bytes = try SaprusMessage.fromBytes(to_bytes, gpa);
const from_bytes = try Message.fromBytes(to_bytes, gpa);
defer from_bytes.deinit(gpa);
try std.testing.expectEqualDeep(msg, from_bytes);
@@ -191,7 +191,7 @@ test "Round trip Relay toBytes and fromBytes" {
test "Round trip Connection toBytes and fromBytes" {
const gpa = std.testing.allocator;
const msg = SaprusMessage{
const msg = Message{
.connection = .{
.header = .{
.src_port = 0,
@@ -204,7 +204,7 @@ test "Round trip Connection toBytes and fromBytes" {
const to_bytes = try msg.toBytes(gpa);
defer gpa.free(to_bytes);
const from_bytes = try SaprusMessage.fromBytes(to_bytes, gpa);
const from_bytes = try Message.fromBytes(to_bytes, gpa);
defer from_bytes.deinit(gpa);
try std.testing.expectEqualDeep(msg, from_bytes);

2
src/root.zig Normal file
View File

@@ -0,0 +1,2 @@
pub const Client = @import("Saprus.zig");
pub usingnamespace @import("message.zig");