The Java gRPC implementation. HTTP/2 based RPC
Go to file
nmittler 19052499f7 Removing Maven build 2015-01-27 08:57:37 -08:00
all Removing Maven build 2015-01-27 08:57:37 -08:00
auth Removing Maven build 2015-01-27 08:57:37 -08:00
compiler Reorder the fields of LogHelper to be consistent with initialization order because blaze would complain about it 2015-01-26 15:56:52 -08:00
core Removing Maven build 2015-01-27 08:57:37 -08:00
examples/src/main Fix TODO attribution 2015-01-16 16:23:05 -08:00
integration-testing Removing Maven build 2015-01-27 08:57:37 -08:00
lib Fixes api drift, addressing inbound flow control. 2015-01-23 08:34:07 -08:00
netty Removing Maven build 2015-01-27 08:57:37 -08:00
okhttp Removing Maven build 2015-01-27 08:57:37 -08:00
stub Removing Maven build 2015-01-27 08:57:37 -08:00
testing Removing Maven build 2015-01-27 08:57:37 -08:00
.gitignore Adding .gitignore for eclipse files. 2015-01-21 16:14:48 -08:00
.gitmodules Upgrade OkHttp for Android SNI / NPN fix 2015-01-08 14:43:20 -08:00
LICENSE Initial commit 2015-01-08 14:42:02 -08:00
README.md Add README 2015-01-08 14:43:21 -08:00
build.gradle Move to a non-snapshot version of OkHttp 2015-01-26 15:48:14 -08:00
checkstyle.license Adding MOE configuration for grpc_java. 2015-01-08 14:43:02 -08:00
checkstyle.xml Adding MOE configuration for grpc_java. 2015-01-08 14:43:02 -08:00
run-test-client.sh Migrating run scripts to gradle. 2015-01-26 15:26:11 -08:00
run-test-server.sh Migrating run scripts to gradle. 2015-01-26 15:26:11 -08:00
settings.gradle Adding gradle build for Java grpc 2015-01-08 14:43:21 -08:00

README.md

grpc-java

Heres a quick readers guide to the code to help folks get started. At a high level there are three distinct layers to the library: stub, channel & transport.

Stub

The 'stub' layer is what is exposed to most developers and provides type-safe bindings to whatever datamodel/IDL/interface you are adapting. An example is provided of a binding to code generated by the protocol-buffers compiler but others should be trivial to add and are welcome.

Key Interfaces

Stream Observer

Channel

The 'channel' layer is an abstraction over transport handling that is suitable for interception/decoration and exposes more behavior to the application than the stub layer. It is intended to be easy for application frameworks to use this layer to address cross-cutting concerns such as logging, monitoring, auth etc. Flow-control is also exposed at this layer to allow more sophisticated applications to interact with it directly.

Common

Client

Server

Transport

The 'transport' layer does the heavy lifting of putting & taking bytes off the wire. The interfaces to it are abstract just enough to allow plugging in of different implementations. Transports are modeled as 'Stream' factories. The variation in interface between a server stream and a client stream exists to codify their differing semantics for cancellation and error reporting.

Common

Client

Server

Examples

Tests showing how these layers are composed to execute calls using protobuf messages can be found here https://github.com/google/grpc-java/tree/master/integration-testing/src/main/java/com/google/net/stubby/testing/integration