File: priority_update_frame.rb

package info (click to toggle)
ruby-protocol-http2 0.23.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 472 kB
  • sloc: ruby: 3,627; makefile: 4
file content (49 lines) | stat: -rw-r--r-- 1,908 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
# frozen_string_literal: true

# Released under the MIT License.
# Copyright, 2024-2025, by Samuel Williams.

require_relative "frame"
require_relative "padded"
require_relative "continuation_frame"

module Protocol
	module HTTP2
		# The PRIORITY_UPDATE frame is used by clients to signal the initial priority of a response, or to reprioritize a response or push stream. It carries the stream ID of the response and the priority in ASCII text, using the same representation as the Priority header field value.
		# 
		# +-+-------------+-----------------------------------------------+
		# |R|                 Prioritized Stream ID (31)                  |
		# +-+-----------------------------+-------------------------------+
		# |                    Priority Field Value (*)                 ...
		# +---------------------------------------------------------------+
		#
		class PriorityUpdateFrame < Frame
			TYPE = 0x10
			FORMAT = "N".freeze
			
			# Unpack the prioritized stream ID and priority field value.
			# @returns [Array] An array containing the prioritized stream ID and priority field value.
			def unpack
				data = super
				
				prioritized_stream_id = data.unpack1(FORMAT)
				
				return prioritized_stream_id, data.byteslice(4, data.bytesize - 4)
			end
			
			# Pack the prioritized stream ID and priority field value into the frame.
			# @parameter prioritized_stream_id [Integer] The stream ID to prioritize.
			# @parameter data [String] The priority field value.
			# @parameter options [Hash] Options for packing.
			def pack(prioritized_stream_id, data, **options)
				super([prioritized_stream_id].pack(FORMAT) + data, **options)
			end
			
			# Apply this PRIORITY_UPDATE frame to a connection for processing.
			# @parameter connection [Connection] The connection to apply the frame to.
			def apply(connection)
				connection.receive_priority_update(self)
			end
		end
	end
end