Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / grpc-grpc-java / 589afefa59eeea3d51250f9297a09b483a34d53d
commit589afefa59eeea3d51250f9297a09b483a34d53d[log] [tgz]
authorMark Kelly <mkelly28@tcd.ie>Sat May 09 10:59:20 2015 +0100
committerEric Anderson <ejona@google.com>Sat May 09 09:38:25 2015 -0700
tree191c8c0a33c5f431a37a896cddd483d17ac6d9a6
parent3462eb0e7288952afa4e297b7822617223be07d5 [diff]
changed the netty-codec-http2 depdendency to released version

* 4.1.0.Beta5
* available on maven central http://search.maven.org/#artifactdetails%7Cio.netty%7Cnetty-codec-http2%7C4.1.0.Beta5%7Cjar
* git tag release 4.1.0.Beta5
2 files changed
tree: 191c8c0a33c5f431a37a896cddd483d17ac6d9a6
  1. all/
  2. auth/
  3. benchmarks/
  4. buildscripts/
  5. compiler/
  6. core/
  7. examples/
  8. gradle/
  9. integration-testing/
  10. lib/
  11. netty/
  12. okhttp/
  13. protobuf/
  14. protobuf-nano/
  15. stub/
  16. testing/
  17. .gitignore
  18. .gitmodules
  19. .travis.yml
  20. AUTH-README.md
  21. build.gradle
  22. checkstyle.license
  23. checkstyle.xml
  24. CONTRIBUTING.md
  25. DEPLOYING.md
  26. gradlew
  27. gradlew.bat
  28. LICENSE
  29. PATENTS
  30. README.md
  31. run-test-client.sh
  32. run-test-server.sh
  33. settings.gradle
README.md

gRPC-Java - An RPC library and framework

Build Status

How to Build

Build Netty

grpc-java requires Netty 4.1, 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

Build gRPC

grpc-java has a C++ code generation plugin for protoc. Since many Java developers don't have C compilers installed and don't need to modify the codegen, the build can skip it. To skip, create the file <project-root>/gradle.properties and add skipCodegen=true.

Then, to build, run:

$ ./gradlew build

To install the artifacts to your Maven local repository for use in your own project, run:

$ ./gradlew install

How to Build Code Generation Plugin

This section is only necessary if you are making changes to the code generation. Most users only need to use skipCodegen=true as discussed above.

Build Protobuf

The codegen plugin is C++ code and requires protobuf 3.0.0-alpha-2.

For Linux, Mac and MinGW:

$ 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

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.

For Visual C++, please refer to the Protobuf README for how to compile Protobuf.

Linux and MinGW

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

Mac

Some versions of Mac OS X (e.g., 10.10) doesn't have /usr/local in the default search paths for header files and libraries. It will fail the build of the codegen. To work around this, you will need to set environment variables:

$ export CXXFLAGS="-I/usr/local/include" LDFLAGS="-L/usr/local/lib"

Notes for Visual C++

When building on Windows and VC++, you need to specify project properties for Gradle to find protobuf:

.\gradlew install ^
    -PvcProtobufInclude=C:\path\to\protobuf-3.0.0-alpha-2\src ^
    -PvcProtobufLibs=C:\path\to\protobuf-3.0.0-alpha-2\vsprojects\Release

Since specifying those properties every build is bothersome, you can instead create <project-root>\gradle.properties with contents like:

vcProtobufInclude=C:\\path\\to\\protobuf-3.0.0-alpha-2\\src
vcProtobufLibs=C:\\path\\to\\protobuf-3.0.0-alpha-2\\vsprojects\\Release

The build script will build the codegen for the same architecture as the Java runtime installed on your system. If you are using 64-bit JVM, the codegen will be compiled for 64-bit, that means you must have compiled Protobuf in 64-bit.

Notes for MinGW on Windows

If you have both MinGW and VC++ installed on Windows, VC++ will be used by default. To override this default and use MinGW, add -PvcDisable=true to your Gradle command line or add vcDisable=true to your <project-root>\gradle.properties.

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