Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / grpc-grpc / ad286c35da683ab2e1e60c1d6fd41a75a5c5cf6f
commitad286c35da683ab2e1e60c1d6fd41a75a5c5cf6f[log] [tgz]
authorCraig Tiller <ctiller@google.com>Tue Apr 04 07:58:50 2017 -0700
committerCraig Tiller <ctiller@google.com>Tue Apr 04 07:58:50 2017 -0700
tree6a6d74648da0eae39a8c27a02eeeb64d138d84a5
parentf07e6a3136726ce28d6db9f00bf93817458d7742 [diff]
parent82c7fec59c41c7d0be23550169a46848489ba68c [diff]
Merge github.com:grpc/grpc into minimal
tree: 6a6d74648da0eae39a8c27a02eeeb64d138d84a5
  1. .vscode/
  2. bazel/
  3. cmake/
  4. doc/
  5. etc/
  6. examples/
  7. include/
  8. src/
  9. summerofcode/
  10. templates/
  11. test/
  12. third_party/
  13. tools/
  14. vsprojects/
  15. .clang-format
  16. .clang_complete
  17. .editorconfig
  18. .gitignore
  19. .gitmodules
  20. .istanbul.yml
  21. .pylintrc
  22. .rspec
  23. .travis.yml
  24. .yardopts
  25. binding.gyp
  26. BUILD
  27. build.yaml
  28. build_config.rb
  29. CMakeLists.txt
  30. composer.json
  31. config.m4
  32. CONTRIBUTING.md
  33. Gemfile
  34. gRPC-Core.podspec
  35. gRPC-ProtoRPC.podspec
  36. gRPC-RxLibrary.podspec
  37. grpc.bzl
  38. grpc.def
  39. grpc.gemspec
  40. gRPC.podspec
  41. INSTALL.md
  42. LICENSE
  43. Makefile
  44. MANIFEST.md
  45. package.json
  46. package.xml
  47. PATENTS
  48. PYTHON-MANIFEST.in
  49. Rakefile
  50. README.md
  51. requirements.txt
  52. setup.cfg
  53. setup.py
  54. WORKSPACE
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)

See Performance dashboard for the performance numbers for v1.0.x.

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 may be in different states of development. We are seeking contributions for all of these libraries.

LanguageSourceStatus
Shared C [core library]src/core1.0
C++src/cpp1.0
Rubysrc/ruby1.0
NodeJSsrc/node1.0
Pythonsrc/python1.0
PHPsrc/php1.0
C#src/csharp1.0
Objective-Csrc/objective-c1.0

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.