xref: /aosp_15_r20/external/grpc-grpc/src/ruby/pb/README.md (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2)
1*cc02d7e2SAndroid Build Coastguard WorkerProtocol Buffers
2*cc02d7e2SAndroid Build Coastguard Worker================
3*cc02d7e2SAndroid Build Coastguard Worker
4*cc02d7e2SAndroid Build Coastguard WorkerThis folder contains protocol buffers provided with gRPC ruby, and the generated
5*cc02d7e2SAndroid Build Coastguard Workercode to them.
6*cc02d7e2SAndroid Build Coastguard Worker
7*cc02d7e2SAndroid Build Coastguard WorkerPREREQUISITES
8*cc02d7e2SAndroid Build Coastguard Worker-------------
9*cc02d7e2SAndroid Build Coastguard Worker
10*cc02d7e2SAndroid Build Coastguard WorkerThe code is generated using the protoc (> 3.0.0.alpha.1) and the
11*cc02d7e2SAndroid Build Coastguard Workergrpc_ruby_plugin.  These must be installed to regenerate the IDL defined
12*cc02d7e2SAndroid Build Coastguard Workerclasses, but that's not necessary just to use them.
13*cc02d7e2SAndroid Build Coastguard Worker
14*cc02d7e2SAndroid Build Coastguard Workerhealth_check/v1
15*cc02d7e2SAndroid Build Coastguard Worker--------------------
16*cc02d7e2SAndroid Build Coastguard Worker
17*cc02d7e2SAndroid Build Coastguard WorkerThis package defines the surface of a simple health check service that gRPC
18*cc02d7e2SAndroid Build Coastguard Workerservers may choose to implement, and provides an implementation for it. To
19*cc02d7e2SAndroid Build Coastguard Workerre-generate the surface.
20*cc02d7e2SAndroid Build Coastguard Worker
21*cc02d7e2SAndroid Build Coastguard Worker```bash
22*cc02d7e2SAndroid Build Coastguard Worker$ # (from this directory)
23*cc02d7e2SAndroid Build Coastguard Worker$ protoc -I ../../proto ../../proto/grpc/health/v1/health.proto \
24*cc02d7e2SAndroid Build Coastguard Worker    --grpc_out=. \
25*cc02d7e2SAndroid Build Coastguard Worker    --ruby_out=. \
26*cc02d7e2SAndroid Build Coastguard Worker    --plugin=protoc-gen-grpc=`which grpc_ruby_plugin`
27*cc02d7e2SAndroid Build Coastguard Worker```
28*cc02d7e2SAndroid Build Coastguard Worker
29*cc02d7e2SAndroid Build Coastguard Workertest
30*cc02d7e2SAndroid Build Coastguard Worker----
31*cc02d7e2SAndroid Build Coastguard Worker
32*cc02d7e2SAndroid Build Coastguard WorkerThis package defines the surface of the gRPC interop test service and client
33*cc02d7e2SAndroid Build Coastguard WorkerTo re-generate the surface, it's necessary to have checked-out versions of
34*cc02d7e2SAndroid Build Coastguard Workerthe grpc interop test proto, e.g, by having the full gRPC repository. E.g,
35*cc02d7e2SAndroid Build Coastguard Worker
36*cc02d7e2SAndroid Build Coastguard Worker```bash
37*cc02d7e2SAndroid Build Coastguard Worker$ # (from this directory within the grpc repo)
38*cc02d7e2SAndroid Build Coastguard Worker$ protoc -I../../.. ../../../test/proto/{messages,test,empty}.proto \
39*cc02d7e2SAndroid Build Coastguard Worker    --grpc_out=. \
40*cc02d7e2SAndroid Build Coastguard Worker    --ruby_out=. \
41*cc02d7e2SAndroid Build Coastguard Worker    --plugin=protoc-gen-grpc=`which grpc_ruby_plugin`
42*cc02d7e2SAndroid Build Coastguard Worker```
43