Go to file
Jakob Buchgraber 4a2c0a5637 Have SendGrpcFrameCommand constructor take an AbstractStream object instead of a stream id.
As part of the effort to remove all blocking bits from the NettyClientStream with
this commit the SendGrpcFrameCommand now takes a stream object instead of the
stream id. This will be necessary as in a non blocking world the stream id might
not have yet been allocated when the SendGrpcFrameCommand gets instantiated.
2015-03-02 11:37:57 -08:00
all Removing all references to "stubby" 2015-01-27 11:25:25 -08:00
auth Udate TODOs to use Github user names 2015-02-23 12:46:28 -08:00
benchmarks Add duration paramter to QPS Client and remove "server_threads" parameter. 2015-02-20 13:32:55 -08:00
compiler Update compiler/README.md with nano codegen commandline 2015-02-26 11:19:59 -08:00
core Polish javadoc for transport/ 2015-03-02 11:10:29 -08:00
examples More example changes to match style guide. 2015-02-27 11:04:42 -08:00
gradle/wrapper Add Gradle wrapper for building. 2015-01-27 16:30:48 -08:00
integration-testing Adding SimpleContext back into messages.proto. 2015-02-26 10:33:18 -08:00
lib Remove OkHttp submodule as we now depend on a release version. 2015-01-27 15:43:10 -08:00
nano Open source nano proto related code 2015-02-25 15:36:20 -08:00
netty Have SendGrpcFrameCommand constructor take an AbstractStream object instead of a stream id. 2015-03-02 11:37:57 -08:00
okhttp Bug fix. frameWriter and frameReader are not initialized when an Exception is thrown in socket creation. 2015-02-26 10:48:14 -08:00
stub Implement cancellation for the Future interface. 2015-03-02 10:33:59 -08:00
testing Removing all references to "stubby" 2015-01-27 11:25:25 -08:00
.gitignore Remove target from .gitignore 2015-02-23 11:59:13 -08:00
.gitmodules Remove OkHttp submodule as we now depend on a release version. 2015-01-27 15:43:10 -08:00
CONTRIBUTING.md Update CONTRIBUTING.md 2015-02-25 18:08:52 -08:00
LICENSE Initial commit 2015-01-08 14:42:02 -08:00
PATENTS Create PATENTS 2015-02-26 15:10:59 -08:00
README.md Depend on proto 3.0.0-alpha-2 instead of snapshot 2015-02-26 07:56:13 -08:00
build.gradle Depend on proto 3.0.0-alpha-2 instead of snapshot 2015-02-26 07:56:13 -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
gradlew Add Gradle wrapper for building. 2015-01-27 16:30:48 -08:00
gradlew.bat Add Gradle wrapper for building. 2015-01-27 16:30:48 -08:00
run-test-client.sh Allow running test scripts from any directory 2015-02-17 13:46:09 -08:00
run-test-server.sh Allow running test scripts from any directory 2015-02-17 13:46:09 -08:00
settings.gradle Open source nano proto related code 2015-02-25 15:36:20 -08:00

README.md

grpc-java

How to Build

grpc-java requires Netty 5, which is still in flux. The version we need can be found in the lib/netty submodule, which requires Maven 3.2 or higher to build:

$ git submodule update --init
$ cd lib/netty
$ mvn install -pl codec-http2 -am -DskipTests=true

The codegen plugin requires protobuf 3.0.0-alpha-2:

$ git clone https://github.com/google/protobuf.git
$ cd protobuf
$ git checkout v3.0.0-alpha-2
$ ./autogen.sh
$ ./configure
$ make
$ make check
$ sudo make install
$ cd java
$ mvn install
$ cd ../javanano
$ mvn install

If you are comfortable with C++ compilation and autotools, you can specify a --prefix for protobuf and use -I in CXXFLAGS, -L in LDFLAGS, LD_LIBRARY_PATH, and PATH to reference it. The environment variables will be used when building grpc-java.

Protobuf installs to /usr/local by default. If /usr/local/lib is not in your library search path, you can add it by running:

$ sudo sh -c 'echo /usr/local/lib >> /etc/ld.so.conf'
$ sudo ldconfig

Now to build grpc-java itself:

$ ./gradlew install

Navigating Around the Source

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/io/grpc/testing/integration