Class: Puma::HttpParser

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

Instance Method Summary collapse

Constructor Details

#new ⇒ Object

Creates a new parser.



308
309
310
311
312
313
314
315
 
# File 'ext/puma_http11/puma_http11.c', line 308

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

  return self;
}

Instance Method Details

#body ⇒ nil, String

If the request included a body, returns it.

Returns:



452
453
454
455
456
457
 
# File 'ext/puma_http11/puma_http11.c', line 452

VALUE HttpParser_body(VALUE self) {
  http_parser *http = NULL;
  DATA_GET(self, http_parser, http);

  return http->body;
}

#error? ⇒ Boolean

Tells you whether the parser is in an error state.

Returns:

  • (Boolean) 


407
408
409
410
411
412
413
 
# File 'ext/puma_http11/puma_http11.c', line 407

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, start) ⇒ 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.

The third argument allows for parsing a partial request and then continuing the parsing from that position. It needs all of the original data as well so you have to append to the data buffer as you read.

Returns:

  • (Integer) 


369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'ext/puma_http11/puma_http11.c', line 369

VALUE HttpParser_execute(VALUE self, VALUE req_hash, VALUE data, VALUE start)
{
  http_parser *http = NULL;
  int from = 0;
  char *dptr = NULL;
  long dlen = 0;

  DATA_GET(self, http_parser, http);

  from = FIX2INT(start);
  dptr = rb_extract_chars(data, &dlen);

  if(from >= dlen) {
    rb_free_chars(dptr);
    rb_raise(eHttpParserError, "%s", "Requested start is after data buffer end.");
  } else {
    http->request = req_hash;
    http_parser_execute(http, dptr, dlen, from);

    rb_free_chars(dptr);
    VALIDATE_MAX_LENGTH(http_parser_nread(http), HEADER);

    if(http_parser_has_error(http)) {
      rb_raise(eHttpParserError, "%s", "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.



342
343
344
345
346
347
348
349
 
# File 'ext/puma_http11/puma_http11.c', line 342

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) 


422
423
424
425
426
427
428
 
# File 'ext/puma_http11/puma_http11.c', line 422

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) 


438
439
440
441
442
443
444
 
# File 'ext/puma_http11/puma_http11.c', line 438

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) 


325
326
327
328
329
330
331
332
 
# File 'ext/puma_http11/puma_http11.c', line 325

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

  return Qnil;
}