Merge branch 'master' into rubocop

.rubocop_todo.yml

@@ -109,7 +109,7 @@ Style/Documentation:
     - 'test/**/*'
     - 'example/helper.rb'
     - 'example/upgrade_server.rb'
-    - 'lib/tasks/generate_huffman_table.rb'
+    - 'tasks/generate_huffman_table.rb'
 
 # Offense count: 1
 # Configuration parameters: MinBodyLength, AllowConsecutiveConditionals.

Rakefile

@@ -5,7 +5,8 @@ require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 require 'yard'
 require 'open3'
-require_relative 'lib/tasks/generate_huffman_table'
+
+require_relative 'tasks/generate_huffman_table'
 
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.exclude_pattern = './spec/hpack_test_spec.rb'

example/client.rb

@@ -44,10 +44,13 @@
 stream = conn.new_stream
 log = Logger.new(stream.id)
 
+conn_mutex = Mutex.new # Synchronize writing to socket
 conn.on(:frame) do |bytes|
-  # puts "Sending bytes: #{bytes.unpack("H*").first}"
-  sock.print bytes
-  sock.flush
+  conn_mutex.synchronize do # Make sure that only one frame is sent at a time
+    # puts "Sending bytes: #{bytes.unpack("H*").first}"
+    sock.print bytes
+    sock.flush
+  end
 end
 conn.on(:frame_sent) do |frame|
   puts "Sent frame: #{frame.inspect}"

example/upgrade_client.rb

@@ -23,9 +23,12 @@ def request_header_hash
   end
 end
 
+conn_mutex = Mutex.new # Synchronize writing to socket
 conn.on(:frame) do |bytes|
-  sock.print bytes
-  sock.flush
+  conn_mutex.synchronize do # Make sure that only one frame is sent at a time
+    sock.print bytes
+    sock.flush
+  end
 end
 conn.on(:frame_sent) do |frame|
   puts "Sent frame: #{frame.inspect}"

lib/http/2/compressor.rb

@@ -333,6 +333,7 @@ def size_check(cmd)
     # Responsible for encoding header key-value pairs using HPACK algorithm.
     class Compressor
       # @param options [Hash] encoding options
+      # @see EncodingContext#initialize
       def initialize(**options)
         @cc = EncodingContext.new(**options)
       end
@@ -467,12 +468,9 @@ def encode(headers)
     # Responsible for decoding received headers and maintaining compression
     # context of the opposing peer. Decompressor must be initialized with
     # appropriate starting context based on local role: client or server.
-    #
-    # @example
-    #   server_role = Decompressor.new(:request)
-    #   client_role = Decompressor.new(:response)
     class Decompressor
       # @param options [Hash] decoding options.  Only :table_size is effective.
+      # @see EncodingContext#initialize
       def initialize(**options)
         @cc = EncodingContext.new(**options)
       end

lib/tasks/generate_huffman_table.rb → tasks/generate_huffman_table.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
+require_relative '../lib/http/2/huffman'
+
+# TODO: Currently, regenerating this table will produce something different from
+# the table shipped with this gem. It is however stable.
 desc 'Generate Huffman precompiled table in huffman_statemachine.rb'
-task :generate_table do
+task :generate_huffman_table do
   HuffmanTable::Node.generate_state_table
 end
 
-require_relative '../http/2/huffman'
-
-# @private
 module HuffmanTable
   BITS_AT_ONCE = HTTP2::Header::Huffman::BITS_AT_ONCE
   EOS          = 256