You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Motivation:
- Improve documentation to include references for idiomatic gRPC/IO client and server APIs.
- Provide clear comparisons between high-level and low-level APIs for clarity.
Changes:
- Updated `ioclient.adoc` and `ioserver.adoc` with new sections for idiomatic gRPC/IO APIs.
- Added detailed descriptions and tables in `plugin.adoc` to explain generated RPC files and their purposes.
- Added anchors for client and server request/response API sections (`client-request-response-api`, `server-request-response-api`).
Copy file name to clipboardExpand all lines: vertx-grpc-docs/src/main/asciidoc/ioserver.adoc
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,6 +42,7 @@ The Vert.x gRPC Server can bridge a gRPC service to use with _grpc-java_ generat
42
42
43
43
The bridge supports deadline automatic cancellation: when a gRPC request carrying a timeout is received, a deadline is associated with the `io.grpc.Context` an can be obtained from the current context. This deadline automatically cancels the request in progress when its associated timeout fires.
44
44
45
+
[[idiomatic-server-io]]
45
46
=== Idiomatic gRPC/IO service
46
47
47
48
The <<vertx-grpc-protoc-plugin,Vert.x gRPC protoc plugin>> supports the generation of gRPC/IO client code:
NOTE: The `GreeterGrpcClient` and `GreeterGrpcService` classes provide lower-level APIs that give you more control over streaming and flow control, while `GreeterClient` and `GreeterService` provide higher-level, more idiomatic Vert.x APIs that are easier to use for most cases.
244
+
245
+
Additionally, when `grpc-io=true` is enabled, the plugin generates:
246
+
247
+
[cols="2,4,1", options="header"]
248
+
|===
249
+
|Generated File |Description |Details
250
+
251
+
|`GreeterGrpcIo.java`
252
+
|Compatibility layer for using the service with standard `io.grpc` stubs and existing gRPC/IO ecosystem
0 commit comments