Class: Biryani::State

Inherits:
Object
  • Object
show all
Defined in:
lib/biryani/state.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ State

Returns a new instance of State.



3
4
5
 
# File 'lib/biryani/state.rb', line 3

def initialize
  @state = :idle
end

Class Method Details

.next(state, frame, direction) ⇒ Symbol, ConnectionError

--------

          send PP |        | recv PP
         ,--------+  idle  +--------.
        /         |        |         \
       v          +--------+          v
+----------+          |           +----------+
|          |          | send H /  |          |

,——+ reserved | | recv H | reserved ——. | | (local) | | | (remote) | | | ---—— v ------—+ | | | -------- | | | | recv ES | | send ES | | | send H | ,——-+ open ——-. | recv H | | | / | | \ | | | v v ---—- v v | | ---------- | ---------- | | | half- | | | half- | | | | closed | | send R / | closed | | | | (remote) | | recv R | (local) | | | ----—–+ | -----—-+ | | | | | | | | send ES / | recv ES / | | | | send R / v send R / | | | | recv R -------- recv R | | | send R / ‘———–>| |<———–’ send R / | | recv R | closed | recv R | ‘———————–>| |<———————–’

+--------+

datatracker.ietf.org/doc/html/rfc9113#section-5.1

rubocop: disable Metrics/AbcSize rubocop: disable Metrics/CyclomaticComplexity rubocop: disable Metrics/MethodLength rubocop: disable Metrics/PerceivedComplexity

Parameters:

  • state (Symbol)
  • frame (Object)
  • direction (:send, :recv)

Returns:

Raises:

  • (StandardError) 


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/biryani/state.rb', line 57

def self.next(state, frame, direction)
  typ = frame.f_type
  case [state, direction, typ]
  # idle
  in [:idle, :send, FrameType::PUSH_PROMISE]
    :reserved_local
  in [:idle, :recv, FrameType::HEADERS] if frame.end_stream? && frame.end_headers?
    :half_closed_remote
  in [:idle, :recv, FrameType::HEADERS] if frame.end_headers?
    :receiving_data
  in [:idle, :recv, FrameType::HEADERS] if frame.end_stream?
    :receiving_continuation
  in [:idle, :recv, FrameType::HEADERS]
    :receiving_continuation_and_data
  in [:idle, :recv, FrameType::PRIORITY]
    state

  # receiving_continuation_and_data
  in [:receiving_continuation_and_data, :recv, FrameType::WINDOW_UPDATE]
    state
  in [:receiving_continuation_and_data, :recv, FrameType::CONTINUATION] if frame.end_headers?
    :receiving_data
  in [:receiving_continuation_and_data, :recv, FrameType::CONTINUATION]
    state
  in [:receiving_continuation_and_data, _, FrameType::RST_STREAM]
    :closed

  # receiving_continuation
  in [:receiving_continuation, :recv, FrameType::DATA] if frame.end_stream?
    :half_closed_remote
  in [:receiving_continuation, :recv, FrameType::DATA]
    :receiving_data
  in [:receiving_continuation, :recv, FrameType::WINDOW_UPDATE]
    state
  in [:receiving_continuation, :recv, FrameType::CONTINUATION] if frame.end_headers?
    :half_closed_remote
  in [:receiving_continuation, :recv, FrameType::CONTINUATION]
    state
  in [:receiving_continuation, _, FrameType::RST_STREAM]
    :closed

  # receiving_data
  in [:receiving_data, :recv, FrameType::DATA] if frame.end_stream?
    :half_closed_remote
  in [:receiving_data, :recv, FrameType::DATA]
    state
  in [:receiving_data, :recv, FrameType::HEADERS] if !frame.end_stream?
    unexpected(ErrorCode::PROTOCOL_ERROR, state, typ, direction)
  in [:receiving_data, :recv, FrameType::HEADERS] if frame.end_headers?
    :half_closed_remote
  in [:receiving_data, :recv, FrameType::HEADERS]
    :receiving_trailer_continuation
  in [:receiving_data, :recv, FrameType::PRIORITY]
    state
  in [:receiving_data, _, FrameType::RST_STREAM]
    :closed
  in [:receiving_data, _, FrameType::WINDOW_UPDATE]
    state

  # receiving_trailer_headers
  in [:receiving_trailer_headers, :recv, FrameType::HEADERS] if !frame.end_stream?
    unexpected(ErrorCode::PROTOCOL_ERROR, state, typ, direction)
  in [:receiving_trailer_headers, :recv, FrameType::HEADERS] if frame.end_headers?
    :half_closed_remote
  in [:receiving_trailer_headers, :recv, FrameType::HEADERS]
    :receiving_trailer_continuation
  in [:receiving_trailer_headers, :recv, FrameType::WINDOW_UPDATE]
    state

  # receiving_trailer_continuation
  in [:receiving_trailer_continuation, :recv, FrameType::WINDOW_UPDATE]
    state
  in [:receiving_trailer_continuation, :recv, FrameType::CONTINUATION] if frame.end_headers?
    :half_closed_remote
  in [:receiving_trailer_continuation, :recv, FrameType::CONTINUATION]
    :receiving_trailer_continuation
  in [:receiving_trailer_continuation, _, FrameType::RST_STREAM]
    :closed

  # reserved_remote
  in [:reserved_remote, _, _]
    # TODO
    state

  # reserved_local
  in [:reserved_local, _, _]
    # TODO
    state

  # half_closed_remote
  in [:half_closed_remote, :send, FrameType::HEADERS] if frame.end_stream? && frame.end_headers?
    :closed
  in [:half_closed_remote, :send, FrameType::HEADERS] if frame.end_headers?
    :sending_data
  in [:half_closed_remote, :send, FrameType::HEADERS] if frame.end_stream?
    :sending_continuation
  in [:half_closed_remote, :send, FrameType::HEADERS]
    :sending_continuation_and_data
  in [:half_closed_remote, :recv, FrameType::PRIORITY]
    state
  in [:half_closed_remote, _, FrameType::RST_STREAM]
    :closed
  in [:half_closed_remote, _, FrameType::WINDOW_UPDATE]
    state

  # sending_continuation_and_data
  in [:sending_continuation_and_data, :send, FrameType::CONTINUATION] if frame.end_headers?
    :sending_data
  in [:sending_continuation_and_data, :send, FrameType::CONTINUATION]
    state
  in [:sending_continuation_and_data, :send, _]
    unreachable(state, typ, direction)
  in [:sending_continuation_and_data, :recv, FrameType::PRIORITY]
    state
  in [:sending_continuation_and_data, :recv, FrameType::WINDOW_UPDATE]
    state
  in [:sending_continuation_and_data, _, FrameType::RST_STREAM]
    :closed

  # sending_continuation
  in [:sending_continuation, :send, FrameType::CONTINUATION] if frame.end_headers?
    :closed
  in [:sending_continuation, :send, FrameType::CONTINUATION]
    state
  in [:sending_continuation, :send, _]
    unreachable(state, typ, direction)
  in [:sending_continuation, :recv, FrameType::PRIORITY]
    state
  in [:sending_continuation, :recv, FrameType::WINDOW_UPDATE]
    state
  in [:sending_continuation, _, FrameType::RST_STREAM]
    :closed

  # sending_data
  in [:sending_data, :send, FrameType::DATA] if frame.end_stream?
    :closed
  in [:sending_data, :send, FrameType::DATA]
    state
  in [:sending_data, :send, _]
    unreachable(state, typ, direction)
  in [:sending_data, :recv, FrameType::PRIORITY]
    state
  in [:sending_data, :recv, FrameType::WINDOW_UPDATE]
    state
  in [:sending_data, _, FrameType::RST_STREAM]
    :closed

  # closed
  in [:closed, :send, _]
    unreachable(state, typ, direction)
  in [:closed, :recv, FrameType::PRIORITY]
    state
  in [:closed, _, FrameType::RST_STREAM]
    state

  # other
  in [_, :send, _]
    unreachable(state, typ, direction)
  in [_, :recv, _]
    unexpected(ErrorCode::STREAM_CLOSED, state, typ, direction)
  end
end

.unexpected(error_code, state, typ, direction) ⇒ Object

rubocop: enable Metrics/AbcSize rubocop: enable Metrics/CyclomaticComplexity rubocop: enable Metrics/MethodLength rubocop: enable Metrics/PerceivedComplexity



224
225
226
 
# File 'lib/biryani/state.rb', line 224

def self.unexpected(error_code, state, typ, direction)
  ConnectionError.new(error_code, "#{direction} unexpected #{format('0x%02x', typ)} frame in #{state}")
end

.unreachable(state, typ, direction) ⇒ Object 



228
229
230
 
# File 'lib/biryani/state.rb', line 228

def self.unreachable(state, typ, direction)
  raise "#{direction} unexpected #{format('0x%02x', typ)} frame in #{state}"
end

Instance Method Details

#active? ⇒ Boolean

Returns:

  • (Boolean) 


247
248
249
 
# File 'lib/biryani/state.rb', line 247

def active?
  !%i[idle reserved_local reserved_remote closed].include?(@state)
end

#close ⇒ Object 



232
233
234
 
# File 'lib/biryani/state.rb', line 232

def close
  @state = :closed
end

#closed? ⇒ Boolean

Returns:

  • (Boolean) 


237
238
239
 
# File 'lib/biryani/state.rb', line 237

def closed?
  @state == :closed
end

#half_closed_remote? ⇒ Boolean

Returns:

  • (Boolean) 


252
253
254
 
# File 'lib/biryani/state.rb', line 252

def half_closed_remote?
  @state == :half_closed_remote
end

#idle? ⇒ Boolean

Returns:

  • (Boolean) 


242
243
244
 
# File 'lib/biryani/state.rb', line 242

def idle?
  @state == :idle
end

#receiving_continuation? ⇒ Boolean

Returns:

  • (Boolean) 


257
258
259
 
# File 'lib/biryani/state.rb', line 257

def receiving_continuation?
  %i[receiving_continuation receiving_continuation_and_data receiving_trailer_continuation].include?(@state)
end

#transition!(frame, direction) ⇒ Object

Parameters:

  • frame (Object)
  • direction (:send, :recv) 


9
10
11
12
13
14
 
# File 'lib/biryani/state.rb', line 9

def transition!(frame, direction)
  obj = self.class.next(@state, frame, direction)
  return obj if Biryani.err?(obj)

  @state = obj
end