Add duration paramter to QPS Client and remove "server_threads" parameter.

The QpsClient no longer executes a fixed number of RPCs but runs for a period of time now (see #83).
After some discussion with @ejona86, we also agreed to remove the "server_threads" parameter
and to no longer use a `DirectExecutor` and thus run the QPS Server without any tweaks and
modifications. We believe/hope that this change will make the comparison between the C++ and
Java versions less "Apples and Oranges".

The "client_threads" parameter was renamed to "concurrent_calls" to better reflect what it
acutally does.

Furthermore, I updated the gradle build script to create separate executables for the
client and the server.

I also added a README.
5 files changed
tree: 2e8a898197b96bad5ab657573ef1cefad232567c
  1. all/
  2. auth/
  3. benchmarks/
  4. compiler/
  5. core/
  6. examples/
  7. gradle/
  8. integration-testing/
  9. lib/
  10. netty/
  11. okhttp/
  12. stub/
  13. testing/
  14. .gitignore
  15. .gitmodules
  16. build.gradle
  17. checkstyle.license
  18. checkstyle.xml
  19. gradlew
  20. gradlew.bat
  21. LICENSE
  22. README.md
  23. run-test-client.sh
  24. run-test-server.sh
  25. settings.gradle
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 a recent protobuf build from master (what will become proto3):

$ git clone https://github.com/google/protobuf.git
$ cd protobuf
$ ./autogen.sh
$ ./configure
$ make
$ make check
$ sudo make install
$ cd java
$ 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