NAME

Mojo::Message - Message Base Class

SYNOPSIS

    use base 'Mojo::Message';

DESCRIPTION

Mojo::Message is a base class for HTTP messages.

ATTRIBUTES

Mojo::Message inherits all attributes from Mojo::Stateful and implements the following new ones.

body_cb

    my $cb = $message->body_cb;

    $counter = 1;
    $message = $message->body_cb(sub {
        my $self  = shift;
        my $chunk = '';
        $chunk    = "hello world!" if $counter == 1;
        $chunk    = "hello world2!\n\n" if $counter == 2;
        $counter++;
        return $chunk;
    });

body_length

    my $body_length = $message->body_length;

buffer

    my $buffer = $message->buffer;
    $message   = $message->buffer(Mojo::Buffer->new);

builder_progress_cb

    my $cb   = $message->builder_progress_cb;
    $message = $message->builder_progress_cb(sub {
        my $self = shift;
        print '+';
    });

content

    my $content = $message->content;
    $message    = $message->content(Mojo::Content->new);

header_length

    my $header_length = $message->header_length;

headers

    my $headers = $message->headers;
    $message    = $message->headers(Mojo::Headers->new);

major_version

    my $major_version = $message->major_version;
    $message          = $message->major_version(1);

Returns the major version of the HTTP specification being followed. Defaults to 1.

minor_version

    my $minor_version = $message->minor_version;
    $message          = $message->minor_version(1);

Returns the minor version of the HTTP specification being followed. Defaults to 1.

parser_progress_cb

    my $cb   = $message->parser_progress_cb;
    $message = $message->parser_progress_cb(sub {
        my $self = shift;
        print '+';
    });

raw_body_length

    my $raw_body_length = $message->raw_body_length;

start_line_length

    my $start_line_length = $message->start_line_length;

version

    my $version = $message->version;
    $message    = $message->version('1.1');

METHODS

Mojo::Message inherits all methods from Mojo::Stateful and implements the following new ones.

body

    my $string = $message->body;
    $message   = $message->body('Hello!');

    $counter = 1;
    $message = $message->body(sub {
        my $self  = shift;
        my $chunk = '';
        $chunk    = "hello world!" if $counter == 1;
        $chunk    = "hello world2!\n\n" if $counter == 2;
        $counter++;
        return $chunk;
    });

body_params

    my $params = $message->body_params;

Returns a Mojo::Parameters object, containing POST parameters.

to_string

build

    my $string = $message->build;

Returns the complete HTTP message.

build_body

    my $string = $message->build_body;

Returns the HTTP message body.

build_headers

    my $string = $message->build_headers;

Returns the HTTP message headers.

build_start_line

    my $string = $message->build_start_line;

Returns the HTTP start line.

cookie

    my $cookie  = $message->cookie('foo');
    my @cookies = $message->cookie('foo');

fix_headers

    $message = $message->fix_headers;

Returns the invocant and makes sure all required headers for the currently followed HTTP version are set.

get_body_chunk

    my $string = $message->get_body_chunk($offset);

get_header_chunk

    my $string = $message->get_header_chunk($offset);

get_start_line_chunk

    my $string = $message->get_start_line_chunk($offset);

is_chunked

    my $is_chunked = $message->is_chunked;

is_multipart

    my $is_multipart = $message->is_multipart;

at_least_version

    my $success = $message->at_least_version('1.1');

Returns true if the HTTP version is greater than or equal to the version passed in.

param

    my $param  = $message->param('foo');
    my @params = $message->param('foo');

parse

    $message = $message->parse('HTTP/1.1 200 OK...');

upload

    my $upload  = $message->upload('foo');
    my @uploads = $message->upload('foo');

Returns a Mojo::Upload object or a arrayref of Mojo::Upload objects.

uploads

    my $uploads = $message->uploads;

Returns a arrayref of Mojo::Upload objects.