| commit | c3e8dae6ce604dfdcd8fc0eb0f7b0e2303e48a98 | [log] [tgz] |
|---|---|---|
| author | Eric Anderson <ejona@google.com> | Fri Jan 30 14:58:07 2015 -0800 |
| committer | Eric Anderson <ejona@google.com> | Mon Mar 16 10:53:13 2015 -0700 |
| tree | 32aa66053706ef85a26ceae58a36adcd04b5c64d | |
| parent | c5bcbc62fe9cbdc783aef92761a73f0c553afbe0 [diff] |
Add checkstyle checking The checkstyle.xml is a slightly modified version of the upstream Google checkstyle configuration. All changes have comment describing them. Lots of warnings were corrected. Examples is the only project that has warnings still, as the necessary changes require some thought.
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
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
When building on Windows and VC++, you need to specify project properties for Gradle to find protobuf:
.\gradlew install -Pprotobuf.include=C:\path\to\protobuf-3.0.0-alpha-2\src ^
-Pprotobuf.libs=C:\path\to\protobuf-3.0.0-alpha-2\vsprojects\Release
Since specifying those properties every build is bothersome, you can instead create %HOMEDRIVE%%HOMEPATH%.gradle\gradle.properties with contents like:
protobuf.include=C:\\path\\to\\protobuf-3.0.0-alpha-2\\src protobuf.libs=C:\\path\\to\\protobuf-3.0.0-alpha-2\\vsprojects\\Release
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.
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.
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.
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.
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