Yuchen Zeng 798b0dc442 Doc Fixit: src/cpp/README need more information, revised 03092016 9 years ago
..
client d59ad7ef39 Provide explicit API for user to set user agent string prefix 10 years ago
codegen e1300deb87 After GrpcLibrary refactoring. Compiles and passes. WIP still 10 years ago
common 45add8a445 Merge branch 'master' of github.com:grpc/grpc into alarm_cpp 9 years ago
proto 7536af02cf Eliminate gpr_ int types - and insist on C99 variants instead 10 years ago
server edd96e4926 Revert "Properly integrate async API with server-side cancellations." 9 years ago
util e0b0e27f3a clang-format 10 years ago
README.md 798b0dc442 Doc Fixit: src/cpp/README need more information, revised 03092016 9 years ago

README.md

#Overview

This directory contains source code for C++ implementation of gRPC.

#Status

Beta

#Pre-requisites

##Linux

 $ [sudo] apt-get install build-essential autoconf libtool

##Mac OSX

For a Mac system, git is not available by default. You will first need to install Xcode from the Mac AppStore and then run the following command from a terminal:

 $ [sudo] xcode-select --install

##Protoc

By default gRPC uses protocol buffers, you will need the protoc compiler to generate stub server and client code.

If you compile gRPC from source, as described below, this also installs the protoc compiler.

If it hasn't been installed, you can run the following commands to install it.

$ cd grpc/third_party/protobuf
$ sudo make install   # 'make' should have been run by core grpc

Alternatively, you can download protoc binaries from the protocol buffers Github repository.

#Installation

Currently to install gRPC for C++, you need to build from source as described below.

#Build from Source

 $ git clone https://github.com/grpc/grpc.git
 $ cd grpc
 $ git submodule update --init
 $ make
 $ [sudo] make install

#Documentation

You can find out how to build and run our simplest gRPC C++ example in our C++ quick start.

For more detailed documentation on using gRPC in C++ , see our main documentation site at grpc.io, specifically:

  • Overview: An introduction to gRPC with a simple Hello World example in all our supported languages, including C++.
  • gRPC Basics - C++: A tutorial that steps you through creating a simple gRPC C++ example application.
  • Asynchronous Basics - C++: A tutorial that shows you how to use gRPC C++'s asynchronous/non-blocking APIs.

Examples

Code examples for gRPC C++ live in this repository's examples/cpp directory.