grpc/src/ruby
Soheil Hassas Yeganeh ad1b3e5094 Introduce grpc_byte_buffer_reader_peek and use it for Protobuf parsing.
grpc_byte_buffer_reader_next() copies and references the slice. This
is not always necessary since the caller will not use the slice
after destroying the byte buffer.

A prominent example is the protobuf parser, which
calls grpc_byte_buffer_reader_next() and immediately unrefs the slice
after the call. This ref() and unref() calls can be very expensive
in the hot path.

This commit introduces grpc_byte_buffer_reader_peek() which
essentialy return a pointer to the slice in the buffer, i.e.,
no copies, and no refs.

QPS of 1MiB 1 Channel callback benchmark increases by 5%.
More importantly insructions per cycle is increased by 10%.

Also add tests and benchmarks for byte_buffer_reader_peek()

This commit reaplies 509e77a5a3
2019-03-21 06:03:45 -04:00
..
bin regenerate ruby protos 2019-03-12 05:09:46 -04:00
end2end ruby-sigint ready to be merged! 2018-12-26 11:17:48 -08:00
ext/grpc Introduce grpc_byte_buffer_reader_peek and use it for Protobuf parsing. 2019-03-21 06:03:45 -04:00
lib Merge pull request #16240 from mattolson/fix-default-pool-keep-alive 2019-02-14 23:22:45 -08:00
pb regenerate ruby protos 2019-03-12 05:09:46 -04:00
qps Fix broken php7 performance benchmarks build 2019-03-18 15:12:46 -07:00
spec Return unimplemented 2018-11-25 17:31:53 +09:00
stress auto-fix most of licenses 2017-06-08 11:22:41 +02:00
tools Regenerate projects 2019-02-12 21:07:42 -08:00
.gitignore Incorporating ruby into the master grpc repository. 2014-12-01 17:45:43 -08:00
.rubocop.yml add end2end tests to formatter and adjust to formatter 2017-03-20 00:07:25 -07:00
.rubocop_todo.yml add rubocop warnings to TODO config file 2017-09-05 09:40:18 +02:00
CHANGELOG.md Corrects the Changelog date 2015-04-14 11:03:37 -07:00
README.md [Ruby] Specify module init after cloning repo 2017-12-14 02:48:55 -07:00

README.md

Gem gRPC Ruby

A Ruby implementation of gRPC.

PREREQUISITES

  • Ruby 2.x. The gRPC API uses keyword args.

INSTALLATION

Linux and Mac OS X:

gem install grpc

BUILD FROM SOURCE

  • Clone this repository

  • Init submodules

git submodule update --init
  • Install Ruby 2.x. Consider doing this with RVM, it's a nice way of controlling the exact ruby version that's used.
$ command curl -sSL https://rvm.io/mpapis.asc | gpg --import -
$ \curl -sSL https://get.rvm.io | bash -s stable --ruby=ruby-2
$
$ # follow the instructions to ensure that your're using the latest stable version of Ruby
$ # and that the rvm command is installed
  • Make sure your run source $HOME/.rvm/scripts/rvm as instructed to complete the set up of RVM

  • Install bundler

$ gem install bundler
  • Finally, build and install the gRPC gem locally.
$ # from this directory
$ bundle install  # creates the ruby bundle, including building the grpc extension
$ rake  # runs the unit tests, see rake -T for other options

DOCUMENTATION

  • rubydoc for the gRPC gem is available online at rubydoc.
  • the gRPC Ruby reference documentation is available online at grpc.io

CONTENTS

Directory structure is the layout for ruby extensions

  • ext: the gRPC ruby extension

  • lib: the entrypoint gRPC ruby library to be used in a 'require' statement

  • spec: Rspec unittests

  • bin: example gRPC clients and servers, e.g,

    stub = Math::Math::Stub.new('my.test.math.server.com:8080', :this_channel_is_insecure)
    req = Math::DivArgs.new(dividend: 7, divisor: 3)
    GRPC.logger.info("div(7/3): req=#{req.inspect}")
    resp = stub.div(req)
    GRPC.logger.info("Answer: #{resp.inspect}")