Class: Agoo::Request

Inherits:
Object
  • Object
show all
Defined in:
ext/agoo/request.c,
ext/agoo/request.c,
ext/agoo/request.c

Overview

A representation of an HTTP request that is used with a handler that responds to the on_request method. The request is a more efficient encapsulation of the rack environment.

Instance Method Summary collapse

Instance Method Details

#body ⇒ Object

call-seq: body()

Returns the body of the request as a String. If there is no body then nil is returned.



493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'ext/agoo/request.c', line 493

static VALUE
body(VALUE self) {
    agooReq	r = DATA_PTR(self);

    if (NULL == r) {
	rb_raise(rb_eArgError, "Request is no longer valid.");
    }
    if (NULL == r->body.start) {
	return Qnil;
    }
    return rb_str_new(r->body.start, r->body.len);
}

#call ⇒ Object

call-seq: call()

Returns an IO like object and hijacks the connection.



608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
 
# File 'ext/agoo/request.c', line 608

static VALUE
call(VALUE self) {
    agooReq		r = DATA_PTR(self);
    VALUE		args[1];
    volatile VALUE	io;

    if (NULL == r) {
	rb_raise(rb_eArgError, "Request is no longer valid.");
    }
    r->res->con->hijacked = true;

    // TBD try basic IO first. If that fails define a socket class
    // is a mode needed?

    args[0] = INT2NUM(r->res->con->sock);

    io = rb_class_new_instance(1, args, rb_cIO);
    rb_hash_aset((VALUE)r->env, rack_hijack_io_val, io);

    return io;
}

#env ⇒ Object

call-seq: to_h()

Returns a Hash representation of the request which is the same as a rack environment Hash.



579
580
581
582
583
584
585
586
587
 
# File 'ext/agoo/request.c', line 579

static VALUE
to_h(VALUE self) {
    agooReq	r = DATA_PTR(self);

    if (NULL == r) {
	rb_raise(rb_eArgError, "Request is no longer valid.");
    }
    return request_env(r, self);
}

#environment ⇒ Object

call-seq: to_h()

Returns a Hash representation of the request which is the same as a rack environment Hash.



579
580
581
582
583
584
585
586
587
 
# File 'ext/agoo/request.c', line 579

static VALUE
to_h(VALUE self) {
    agooReq	r = DATA_PTR(self);

    if (NULL == r) {
	rb_raise(rb_eArgError, "Request is no longer valid.");
    }
    return request_env(r, self);
}

#headers ⇒ Object

call-seq: headers()

Returns the header of the request as a Hash.



472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'ext/agoo/request.c', line 472

static VALUE
headers(VALUE self) {
    agooReq		r = DATA_PTR(self);
    volatile VALUE	h;

    if (NULL == r) {
	rb_raise(rb_eArgError, "Request is no longer valid.");
    }
    h = rb_hash_new();
    fill_headers(r, h);

    return h;
}

#path_info ⇒ Object

call-seq: path_info()

Returns the script name which is assumed to be either ‘/’ or the empty according to the rack restrictions are followed on what the script name and path info should be.



144
145
146
147
 
# File 'ext/agoo/request.c', line 144

static VALUE
path_info(VALUE self) {
    return req_path_info((agooReq)DATA_PTR(self));
}

#query_string ⇒ Object

call-seq: query_string()

Returns the query string of the request.



166
167
168
169
 
# File 'ext/agoo/request.c', line 166

static VALUE
query_string(VALUE self) {
    return req_query_string((agooReq)DATA_PTR(self));
}

#rack_errors ⇒ Object

call-seq: rack_errors()

Returns an error stream for the request. This stream is used to write error log entries.



313
314
315
316
 
# File 'ext/agoo/request.c', line 313

static VALUE
rack_errors(VALUE self) {
    return req_rack_errors((agooReq)DATA_PTR(self));
}

#rack_input ⇒ Object

call-seq: rack_input()

Returns an input stream for the request body. If no body is present then nil is returned.



296
297
298
299
 
# File 'ext/agoo/request.c', line 296

static VALUE
rack_input(VALUE self) {
    return req_rack_input((agooReq)DATA_PTR(self));
}

#rack_logger ⇒ Object

call-seq: rack_logger()

Returns a RackLogger that can be used to log messages with the server logger. The methods supported are debug(), info(), warn(), error(), and fatal(). The signature is the same as the standard Ruby Logger of info(message, &block).



520
521
522
523
 
# File 'ext/agoo/request.c', line 520

static VALUE
rack_logger(VALUE self) {
    return req_rack_logger((agooReq)DATA_PTR(self));
}

#rack_multiprocess ⇒ Object

call-seq: rack_multiprocess()

Returns false since the server is a single process.



346
347
348
349
 
# File 'ext/agoo/request.c', line 346

static VALUE
rack_multiprocess(VALUE self) {
    return Qfalse;
}

#rack_multithread ⇒ Object

call-seq: rack_multithread()

Returns true is the server is using multiple handler worker threads.



335
336
337
338
 
# File 'ext/agoo/request.c', line 335

static VALUE
rack_multithread(VALUE self) {
    return req_rack_multithread((agooReq)DATA_PTR(self));
}

#rack_run_once ⇒ Object

call-seq: rack_run_once()

Returns false.



357
358
359
360
 
# File 'ext/agoo/request.c', line 357

static VALUE
rack_run_once(VALUE self) {
    return Qfalse;
}

#rack_upgrade? ⇒ Boolean

call-seq: rack_upgrade?()

Returns the URL scheme or either http or https as a string.

Returns:

  • (Boolean) 


245
246
247
248
 
# File 'ext/agoo/request.c', line 245

static VALUE
rack_upgrade(VALUE self) {
    return req_rack_upgrade((agooReq)DATA_PTR(self));
}

#rack_url_scheme ⇒ Object

call-seq: rack_url_scheme()

Returns the URL scheme or either http or https as a string.



273
274
275
276
 
# File 'ext/agoo/request.c', line 273

static VALUE
rack_url_scheme(VALUE self) {
    return req_rack_url_scheme((agooReq)DATA_PTR(self));
}

#rack_version ⇒ Object

call-seq: rack_version()

Returns the rack version the request is compliant with.



256
257
258
259
 
# File 'ext/agoo/request.c', line 256

static VALUE
rack_version(VALUE self) {
    return rack_version_val_val;
}

#request_method ⇒ Object

call-seq: request_method()

Returns the HTTP method of the request.



91
92
93
94
 
# File 'ext/agoo/request.c', line 91

static VALUE
method(VALUE self) {
    return req_method((agooReq)DATA_PTR(self));
}

#script_name ⇒ Object

call-seq: script_name()

Returns the path info which is assumed to be the full path unless the root and then the rack restrictions are followed on what the script name and path info should be.



116
117
118
119
 
# File 'ext/agoo/request.c', line 116

static VALUE
script_name(VALUE self) {
    return req_script_name((agooReq)DATA_PTR(self));
}

#server_name ⇒ Object

call-seq: server_name()

Returns the server or host name.



191
192
193
194
 
# File 'ext/agoo/request.c', line 191

static VALUE
server_name(VALUE self) {
    return req_server_name((agooReq)DATA_PTR(self));
}

#server_port ⇒ Object

call-seq: server_port()

Returns the server or host port as a string.



225
226
227
228
 
# File 'ext/agoo/request.c', line 225

static VALUE
server_port(VALUE self) {
    return req_server_port((agooReq)DATA_PTR(self));
}

#to_h ⇒ Object

call-seq: to_h()

Returns a Hash representation of the request which is the same as a rack environment Hash.



579
580
581
582
583
584
585
586
587
 
# File 'ext/agoo/request.c', line 579

static VALUE
to_h(VALUE self) {
    agooReq	r = DATA_PTR(self);

    if (NULL == r) {
	rb_raise(rb_eArgError, "Request is no longer valid.");
    }
    return request_env(r, self);
}

#to_s ⇒ Object

call-seq: to_s()

Returns a string representation of the request.



595
596
597
598
599
600
 
# File 'ext/agoo/request.c', line 595

static VALUE
to_s(VALUE self) {
    volatile VALUE	h = to_h(self);

    return rb_funcall(h, rb_intern("to_s"), 0);
}