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