NAME
Mojo::Message - HTTP 1.1 message base class
SYNOPSIS
use Mojo::Base 'Mojo::Message';DESCRIPTION
Mojo::Message is an abstract base class for HTTP 1.1 messages as described in RFC 2616 and RFC 2388.
EVENTS
Mojo::Message can emit the following events.
finish
$message->on(finish => sub {
my $message = shift;
});Emitted after message building or parsing is finished.
my $before = time;
$message->on(finish => sub {
my $message = shift;
$message->headers->header('X-Parser-Time' => time - $before);
});progress
$message->on(progress => sub {
my $message = shift;
});Emitted when message building or parsing makes progress.
$message->on(progress => sub {
my $message = shift;
return unless my $len = $message->headers->content_length;
my $size = $message->content->progress;
say 'Progress: ', $size == $len ? 100 : int($size / ($len / 100)), '%';
});ATTRIBUTES
Mojo::Message implements the following attributes.
content
my $message = $message->content;
$message = $message->content(Mojo::Content::Single->new);Content container, defaults to a Mojo::Content::Single object.
default_charset
my $charset = $message->default_charset;
$message = $message->default_charset('UTF-8');Default charset used for form data parsing, defaults to UTF-8.
dom_class
my $class = $message->dom_class;
$message = $message->dom_class('Mojo::DOM');Class to be used for DOM manipulation with the dom method, defaults to Mojo::DOM.
json_class
my $class = $message->json_class;
$message = $message->json_class('Mojo::JSON');Class to be used for JSON deserialization with the json method, defaults to Mojo::JSON.
max_message_size
my $size = $message->max_message_size;
$message = $message->max_message_size(1024);Maximum message size in bytes, defaults to the value of MOJO_MAX_MESSAGE_SIZE or 5242880.
METHODS
Mojo::Message inherits all methods from Mojo::EventEmitter and implements the following new ones.
at_least_version
my $success = $message->at_least_version('1.1');Check if message is at least a specific version.
body
my $string = $message->body;
$message = $message->body('Hello!');
my $cb = $message->body(sub {...});Access and replace text content or register read event with content, which will be emitted when new data arrives.
$message->body(sub {
my ($message, $chunk) = @_;
say "Streaming: $chunk";
});body_params
my $params = $message->body_params;POST parameters, usually a Mojo::Parameters object.
body_size
my $size = $message->body_size;Size of the body in bytes.
build_body
my $string = $message->build_body;Render whole body.
build_headers
my $string = $message->build_headers;Render all headers.
build_start_line
my $string = $message->build_start_line;Render start line.
cookie
my $cookie = $message->cookie('foo');
my @cookies = $message->cookie('foo');Access message cookies, usually Mojo::Cookie::Request or Mojo::Cookie::Response objects.
dom
my $dom = $message->dom;
my $collection = $message->dom('a[href]');Turns content into a Mojo::DOM object and takes an optional selector to perform a find on it right away, which returns a collection.
error
my $message = $message->error;
my ($message, $code) = $message->error;
$message = $message->error('Parser error.');
$message = $message->error('Parser error.', 500);Parser errors and codes.
fix_headers
$message = $message->fix_headers;Make sure message has all required headers for the current HTTP version.
get_body_chunk
my $string = $message->get_body_chunk($offset);Get a chunk of body data starting from a specific position.
get_header_chunk
my $string = $message->get_header_chunk($offset);Get a chunk of header data, starting from a specific position.
get_start_line_chunk
my $string = $message->get_start_line_chunk($offset);Get a chunk of start line data starting from a specific position.
has_leftovers
my $success = $message->has_leftovers;Check if message parser has leftover data.
header_size
my $size = $message->header_size;Size of headers in bytes.
headers
my $headers = $message->headers;
$message = $message->headers(Mojo::Headers->new);Message headers, defaults to a Mojo::Headers object.
is_chunked
my $success = $message->is_chunked;Check if message content is chunked.
is_dynamic
my $success = $message->is_dynamic;Check if message content will be dynamic. Note that this method is EXPERIMENTAL and might change without warning!
is_finished
my $success = $message->is_finished;Check if parser is finished.
is_limit_exceeded
my $success = $message->is_limit_exceeded;Check if message has exceeded max_line_size or max_message_size. Note that this method is EXPERIMENTAL and might change without warning!
is_multipart
my $success = $message->is_multipart;Check if message content is a Mojo::Content::MultiPart object.
json
my $object = $message->json;
my $array = $message->json;Decode JSON message body directly using Mojo::JSON if possible, returns undef otherwise.
leftovers
my $bytes = $message->leftovers;Remove leftover data from message parser.
max_line_size
$message->max_line_size(1024);Alias for "max_line_size" in Mojo::Headers. Note that this method is EXPERIMENTAL and might change without warning!
param
my $param = $message->param('foo');
my @params = $message->param('foo');Access GET and POST parameters.
parse
$message = $message->parse('HTTP/1.1 200 OK...');Parse message chunk.
parse_until_body
$message = $message->parse_until_body('HTTP/1.1 200 OK...');Parse message chunk until the body is reached.
start_line_size
my $size = $message->start_line_size;Size of the start line in bytes.
to_string
my $string = $message->to_string;Render whole message.
upload
my $upload = $message->upload('foo');
my @uploads = $message->upload('foo');Access multipart/form-data file uploads, usually Mojo::Upload objects.
uploads
my $uploads = $message->uploads;All multipart/form-data file uploads, usually Mojo::Upload objects.
version
my $version = $message->version;
$message = $message->version('1.1');HTTP version of message.
write
$message->write('Hello!');
$message->write('Hello!', sub {...});Write dynamic content non-blocking, the optional drain callback will be invoked once all data has been written.
write_chunk
$message->write_chunk('Hello!');
$message->write_chunk('Hello!', sub {...});Write dynamic content non-blocking with the chunked transfer encoding, the optional drain callback will be invoked once all data has been written.