Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / grpc-grpc / 7a2c4d892740cb544513572e4070926cb5925da2
commit7a2c4d892740cb544513572e4070926cb5925da2[log] [tgz]
authorYuchen Zeng <zyc@google.com>Mon Aug 08 17:24:47 2016 -0700
committerYuchen Zeng <zyc@google.com>Mon Aug 08 17:24:47 2016 -0700
tree306f60317e972a9636b2299f94ec49be2908cdc5
parenta418ed2ddbc5a520b02c60532593bcf796d97b74 [diff]
parent50be893eba595a8cf270da3e59edd87128b854c9 [diff]
Merge remote-tracking branch 'upstream/master' into cares
tree: 306f60317e972a9636b2299f94ec49be2908cdc5
  1. doc/
  2. etc/
  3. examples/
  4. include/
  5. src/
  6. summerofcode/
  7. templates/
  8. test/
  9. third_party/
  10. tools/
  11. vsprojects/
  12. .clang-format
  13. .clang_complete
  14. .editorconfig
  15. .gitignore
  16. .gitmodules
  17. .istanbul.yml
  18. .rspec
  19. .travis.yml
  20. .yardopts
  21. binding.gyp
  22. BUILD
  23. build.yaml
  24. CMakeLists.txt
  25. composer.json
  26. config.m4
  27. CONTRIBUTING.md
  28. Gemfile
  29. gRPC-Core.podspec
  30. gRPC-ProtoRPC.podspec
  31. gRPC-RxLibrary.podspec
  32. grpc.bzl
  33. grpc.def
  34. grpc.gemspec
  35. gRPC.podspec
  36. INSTALL.md
  37. LICENSE
  38. Makefile
  39. MANIFEST.md
  40. package.json
  41. package.xml
  42. PATENTS
  43. PYTHON-MANIFEST.in
  44. Rakefile
  45. README.md
  46. requirements.txt
  47. setup.cfg
  48. setup.py
README.md

Build Status

gRPC - An RPC library and framework

Join the chat at https://gitter.im/grpc/grpc

Copyright 2015 Google Inc.

#Documentation

You can find more detailed documentation and examples in the doc and examples directories respectively.

#Installation & Testing

See INSTALL for installation instructions for various platforms.

See tools/run_tests for more guidance on how to run various test suites (e.g. unit tests, interop tests, benchmarks)

#Repository Structure & Status

This repository contains source code for gRPC libraries for multiple languages written on top of shared C core library [src/core] (src/core).

Libraries in different languages are in different states of development. We are seeking contributions for all of these libraries.

LanguageSourceStatus
Shared C [core library][src/core] (src/core)Beta - the surface API is stable
C++[src/cpp] (src/cpp)Beta - the surface API is stable
Ruby[src/ruby] (src/ruby)Beta - the surface API is stable
NodeJS[src/node] (src/node)Beta - the surface API is stable
Python[src/python] (src/python)Beta - the surface API is stable
PHP[src/php] (src/php)Beta - the surface API is stable
C#[src/csharp] (src/csharp)Beta - the surface API is stable
Objective-C[src/objective-c] (src/objective-c)Beta - the surface API is stable

See MANIFEST.md for a listing of top-level items in the repository.

#Overview

Remote Procedure Calls (RPCs) provide a useful abstraction for building distributed applications and services. The libraries in this repository provide a concrete implementation of the gRPC protocol, layered over HTTP/2. These libraries enable communication between clients and servers using any combination of the supported languages.

##Interface

Developers using gRPC typically start with the description of an RPC service (a collection of methods), and generate client and server side interfaces which they use on the client-side and implement on the server side.

By default, gRPC uses Protocol Buffers as the Interface Definition Language (IDL) for describing both the service interface and the structure of the payload messages. It is possible to use other alternatives if desired.

###Surface API Starting from an interface definition in a .proto file, gRPC provides Protocol Compiler plugins that generate Client- and Server-side APIs. gRPC users typically call into these APIs on the Client side and implement the corresponding API on the server side.

Synchronous vs. asynchronous

Synchronous RPC calls, that block until a response arrives from the server, are the closest approximation to the abstraction of a procedure call that RPC aspires to.

On the other hand, networks are inherently asynchronous and in many scenarios, it is desirable to have the ability to start RPCs without blocking the current thread.

The gRPC programming surface in most languages comes in both synchronous and asynchronous flavors.

Streaming

gRPC supports streaming semantics, where either the client or the server (or both) send a stream of messages on a single RPC call. The most general case is Bidirectional Streaming where a single gRPC call establishes a stream where both the client and the server can send a stream of messages to each other. The streamed messages are delivered in the order they were sent.

#Protocol

The gRPC protocol specifies the abstract requirements for communication between clients and servers. A concrete embedding over HTTP/2 completes the picture by fleshing out the details of each of the required operations.

Abstract gRPC protocol

A gRPC RPC comprises of a bidirectional stream of messages, initiated by the client. In the client-to-server direction, this stream begins with a mandatory Call Header, followed by optional Initial-Metadata, followed by zero or more Payload Messages. The server-to-client direction contains an optional Initial-Metadata, followed by zero or more Payload Messages terminated with a mandatory Status and optional Status-Metadata (a.k.a.,Trailing-Metadata).

Implementation over HTTP/2

The abstract protocol defined above is implemented over HTTP/2. gRPC bidirectional streams are mapped to HTTP/2 streams. The contents of Call Header and Initial Metadata are sent as HTTP/2 headers and subject to HPACK compression. Payload Messages are serialized into a byte stream of length prefixed gRPC frames which are then fragmented into HTTP/2 frames at the sender and reassembled at the receiver. Status and Trailing-Metadata are sent as HTTP/2 trailing headers (a.k.a., trailers).

Flow Control

gRPC inherits the flow control mechanisms in HTTP/2 and uses them to enable fine-grained control of the amount of memory used for buffering in-flight messages.