Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / grpc-grpc / 41e58b4b1ac7e2934299e3855a1b1c5571282690
commit41e58b4b1ac7e2934299e3855a1b1c5571282690[log] [tgz]
authorJan Tattermusch <jtattermusch@google.com>Tue Jan 16 17:58:05 2018 +0100
committerJan Tattermusch <jtattermusch@google.com>Tue Jan 16 18:07:46 2018 +0100
tree8932715198be8f255c19cbd209a4a740244edde3
parent586f719898486303c0c990919bfba05a3e127a16 [diff]
regenerate
1 file changed
tree: 8932715198be8f255c19cbd209a4a740244edde3
  1. .github/
  2. .vscode/
  3. bazel/
  4. cmake/
  5. doc/
  6. etc/
  7. examples/
  8. include/
  9. src/
  10. summerofcode/
  11. templates/
  12. test/
  13. third_party/
  14. tools/
  15. vsprojects/
  16. .clang-format
  17. .clang_complete
  18. .editorconfig
  19. .gitignore
  20. .gitmodules
  21. .istanbul.yml
  22. .pylintrc
  23. .rspec
  24. .travis.yml
  25. .yardopts
  26. AUTHORS
  27. BUILD
  28. build.yaml
  29. build_config.rb
  30. CMakeLists.txt
  31. CODE-OF-CONDUCT.md
  32. composer.json
  33. config.m4
  34. config.w32
  35. CONTRIBUTING.md
  36. Gemfile
  37. gRPC-Core.podspec
  38. gRPC-ProtoRPC.podspec
  39. gRPC-RxLibrary.podspec
  40. grpc.bzl
  41. grpc.def
  42. grpc.gemspec
  43. grpc.gyp
  44. gRPC.podspec
  45. INSTALL.md
  46. LICENSE
  47. Makefile
  48. MANIFEST.md
  49. NOTICE.txt
  50. OWNERS
  51. package.xml
  52. PYTHON-MANIFEST.in
  53. Rakefile
  54. README.md
  55. requirements.txt
  56. setup.cfg
  57. setup.py
  58. WORKSPACE
README.md

Build Status

gRPC - An RPC library and framework

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

Copyright 2015 The gRPC Authors

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 the latest released version.

Repository Structure & Status

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

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

LanguageSource
Shared C [core library]src/core
C++src/cpp
Rubysrc/ruby
Pythonsrc/python
PHPsrc/php
C#src/csharp
Objective-Csrc/objective-c

Java source code is in the grpc-java repository. Go source code is in the grpc-go repository. NodeJS source code is in the grpc-node repository.

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.