Add Handshake rpc service to all proto files

Handshake service has been added to all protobuf files. This was done to allow for a basic interaction to verify communication integrity before the actual data transaction takes place. This handshaking mechanism helps establish parameters of a data transfer before it starts and can also be used for subscribing to broadcasts. Contributes to CURA-10714
Ultimaker · Jul 5, 2023 · b77f6d3 · b77f6d3
1 parent 6787243
commit b77f6d3
Show file tree

Hide file tree

Showing 10 changed files with 35 additions and 0 deletions.
diff --git a/cura/plugins/slots/comb/v0/comb.proto b/cura/plugins/slots/comb/v0/comb.proto
@@ -4,8 +4,10 @@ package cura.plugins.slots.comb.v0;
 
 import "cura/plugins/v0/polygons.proto";
 import "cura/plugins/v0/toolpaths.proto";
+import "cura/plugins/v0/handshake.proto";
 
 service CombService {
+  rpc Handshake(cura.plugins.v0.HandshakeRequest) returns (cura.plugins.v0.HandshakeResponse) {}
   rpc Modify(CombServiceModifyRequest) returns (CombServiceModifyResponse) {}
 }
 

diff --git a/cura/plugins/slots/infill/v0/infill.proto b/cura/plugins/slots/infill/v0/infill.proto
@@ -3,8 +3,10 @@ syntax = "proto3";
 package cura.plugins.slots.infill.v0;
 
 import "cura/plugins/v0/layers.proto";
+import "cura/plugins/v0/handshake.proto";
 
 service InfillService {
+  rpc Handshake(cura.plugins.v0.HandshakeRequest) returns (cura.plugins.v0.HandshakeResponse) {}
   rpc Modify(InfillServiceModifyRequest) returns (InfillServiceModifyResponse) {}
 }
 

diff --git a/cura/plugins/slots/overhang_areas/v0/overhang_areas.proto b/cura/plugins/slots/overhang_areas/v0/overhang_areas.proto
@@ -3,8 +3,10 @@ syntax = "proto3";
 package cura.plugins.slots.overhang_areas.v0;
 
 import "cura/plugins/v0/polygons.proto";
+import "cura/plugins/v0/handshake.proto";
 
 service OverhangAreasService {
+  rpc Handshake(cura.plugins.v0.HandshakeRequest) returns (cura.plugins.v0.HandshakeResponse) {}
   rpc Modify(OverhangAreasServiceModifyRequest) returns (OverhangAreasServiceModifyResponse) {}
 }
 

diff --git a/cura/plugins/slots/platform_adhesion/v0/platform_adhesion.proto b/cura/plugins/slots/platform_adhesion/v0/platform_adhesion.proto
@@ -4,8 +4,10 @@ package cura.plugins.slots.platform_adhesion.v0;
 
 import "cura/plugins/v0/polygons.proto";
 import "cura/plugins/v0/toolpaths.proto";
+import "cura/plugins/v0/handshake.proto";
 
 service PlatformAdhesionService {
+  rpc Handshake(cura.plugins.v0.HandshakeRequest) returns (cura.plugins.v0.HandshakeResponse) {}
   rpc Modify(PlatformAdhesionServiceModifyRequest) returns (PlatformAdhesionServiceModifyResponse) {}
 }
 

diff --git a/cura/plugins/slots/postprocess/v0/postprocess.proto b/cura/plugins/slots/postprocess/v0/postprocess.proto
@@ -2,7 +2,10 @@ syntax = "proto3";
 
 package cura.plugins.slots.postprocess.v0;
 
+import "cura/plugins/v0/handshake.proto";
+
 service PostprocessService {
+  rpc Handshake(cura.plugins.v0.HandshakeRequest) returns (cura.plugins.v0.HandshakeResponse) {}
   rpc Modify(PostprocessServiceModifyRequest) returns (PostprocessServiceModifyResponse) {}
 }
 

diff --git a/cura/plugins/slots/simplify/v0/simplify.proto b/cura/plugins/slots/simplify/v0/simplify.proto
@@ -3,8 +3,10 @@ syntax = "proto3";
 package cura.plugins.slots.simplify.v0;
 
 import "cura/plugins/v0/polygons.proto";
+import "cura/plugins/v0/handshake.proto";
 
 service SimplifyService {
+  rpc Handshake(cura.plugins.v0.HandshakeRequest) returns (cura.plugins.v0.HandshakeResponse) {}
   rpc Modify(SimplifyServiceModifyRequest) returns (SimplifyServiceModifyResponse) {}
 }
 

diff --git a/cura/plugins/slots/skin/v0/skin.proto b/cura/plugins/slots/skin/v0/skin.proto
@@ -1,9 +1,12 @@
 syntax = "proto3";
 
 package cura.plugins.slots.skin.v0;
+
 import "cura/plugins/v0/layers.proto";
+import "cura/plugins/v0/handshake.proto";
 
 service SkinService {
+    rpc Handshake(cura.plugins.v0.HandshakeRequest) returns (cura.plugins.v0.HandshakeResponse) {}
     rpc Modify(SkinServiceModifyRequest) returns (SkinServiceModifyResponse) {}
 }
 

diff --git a/cura/plugins/slots/slice/v0/slice.proto b/cura/plugins/slots/slice/v0/slice.proto
@@ -3,8 +3,10 @@ syntax = "proto3";
 package cura.plugins.slots.slice.v0;
 
 import "cura/plugins/v0/polygons.proto";
+import "cura/plugins/v0/handshake.proto";
 
 service SliceService {
+  rpc Handshake(cura.plugins.v0.HandshakeRequest) returns (cura.plugins.v0.HandshakeResponse) {}
   rpc Modify(SliceServiceModifyRequest) returns (SliceResponse) {}
 }
 

diff --git a/cura/plugins/slots/wall_toolpaths/v0/wall_toolpaths.proto b/cura/plugins/slots/wall_toolpaths/v0/wall_toolpaths.proto
@@ -3,8 +3,10 @@ syntax = "proto3";
 package cura.plugins.slots.wall_toolpaths.v0;
 
 import "cura/plugins/v0/layers.proto";
+import "cura/plugins/v0/handshake.proto";
 
 service WallToolpathsService {
+  rpc Handshake(cura.plugins.v0.HandshakeRequest) returns (cura.plugins.v0.HandshakeResponse) {}
   rpc Modify(WallToolpathsServiceModifyRequest) returns (WallToolpathsServiceModifyResponse) {}
 }
 

diff --git a/cura/plugins/v0/handshake.proto b/cura/plugins/v0/handshake.proto
@@ -0,0 +1,15 @@
+syntax = "proto3";
+
+package cura.plugins.v0;
+
+message HandshakeRequest {
+   string service_name = 1;
+   string version_range = 2;
+}
+
+message HandshakeResponse {
+   string slot_version = 1;
+   string plugin_name = 2;
+   string plugin_version = 3;
+   repeated string subscriptions = 4;
+}