Class: Puma::HttpParser
- Inherits:
-
Object
- Object
- Puma::HttpParser
- Defined in:
- ext/puma_http11/puma_http11.c
Instance Method Summary collapse
-
#body ⇒ nil, String
If the request included a body, returns it.
-
#error? ⇒ Boolean
Tells you whether the parser is in an error state.
-
#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.
-
#finish ⇒ Object
Finishes a parser early which could put in a “good” or bad state.
-
#finished? ⇒ Boolean
Tells you whether the parser is finished or not and in a good state.
-
#new ⇒ Object
constructor
Creates a new parser.
-
#nread ⇒ Integer
Returns the amount of data processed so far during this processing cycle.
-
#reset ⇒ nil
Resets the parser to it’s initial state so that you can reuse it rather than making new ones.
Constructor Details
#new ⇒ Object
Creates a new parser.
316 317 318 319 320 321 322 323 |
# File 'ext/puma_http11/puma_http11.c', line 316
VALUE HttpParser_init(VALUE self)
{
puma_parser *http = NULL;
DATA_GET(self, puma_parser, http);
puma_parser_init(http);
return self;
}
|
Instance Method Details
#body ⇒ nil, String
If the request included a body, returns it.
460 461 462 463 464 465 |
# File 'ext/puma_http11/puma_http11.c', line 460
VALUE HttpParser_body(VALUE self) {
puma_parser *http = NULL;
DATA_GET(self, puma_parser, http);
return http->body;
}
|
#error? ⇒ Boolean
Tells you whether the parser is in an error state.
415 416 417 418 419 420 421 |
# File 'ext/puma_http11/puma_http11.c', line 415
VALUE HttpParser_has_error(VALUE self)
{
puma_parser *http = NULL;
DATA_GET(self, puma_parser, http);
return puma_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.
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 |
# File 'ext/puma_http11/puma_http11.c', line 377
VALUE HttpParser_execute(VALUE self, VALUE req_hash, VALUE data, VALUE start)
{
puma_parser *http = NULL;
int from = 0;
char *dptr = NULL;
long dlen = 0;
DATA_GET(self, puma_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;
puma_parser_execute(http, dptr, dlen, from);
rb_free_chars(dptr);
VALIDATE_MAX_LENGTH(puma_parser_nread(http), HEADER);
if(puma_parser_has_error(http)) {
rb_raise(eHttpParserError, "%s", "Invalid HTTP format, parsing fails.");
} else {
return INT2FIX(puma_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.
350 351 352 353 354 355 356 357 |
# File 'ext/puma_http11/puma_http11.c', line 350
VALUE HttpParser_finish(VALUE self)
{
puma_parser *http = NULL;
DATA_GET(self, puma_parser, http);
puma_parser_finish(http);
return puma_parser_is_finished(http) ? Qtrue : Qfalse;
}
|
#finished? ⇒ Boolean
Tells you whether the parser is finished or not and in a good state.
430 431 432 433 434 435 436 |
# File 'ext/puma_http11/puma_http11.c', line 430
VALUE HttpParser_is_finished(VALUE self)
{
puma_parser *http = NULL;
DATA_GET(self, puma_parser, http);
return puma_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.
446 447 448 449 450 451 452 |
# File 'ext/puma_http11/puma_http11.c', line 446
VALUE HttpParser_nread(VALUE self)
{
puma_parser *http = NULL;
DATA_GET(self, puma_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.
333 334 335 336 337 338 339 340 |
# File 'ext/puma_http11/puma_http11.c', line 333
VALUE HttpParser_reset(VALUE self)
{
puma_parser *http = NULL;
DATA_GET(self, puma_parser, http);
puma_parser_init(http);
return Qnil;
}
|