Protocol design

.gitattributes

@@ -0,0 +1 @@
+**/* text eol=lf

.github/workflows/verify.yaml

@@ -0,0 +1,23 @@
+on:
+  - push
+  - pull_request
+jobs:
+  main:
+    runs-on: ubuntu-22.04
+    steps:
+      # Setup
+      - uses: actions/checkout@v4
+      - uses: seamlik/devops/.github/actions/cache-rust
+      - uses: seamlik/devops/.github/actions/cache-nodejs
+      - run: npm install --global prettier
+      - uses: bufbuild/buf-setup-action@v1
+      - uses: seamlik/devops/.github/actions/install-devops
+      - uses: arduino/setup-protoc@v3
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
+      # Verify
+      - run: cargo test
+      - run: devops format rust yaml markdown protobuf
+      - uses: seamlik/devops/.github/actions/check-formatting
+      - uses: bufbuild/buf-lint-action@v1

.gitignore

@@ -0,0 +1,2 @@
+/target/
+/Cargo.lock

Cargo.toml

@@ -0,0 +1,8 @@
+[workspace]
+members = ["protocol/rust"]
+resolver = "2"
+
+[workspace.package]
+edition = "2021"
+publish = false
+version = "0.1.0"

LICENSE.md

@@ -0,0 +1,4 @@
+# License
+
+This is not free software.
+All rights reserved.

README.md

@@ -0,0 +1,7 @@
+# Tansa: LAN service discovery over multicast
+
+Work in progress.
+
+## Project name meaning
+
+Based on Japanese 探索 with pronounciation "tansaku" meaning "discovery".

buf.work.yaml

@@ -0,0 +1,3 @@
+version: v1
+directories:
+  - protocol/grpc

protocol/grpc/buf.yaml

@@ -0,0 +1,5 @@
+version: v1
+lint:
+  except:
+    - RPC_REQUEST_STANDARD_NAME
+    - RPC_RESPONSE_STANDARD_NAME

protocol/grpc/tw/seamlik/tansa/v1/request.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+
+package tw.seamlik.tansa.v1;
+
+import "tw/seamlik/tansa/v1/socket_address.proto";
+
+message Request {
+  bytes request_id = 1;
+  SocketAddress response_collector_address = 2;
+}

protocol/grpc/tw/seamlik/tansa/v1/response.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+
+package tw.seamlik.tansa.v1;
+
+import "tw/seamlik/tansa/v1/socket_address.proto";
+
+message Response {
+  bytes request_id = 1;
+  bytes response_id = 2;
+  SocketAddress endpoint_address = 3;
+}

protocol/grpc/tw/seamlik/tansa/v1/response_collector_service.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+
+package tw.seamlik.tansa.v1;
+
+import "google/protobuf/empty.proto";
+import "tw/seamlik/tansa/v1/response.proto";
+
+service ResponseCollectorService {
+  rpc SubmitResponse(Response) returns (google.protobuf.Empty) {}
+}

protocol/grpc/tw/seamlik/tansa/v1/socket_address.proto

@@ -0,0 +1,8 @@
+syntax = "proto3";
+
+package tw.seamlik.tansa.v1;
+
+message SocketAddress {
+  bytes ipv6 = 1;
+  uint32 port = 2;
+}

protocol/rust/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+edition.workspace = true
+name = "tansa-protocol"
+publish.workspace = true
+version.workspace = true
+
+[dependencies]
+tonic = "0.11"
+prost = "0.12"
+prost-types = "0.12"
+
+[build-dependencies]
+tonic-build = "0.11"

protocol/rust/build.rs

@@ -0,0 +1,6 @@
+fn main() -> std::io::Result<()> {
+    tonic_build::configure().compile(
+        &["../grpc/tw/seamlik/tansa/v1/response_collector_service.proto"],
+        &["../grpc"],
+    )
+}

protocol/rust/src/lib.rs

@@ -0,0 +1,3 @@
+//! Generated gRPC definitions.
+
+tonic::include_proto!("tw.seamlik.tansa.v1");