grpc
/
grpc-experiments
mirror of https://github.com/grpc/grpc-experiments.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updating documentation.

This commit is contained in:
Nicolas "Pixel" Noble 2015-04-10 00:24:09 +02:00
parent 9efc083006
commit b6413de273
3 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
cpp/README.md
View File

@ -30,12 +30,13 @@ $ cd grpc-common/cpp/helloworld/
To generate the client and server side interfaces: To generate the client and server side interfaces:
```sh ```sh
$ make helloworld.pb.cc $ make helloworld.grpc.pb.cc helloworld.pb.cc
``` ```
Which internally invokes the proto-compiler as: Which internally invokes the proto-compiler as:
```sh ```sh
$ protoc -I ../../protos/ --cpp_out=. --grpc_out=. --plugin=protoc-gen-grpc=grpc_cpp_plugin ../../protos/helloworld.proto $ protoc -I ../../protos/ --grpc_out=. --plugin=protoc-gen-grpc=grpc_cpp_plugin ../../protos/helloworld.proto
$ protoc -I ../../protos/ --cpp_out=. ../../protos/helloworld.proto
``` ```
### Client and server implementations ### Client and server implementations

11
cpp/cpptutorial.md
View File

@ -94,18 +94,21 @@ Next we need to generate the gRPC client and server interfaces from our .proto s
For simplicity, we've provided a [makefile](https://github.com/grpc/grpc-common/blob/master/cpp/route_guide/Makefile) that runs `protoc` for you with the appropriate plugin, input, and output (if you want to run this yourself, make sure you've installed protoc and followed the gRPC code [installation instructions](https://github.com/grpc/grpc/blob/master/INSTALL) first): For simplicity, we've provided a [makefile](https://github.com/grpc/grpc-common/blob/master/cpp/route_guide/Makefile) that runs `protoc` for you with the appropriate plugin, input, and output (if you want to run this yourself, make sure you've installed protoc and followed the gRPC code [installation instructions](https://github.com/grpc/grpc/blob/master/INSTALL) first):
```shell ```shell
$ make route_guide.pb.cc $ make route_guide.grpc.pb.cc route_guide.pb.cc
``` ```
which actually runs: which actually runs:
```shell ```shell
$ protoc -I ../../protos --cpp_out=. --grpc_out=. --plugin=protoc-gen-grpc=`which grpc_cpp_plugin` ../../protos/route_guide.proto $ protoc -I ../../protos --grpc_out=. --plugin=protoc-gen-grpc=`which grpc_cpp_plugin` ../../protos/route_guide.proto
$ protoc -I ../../protos --cpp_out=. ../../protos/route_guide.proto
``` ```
Running this command generates the following files in your current directory: Running this command generates the following files in your current directory:
- `route_guide.pb.h`, the header which declares your generated classes - `route_guide.pb.h`, the header which declares your generated message classes
- `route_guide.pb.cc`, which contains the implementation of your classes - `route_guide.pb.cc`, which contains the implementation of your message classes
- `route_guide.grpc.pb.h`, the header which declares your generated service classes
- `route_guide.grpc.pb.cc`, which contains the implementation of your service classes
These contain: These contain:
- All the protocol buffer code to populate, serialize, and retrieve our request and response message types - All the protocol buffer code to populate, serialize, and retrieve our request and response message types

5
cpp/helloworld/README.md
View File

@ -78,12 +78,13 @@ defined in our `Greeting` service.
To generate the client and server side interfaces: To generate the client and server side interfaces:
```sh ```sh
$ make helloworld.pb.cc $ make helloworld.grpc.pb.cc helloworld.pb.cc
``` ```
Which internally invokes the proto-compiler as: Which internally invokes the proto-compiler as:
```sh ```sh
$protoc -I ../../protos/ --cpp_out=. --grpc_out=. --plugin=protoc-gen-grpc=grpc_cpp_plugin helloworld.proto $ protoc -I ../../protos/ --grpc_out=. --plugin=protoc-gen-grpc=grpc_cpp_plugin ../../protos/helloworld.proto
$ protoc -I ../../protos/ --cpp_out=. ../../protos/helloworld.proto
``` ```
### Writing a client ### Writing a client