class Puma::HttpParser
Public Class Methods
Source
VALUE HttpParser_init(VALUE self) { puma_parser *http = NULL; DATA_GET(self, puma_parser, &HttpParser_data_type, http); puma_parser_init(http); return self; }
Creates a new parser.
Public Instance Methods
Source
VALUE HttpParser_body(VALUE self) { puma_parser *http = NULL; DATA_GET(self, puma_parser, &HttpParser_data_type, http); return http->body; }
If the request included a body, returns it.
Source
VALUE HttpParser_has_error(VALUE self) { puma_parser *http = NULL; DATA_GET(self, puma_parser, &HttpParser_data_type, http); return puma_parser_has_error(http) ? Qtrue : Qfalse; }
Tells you whether the parser is in an error state.
Source
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, &HttpParser_data_type, 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. Are you trying to open an SSL connection to a non-SSL Puma?"); } else { return INT2FIX(puma_parser_nread(http)); } } }
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.
Source
VALUE HttpParser_finish(VALUE self) { puma_parser *http = NULL; DATA_GET(self, puma_parser, &HttpParser_data_type, http); puma_parser_finish(http); return puma_parser_is_finished(http) ? Qtrue : Qfalse; }
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.
Source
VALUE HttpParser_is_finished(VALUE self) { puma_parser *http = NULL; DATA_GET(self, puma_parser, &HttpParser_data_type, http); return puma_parser_is_finished(http) ? Qtrue : Qfalse; }
Tells you whether the parser is finished or not and in a good state.
Source
VALUE HttpParser_nread(VALUE self) { puma_parser *http = NULL; DATA_GET(self, puma_parser, &HttpParser_data_type, http); return INT2FIX(http->nread); }
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.
Source
VALUE HttpParser_reset(VALUE self) { puma_parser *http = NULL; DATA_GET(self, puma_parser, &HttpParser_data_type, http); puma_parser_init(http); return Qnil; }
Resets the parser to it’s initial state so that you can reuse it rather than making new ones.