Merge pull request #189 from igrigorik/frame-buffer-clear

FrameBuffer#clear

Author: HoneyryderChuck

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.1.3
+
+HTTP2::FrameBuffer#clear: clears the buffered data chunks
+
+this API is useful for clients which want to react to a peer GOAWAY frame by cleaning the buffer before closing the stream
+
 ## 1.1.2
 
 * allow sending and receiving multiple GOAWAY frames, as per RFC 9113, section 6.8

example/server.rb

@@ -24,8 +24,8 @@
 
 if options[:secure]
   ctx = OpenSSL::SSL::SSLContext.new
-  ctx.cert = OpenSSL::X509::Certificate.new(File.open("keys/server.crt"))
-  ctx.key = OpenSSL::PKey::RSA.new(File.open("keys/server.key"))
+  ctx.cert = OpenSSL::X509::Certificate.new(File.read("keys/server.crt"))
+  ctx.key = OpenSSL::PKey::RSA.new(File.read("keys/server.key"))
 
   ctx.ssl_version = :TLSv1_2
   ctx.options = OpenSSL::SSL::SSLContext::DEFAULT_PARAMS[:options]

example/upgrade_server.rb

@@ -21,8 +21,8 @@
 
 if options[:secure]
   ctx = OpenSSL::SSL::SSLContext.new
-  ctx.cert = OpenSSL::X509::Certificate.new(File.open("keys/server.crt"))
-  ctx.key = OpenSSL::PKey::RSA.new(File.open("keys/server.key"))
+  ctx.cert = OpenSSL::X509::Certificate.new(File.read("keys/server.crt"))
+  ctx.key = OpenSSL::PKey::RSA.new(File.read("keys/server.key"))
   ctx.npn_protocols = [DRAFT]
 
   server = OpenSSL::SSL::SSLServer.new(server, ctx)

lib/http/2/flow_buffer.rb

@@ -127,6 +127,11 @@ def <<(frame)
       @bytesize += frame[:payload].bytesize
     end
 
+    def clear
+      @buffer.clear
+      @bytesize = 0
+    end
+
     def empty?
       @buffer.empty?
     end

lib/http/2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTTP2
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

sig/frame_buffer.rbs

@@ -4,6 +4,8 @@ module HTTP2
 
     @buffer: Array[data_frame]
 
+    def clear: () -> void
+
     def <<: (data_frame frame) -> void
 
     def empty?: () -> bool