-
-
23 May 2022 15:17:22 UTC
- Distribution: Mojolicious
- Source (raw)
- Browse (raw)
- Changes
- Homepage
- How to Contribute
- Repository
- Issues
- Testers (1070 / 6 / 30)
- Kwalitee
Bus factor: 6- 90.64% Coverage
- License: artistic_2
- Perl: v5.16.0
- Activity
24 month- Tools
- Download (827.39KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
NAME
Mojo::Message::Response - HTTP response
SYNOPSIS
use Mojo::Message::Response; # Parse my $res = Mojo::Message::Response->new; $res->parse("HTTP/1.0 200 OK\x0d\x0a"); $res->parse("Content-Length: 12\x0d\x0a"); $res->parse("Content-Type: text/plain\x0d\x0a\x0d\x0a"); $res->parse('Hello World!'); say $res->code; say $res->headers->content_type; say $res->body; # Build my $res = Mojo::Message::Response->new; $res->code(200); $res->headers->content_type('text/plain'); $res->body('Hello World!'); say $res->to_string;
DESCRIPTION
Mojo::Message::Response is a container for HTTP responses, based on RFC 7230 and RFC 7231.
EVENTS
Mojo::Message::Response inherits all events from Mojo::Message.
ATTRIBUTES
Mojo::Message::Response inherits all attributes from Mojo::Message and implements the following new ones.
code
my $code = $res->code; $res = $res->code(200);
HTTP response status code.
max_message_size
my $size = $res->max_message_size; $res = $res->max_message_size(1024);
Maximum message size in bytes, defaults to the value of the
MOJO_MAX_MESSAGE_SIZE
environment variable or2147483648
(2GiB). Setting the value to0
will allow messages of indefinite size.message
my $msg = $res->message; $res = $res->message('OK');
HTTP response status message.
METHODS
Mojo::Message::Response inherits all methods from Mojo::Message and implements the following new ones.
cookies
my $cookies = $res->cookies; $res = $res->cookies(Mojo::Cookie::Response->new); $res = $res->cookies({name => 'foo', value => 'bar'});
Access response cookies, usually Mojo::Cookie::Response objects.
# Names of all cookies say $_->name for @{$res->cookies};
default_message
my $msg = $res->default_message; my $msg = $res->default_message(418);
Generate default response message for status code, defaults to using "code".
extract_start_line
my $bool = $res->extract_start_line(\$str);
Extract status-line from string.
fix_headers
$res = $res->fix_headers;
Make sure response has all required headers.
get_start_line_chunk
my $bytes = $res->get_start_line_chunk($offset);
Get a chunk of status-line data starting from a specific position. Note that this method finalizes the response.
is_client_error
my $bool = $res->is_client_error;
Check if this response has a
4xx
status "code".is_empty
my $bool = $res->is_empty;
Check if this response has a
1xx
,204
or304
status "code".is_error
my $bool = $res->is_error;
Check if this response has a
4xx
or5xx
status "code".is_info
my $bool = $res->is_info;
Check if this response has a
1xx
status "code".is_redirect
my $bool = $res->is_redirect;
Check if this response has a
3xx
status "code".is_server_error
my $bool = $res->is_server_error;
Check if this response has a
5xx
status "code".is_success
my $bool = $res->is_success;
Check if this response has a
2xx
status "code".start_line_size
my $size = $req->start_line_size;
Size of the status-line in bytes. Note that this method finalizes the response.
SEE ALSO
Module Install Instructions
To install Mojolicious, copy and paste the appropriate command in to your terminal.
cpanm Mojolicious
perl -MCPAN -e shell install Mojolicious
For more information on module installation, please visit the detailed CPAN module installation guide.