Class: Mongrel::HttpParser

Inherits:
Object
  • Object
show all
Defined in:
ext/http11/http11.c

Instance Method Summary collapse

Constructor Details

#new ⇒ Object

Creates a new parser.



195
196
197
198
199
200
201
202
 
# File 'ext/http11/http11.c', line 195

VALUE HttpParser_init(VALUE self)
{
  http_parser *http = NULL;
  DATA_GET(self, http_parser, http);
  http_parser_init(http);
  
  return self;
}

Instance Method Details

#error? ⇒ Boolean

Tells you whether the parser is in an error state.

Returns:

  • (Boolean) 


276
277
278
279
280
281
282
 
# File 'ext/http11/http11.c', line 276

VALUE HttpParser_has_error(VALUE self)
{
  http_parser *http = NULL;
  DATA_GET(self, http_parser, http);
  
  return http_parser_has_error(http) ? Qtrue : Qfalse;
}

#execute(req_hash, data) ⇒ Integer

Takes a Hash and a String of data, parses the String of data filling in the Hash returning an Integer to indicate how much of the data has been read. No matter what the return value, you should call HttpParser#finished? and HttpParser#error? to figure out if it’s done parsing or there was an error.

This function now throws an exception when there is a parsing error. This makes the logic for working with the parser much easier. You can still test for an error, but now you need to wrap the parser with an exception handling block.

Returns:

  • (Integer) 


252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'ext/http11/http11.c', line 252

VALUE HttpParser_execute(VALUE self, VALUE req_hash, VALUE data)
{
  http_parser *http = NULL;
  DATA_GET(self, http_parser, http);

  http->data = (void *)req_hash;
  http_parser_execute(http, RSTRING(data)->ptr, RSTRING(data)->len);

  VALIDATE_MAX_LENGTH(http_parser_nread(http), HEADER);

  if(http_parser_has_error(http)) {
    rb_raise(eHttpParserError, "Invalid HTTP format, parsing fails.");
  } else {
    return INT2FIX(http_parser_nread(http));
  }
}

#finish ⇒ Object

Finishes a parser early which could put in a “good” or bad state. You should call reset after finish it or bad things will happen.



229
230
231
232
233
234
235
236
 
# File 'ext/http11/http11.c', line 229

VALUE HttpParser_finish(VALUE self)
{
  http_parser *http = NULL;
  DATA_GET(self, http_parser, http);
  http_parser_finish(http);
  
  return http_parser_is_finished(http) ? Qtrue : Qfalse;
}

#finished? ⇒ Boolean

Tells you whether the parser is finished or not and in a good state.

Returns:

  • (Boolean) 


291
292
293
294
295
296
297
 
# File 'ext/http11/http11.c', line 291

VALUE HttpParser_is_finished(VALUE self)
{
  http_parser *http = NULL;
  DATA_GET(self, http_parser, http);
  
  return http_parser_is_finished(http) ? Qtrue : Qfalse;
}

#nread ⇒ Integer

Returns the amount of data processed so far during this processing cycle. It is set to 0 on initialize or reset calls and is incremented each time execute is called.

Returns:

  • (Integer) 


307
308
309
310
311
312
313
 
# File 'ext/http11/http11.c', line 307

VALUE HttpParser_nread(VALUE self)
{
  http_parser *http = NULL;
  DATA_GET(self, http_parser, http);
  
  return INT2FIX(http->nread);
}

#reset ⇒ nil

Resets the parser to it’s initial state so that you can reuse it rather than making new ones.

Returns:

  • (nil) 


212
213
214
215
216
217
218
219
 
# File 'ext/http11/http11.c', line 212

VALUE HttpParser_reset(VALUE self)
{
  http_parser *http = NULL;
  DATA_GET(self, http_parser, http);
  http_parser_init(http);
  
  return Qnil;
}