diff options
Diffstat (limited to 'src/ruby/lib')
| -rw-r--r-- | src/ruby/lib/grpc.rb | 1 | ||||
| -rw-r--r-- | src/ruby/lib/grpc/core/compression_options.rb | 93 |
2 files changed, 94 insertions, 0 deletions
diff --git a/src/ruby/lib/grpc.rb b/src/ruby/lib/grpc.rb index 79fa705b1c..2dae3a64d6 100644 --- a/src/ruby/lib/grpc.rb +++ b/src/ruby/lib/grpc.rb @@ -35,6 +35,7 @@ require_relative 'grpc/logconfig' require_relative 'grpc/notifier' require_relative 'grpc/version' require_relative 'grpc/core/time_consts' +require_relative 'grpc/core/compression_options' require_relative 'grpc/generic/active_call' require_relative 'grpc/generic/client_stub' require_relative 'grpc/generic/service' diff --git a/src/ruby/lib/grpc/core/compression_options.rb b/src/ruby/lib/grpc/core/compression_options.rb new file mode 100644 index 0000000000..757c69f8e0 --- /dev/null +++ b/src/ruby/lib/grpc/core/compression_options.rb @@ -0,0 +1,93 @@ +# Copyright 2015, Google Inc. +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are +# met: +# +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above +# copyright notice, this list of conditions and the following disclaimer +# in the documentation and/or other materials provided with the +# distribution. +# * Neither the name of Google Inc. nor the names of its +# contributors may be used to endorse or promote products derived from +# this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +require_relative '../grpc' + +# GRPC contains the General RPC module. +module GRPC + module Core + # Wrapper for grpc_compression_options in core + # This class is defined as a C extension but is reopened here + # to add the initialization logic. + # + # This class wraps a GRPC core compression options. + # + # It can be used to create a channel argument key-value hash + # with keys and values that correspond to the compression settings + # provided here. + # + # call-seq: + # options = CompressionOptions.new( + # default_level: low, + # disabled_algorithms: [:<valid_algorithm_name>]) + # + # channel_args = Hash.new[...] + # channel_args_with_compression_args = channel_args.merge(options) + class CompressionOptions + alias_method :to_channel_arg_hash, :to_hash + + # Initializes a CompresionOptions instance. + # Starts out with all available compression + # algorithms enabled by default. + # + # Valid algorithms are those supported by the GRPC core + # + # @param default_level [String | Symbol] + # one of 'none', 'low', 'medium', 'high' + # @param default_algorithm [String | Symbol] + # a valid GRPC algorithm + # @param disabled_algorithms [Array<String, Symbol>] + # can contain valid GRPC algorithm names + def initialize(default_algorithm: nil, + default_level: nil, + disabled_algorithms: []) + # Convert possible symbols to strings for comparisons + disabled_algorithms = disabled_algorithms.map(&:to_s) + + if disabled_algorithms.include?(default_algorithm.to_s) + fail ArgumentError("#{default_algorithm} is in disabled_algorithms") + end + + set_default_algorithm(default_algorithm.to_s) unless + default_algorithm.nil? + + set_default_level(default_level.to_s) unless + default_level.nil? + + # *disabled_algorithms spreads array into variadic method parameters + disable_algorithms(*disabled_algorithms) unless + disabled_algorithms.nil? || disabled_algorithms.empty? + end + + def to_s + to_hash.to_s + end + end + end +end |