Class: Protocol::HTTP2::Frame
- Inherits:
-
Object
- Object
- Protocol::HTTP2::Frame
show all
- Includes:
- Comparable
- Defined in:
- lib/protocol/http2/frame.rb
Constant Summary
collapse
- VALID_STREAM_ID =
0..0x7fffffff
- VALID_LENGTH =
The absolute maximum bounds for the length field:
0..0xffffff
- LENGTH_HISHIFT =
Used for generating 24-bit frame length:
16
- LENGTH_LOMASK =
0xFFFF
'CnCCN'.freeze
- STREAM_ID_MASK =
0x7fffffff
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
Constructor Details
#initialize(stream_id = 0, flags = 0, type = self.class::TYPE, length = nil, payload = nil) ⇒ Frame
Returns a new instance of Frame.
50
51
52
53
54
55
56
|
# File 'lib/protocol/http2/frame.rb', line 50
def initialize(stream_id = 0, flags = 0, type = self.class::TYPE, length = nil, payload = nil)
@length = length
@type = type
@flags = flags
@stream_id = stream_id
@payload = payload
end
|
Instance Attribute Details
#flags ⇒ Object
Returns the value of attribute flags.
84
85
86
|
# File 'lib/protocol/http2/frame.rb', line 84
def flags
@flags
end
|
#length ⇒ Object
The generic frame header uses the following binary representation:
-----------------------------------------------
| Length (24) | ---------------
—————---------------
| Type (8) | Flags (8) | -
————----------------
——————————-+ |R| Stream Identifier (31) | ==============================================================+ | Frame Payload (0…) … ---------------------------------------------------------------
82
83
84
|
# File 'lib/protocol/http2/frame.rb', line 82
def length
@length
end
|
#payload ⇒ Object
Returns the value of attribute payload.
86
87
88
|
# File 'lib/protocol/http2/frame.rb', line 86
def payload
@payload
end
|
#stream_id ⇒ Object
Returns the value of attribute stream_id.
85
86
87
|
# File 'lib/protocol/http2/frame.rb', line 85
def stream_id
@stream_id
end
|
#type ⇒ Object
Returns the value of attribute type.
83
84
85
|
# File 'lib/protocol/http2/frame.rb', line 83
def type
@type
end
|
Class Method Details
Decodes common 9-byte header.
150
151
152
153
154
155
156
157
158
|
# File 'lib/protocol/http2/frame.rb', line 150
def self.(buffer)
length_hi, length_lo, type, flags, stream_id = buffer.unpack(HEADER_FORMAT)
length = (length_hi << LENGTH_HISHIFT) | length_lo
stream_id = stream_id & STREAM_ID_MASK
return length, type, flags, stream_id
end
|
Instance Method Details
#<=>(other) ⇒ Object
62
63
64
|
# File 'lib/protocol/http2/frame.rb', line 62
def <=> other
to_ary <=> other.to_ary
end
|
#apply(connection) ⇒ Object
200
201
202
|
# File 'lib/protocol/http2/frame.rb', line 200
def apply(connection)
connection.receive_frame(self)
end
|
#clear_flags(mask) ⇒ Object
105
106
107
|
# File 'lib/protocol/http2/frame.rb', line 105
def clear_flags(mask)
@flags &= ~mask
end
|
#connection? ⇒ Boolean
Check if frame is a connection frame: SETTINGS, PING, GOAWAY, and any frame addressed to stream ID = 0.
117
118
119
|
# File 'lib/protocol/http2/frame.rb', line 117
def connection?
@stream_id.zero?
end
|
#flag_set?(mask) ⇒ Boolean
109
110
111
|
# File 'lib/protocol/http2/frame.rb', line 109
def flag_set?(mask)
@flags & mask != 0
end
|
Generates common 9-byte frame header.
#inspect ⇒ Object
204
205
206
|
# File 'lib/protocol/http2/frame.rb', line 204
def inspect
"\#<#{self.class} stream_id=#{@stream_id} flags=#{@flags} #{self.unpack}>"
end
|
#pack(payload, maximum_size: nil) ⇒ Object
92
93
94
95
96
97
98
99
|
# File 'lib/protocol/http2/frame.rb', line 92
def pack(payload, maximum_size: nil)
@payload = payload
@length = payload.bytesize
if maximum_size and @length > maximum_size
raise ProtocolError, "Frame length #{@length} bigger than maximum allowed: #{maximum_size}"
end
end
|
#read(stream, maximum_frame_size = MAXIMUM_ALLOWED_FRAME_SIZE) ⇒ Object
173
174
175
176
177
178
179
180
181
|
# File 'lib/protocol/http2/frame.rb', line 173
def read(stream, maximum_frame_size = MAXIMUM_ALLOWED_FRAME_SIZE)
(stream) unless @length
if @length > maximum_frame_size
raise FrameSizeError, "#{self.class} (type=#{@type}) frame length #{@length} exceeds maximum frame size #{maximum_frame_size}!"
end
read_payload(stream)
end
|
160
161
162
163
164
165
166
167
|
# File 'lib/protocol/http2/frame.rb', line 160
def (stream)
if buffer = stream.read(9)
@length, @type, @flags, @stream_id = Frame.(buffer)
else
raise EOFError, "Could not read frame header!"
end
end
|
#read_payload(stream) ⇒ Object
169
170
171
|
# File 'lib/protocol/http2/frame.rb', line 169
def read_payload(stream)
@payload = stream.read(@length)
end
|
#set_flags(mask) ⇒ Object
101
102
103
|
# File 'lib/protocol/http2/frame.rb', line 101
def set_flags(mask)
@flags |= mask
end
|
#to_ary ⇒ Object
66
67
68
|
# File 'lib/protocol/http2/frame.rb', line 66
def to_ary
[@length, @type, @flags, @stream_id, @payload]
end
|
#unpack ⇒ Object
88
89
90
|
# File 'lib/protocol/http2/frame.rb', line 88
def unpack
@payload
end
|
#valid_type? ⇒ Boolean
58
59
60
|
# File 'lib/protocol/http2/frame.rb', line 58
def valid_type?
@type == self.class::TYPE
end
|
#write(stream) ⇒ Object
191
192
193
194
195
196
197
198
|
# File 'lib/protocol/http2/frame.rb', line 191
def write(stream)
if @payload and @length != @payload.bytesize
raise ProtocolError, "Invalid payload size: #{@length} != #{@payload.bytesize}"
end
self.(stream)
self.write_payload(stream)
end
|
183
184
185
|
# File 'lib/protocol/http2/frame.rb', line 183
def (stream)
stream.write self.
end
|
#write_payload(stream) ⇒ Object
187
188
189
|
# File 'lib/protocol/http2/frame.rb', line 187
def write_payload(stream)
stream.write(@payload) if @payload
end
|