aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/ruby/pb/README.md
blob: 84644e1098896e2c0ae5b9bb22cbc9dab18bf8fa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
Protocol Buffers
================

This folder contains protocol buffers provided with gRPC ruby, and the generated
code to them.

PREREQUISITES
-------------

The code is is generated using the protoc (> 3.0.0.alpha.1) and the
grpc_ruby_plugin.  These must be installed to regenerate the IDL defined
classes, but that's not necessary just to use them.

health_check/v1alpha
--------------------

This package defines the surface of a simple health check service that gRPC
servers may choose to implement, and provides an implementation for it. To
re-generate the surface.

```bash
$ # (from this directory)
$ protoc -I . grpc/health/v1alpha/health.proto \
    --grpc_out=. \
    --ruby_out=. \
    --plugin=protoc-gen-grpc=`which grpc_ruby_plugin`
```

test
----

This package defines the surface of the gRPC interop test service and client
To re-generate the surface, it's necessary to have checked-out versions of
the grpc interop test proto, e.g, by having the full gRPC repository. E.g,

```bash
$ # (from this directory within the grpc repo)
$ protoc -I../../.. ../../../test/proto/{messages,test,empty}.proto \
    --grpc_out=. \
    --ruby_out=. \
    --plugin=protoc-gen-grpc=`which grpc_ruby_plugin`
```