gRPC Examples
The grpc folder contains examples for
the gRPC application protocol. We provide
implementations for the examples proto services provided by
gRPC.
Hello World
Implementation for the gRPC hello world example.
Asynchronous
This example demonstrates asynchronous request processing for the hello world API using the HelloWorldServer and a HelloWorldClient
Blocking
This example demonstrates blocking request processing for the hello world API using the BlockingHelloWorldServer and a BlockingHelloWorldClient
Route guide
Implementation for the gRPC route guide example.
Asynchronous
Asynchronous processing for different APIs in the route guide service are demonstrated using the RouteGuideServer and the following clients:
-
RouteGuideClient -
getFeatureAPI that uses the aggregated programming paradigm. -
RouteGuideRequestStreamingClient -
recordRouteAPI that uses the request streaming programming paradigm. -
RouteGuideResponseStreamingClient -
recordRouteAPI that uses the response streaming programming paradigm. -
RouteGuideStreamingClient -
recordRouteAPI that uses the bi-directional streaming programming paradigm.
Blocking
Blocking processing for different APIs in the route guide service are demonstrated using the BlockingRouteGuideServer and the following clients:
-
BlockingRouteGuideClient -
getFeatureAPI that uses the aggregated programming paradigm. -
BlockingRouteGuideRequestStreamingClient -
recordRouteAPI that uses the request streaming programming paradigm. -
BlockingRouteGuideResponseStreamingClient -
recordRouteAPI that uses the response streaming programming paradigm. -
BlockingRouteGuideStreamingClient -
recordRouteAPI that uses the bi-directional streaming programming paradigm.
Compression
Extends the async "Hello World" example to demonstrate compression of the response body.
-
CompressionExampleServer - Waits for hello request from the client and responds with a compressed greeting response.
-
CompressionExampleClient - Sends a hello request to the server and receives a compressed greeting response.
Deadlines
Extends the async "Hello World" example to demonstrate gRPC deadlines (aka timeout).
-
DeadlineServer – Waits for hello request from the client and, after 5 seconds of delay, responds with a greeting response.
-
DeadlineClient – Sends hello requests to the server with 1 minute deadline and 3 second deadline and receives a greeting response within that time or cancels the request.
Application Errors
The gRPC protocol supports propagating application level errors, and also provides serialization/deserialization of
these objects. This example demonstrates a server returning an application level error to the client via the gRPC
transport. The client intentionally omits the token field which is required, and the server returns an application
level error. In this case the application level error type happens to be defined in
error_details.proto, but it
could be any protobuf object.
-
ErrorExampleServer - Requires each request has a non-empty
tokenfield or else returns an error. -
ErrorExampleClient - Sends a request with missing
tokenfield to simulate an error condition on the server.
Protoc Options
This example demonstrates how options for the servicetalk-grpc-protoc plugin can be used. See protoc-options for more details.