Class: EventMachine::HttpClientParser
- Inherits:
-
Object
- Object
- EventMachine::HttpClientParser
- Defined in:
- ext/http11_client/http11_client.c
Instance Method Summary collapse
-
#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.
169 170 171 172 173 174 175 176 |
# File 'ext/http11_client/http11_client.c', line 169
VALUE HttpClientParser_init(VALUE self)
{
httpclient_parser *http = NULL;
DATA_GET(self, httpclient_parser, http);
httpclient_parser_init(http);
return self;
}
|
Instance Method Details
#error? ⇒ Boolean
Tells you whether the parser is in an error state.
269 270 271 272 273 274 275 |
# File 'ext/http11_client/http11_client.c', line 269
VALUE HttpClientParser_has_error(VALUE self)
{
httpclient_parser *http = NULL;
DATA_GET(self, httpclient_parser, http);
return httpclient_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 HttpClientParser#finished? and HttpClientParser#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.
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'ext/http11_client/http11_client.c', line 230
VALUE HttpClientParser_execute(VALUE self, VALUE req_hash, VALUE data, VALUE start)
{
httpclient_parser *http = NULL;
int from = 0;
char *dptr = NULL;
long dlen = 0;
REQUIRE_TYPE(req_hash, T_HASH);
REQUIRE_TYPE(data, T_STRING);
REQUIRE_TYPE(start, T_FIXNUM);
DATA_GET(self, httpclient_parser, http);
from = FIX2INT(start);
dptr = RSTRING_PTR(data);
dlen = RSTRING_LEN(data);
if(from >= dlen) {
rb_raise(eHttpClientParserError, "Requested start is after data buffer end.");
} else {
http->data = (void *)req_hash;
httpclient_parser_execute(http, dptr, dlen, from);
if(httpclient_parser_has_error(http)) {
rb_raise(eHttpClientParserError, "Invalid HTTP format, parsing fails.");
} else {
return INT2FIX(httpclient_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.
203 204 205 206 207 208 209 210 |
# File 'ext/http11_client/http11_client.c', line 203
VALUE HttpClientParser_finish(VALUE self)
{
httpclient_parser *http = NULL;
DATA_GET(self, httpclient_parser, http);
httpclient_parser_finish(http);
return httpclient_parser_is_finished(http) ? Qtrue : Qfalse;
}
|
#finished? ⇒ Boolean
Tells you whether the parser is finished or not and in a good state.
284 285 286 287 288 289 290 |
# File 'ext/http11_client/http11_client.c', line 284
VALUE HttpClientParser_is_finished(VALUE self)
{
httpclient_parser *http = NULL;
DATA_GET(self, httpclient_parser, http);
return httpclient_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.
300 301 302 303 304 305 306 |
# File 'ext/http11_client/http11_client.c', line 300
VALUE HttpClientParser_nread(VALUE self)
{
httpclient_parser *http = NULL;
DATA_GET(self, httpclient_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.
186 187 188 189 190 191 192 193 |
# File 'ext/http11_client/http11_client.c', line 186
VALUE HttpClientParser_reset(VALUE self)
{
httpclient_parser *http = NULL;
DATA_GET(self, httpclient_parser, http);
httpclient_parser_init(http);
return Qnil;
}
|