debian man page for mojo::content

Mojo::Content(3pm)					User Contributed Perl Documentation					Mojo::Content(3pm)

NAME
       Mojo::Content - HTTP 1.1 content base class

SYNOPSIS
	 use Mojo::Base 'Mojo::Content';

DESCRIPTION
       Mojo::Content is an abstract base class for HTTP 1.1 content as described in RFC 2616.

EVENTS
       Mojo::Content can emit the following events.

   "drain"
	 $content->on(drain => sub {
	   my ($content, $offset) = @_;
	   ...
	 });

       Emitted once all data has been written.

	 $content->on(drain => sub {
	   my $content = shift;
	   $content->write_chunk(time);
	 });

   "body"
	 $content->on(body => sub {
	   my $content = shift;
	   ...
	 });

       Emitted once all headers have been parsed and the body starts.

	 $content->on(body => sub {
	   my $content = shift;
	   $content->auto_upgrade(0) if $content->headers->header('X-No-MultiPart');
	 });

   "read"
	 $content->on(read => sub {
	   my ($content, $chunk) = @_;
	   ...
	 });

       Emitted when a new chunk of content arrives.

	 $content->unsubscribe('read');
	 $content->on(read => sub {
	   my ($content, $chunk) = @_;
	   say "Streaming: $chunk";
	 });

ATTRIBUTES
       Mojo::Content implements the following attributes.

   "auto_relax"
	 my $relax = $content->auto_relax;
	 $content  = $content->auto_relax(1);

       Try to detect broken web servers and turn on relaxed parsing automatically.

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

       Content headers, defaults to a Mojo::Headers object.

   "max_leftover_size"
	 my $size = $content->max_leftover_size;
	 $content = $content->max_leftover_size(1024);

       Maximum size in bytes of buffer for pipelined HTTP requests, defaults to the value of the "MOJO_MAX_LEFTOVER_SIZE" environment variable or
       262144.

   "relaxed"
	 my $relaxed = $content->relaxed;
	 $content    = $content->relaxed(1);

       Activate relaxed parsing for HTTP 0.9 and responses that are terminated with a connection close.

METHODS
       Mojo::Content inherits all methods from Mojo::EventEmitter and implements the following new ones.

   "body_contains"
	 my $success = $content->body_contains('foo bar baz');

       Check if content contains a specific string. Meant to be overloaded in a subclass.

   "body_size"
	 my $size = $content->body_size;

       Content size in bytes. Meant to be overloaded in a subclass.

   "boundary"
	 my $boundary = $content->boundary;

       Extract multipart boundary from "Content-Type" header.

   "build_body"
	 my $string = $content->build_body;

       Render whole body.

   "build_headers"
	 my $string = $content->build_headers;

       Render all headers.

   "charset"
	 my $charset = $content->charset;

       Extract charset from "Content-Type" header.

   "clone"
	 my $clone = $content->clone;

       Clone content if possible, otherwise return "undef".

   "generate_body_chunk"
	 my $chunk = $content->generate_body_chunk(0);

       Generate dynamic content.

   "get_body_chunk"
	 my $chunk = $content->get_body_chunk(0);

       Get a chunk of content starting from a specfic position. Meant to be overloaded in a subclass.

   "get_header_chunk"
	 my $chunk = $content->get_header_chunk(13);

       Get a chunk of the headers starting from a specfic position.

   "has_leftovers"
	 my $success = $content->has_leftovers;

       Check if there are leftovers.

   "header_size"
	 my $size = $content->header_size;

       Size of headers in bytes.

   "is_chunked"
	 my $success = $content->is_chunked;

       Check if content is chunked.

   "is_dynamic"
	 my $success = $content->is_dynamic;

       Check if content will be dynamically generated, which prevents "clone" from working.

   "is_finished"
	 my $success = $content->is_finished;

       Check if parser is finished.

   "is_multipart"
	 my $false = $content->is_multipart;

       False.

   "is_parsing_body"
	 my $success = $content->is_parsing_body;

       Check if body parsing started yet.

   "leftovers"
	 my $bytes = $content->leftovers;

       Get leftover data from content parser.

   "parse"
	 $content = $content->parse("Content-Length: 12

Hello World!");

       Parse content chunk.

   "parse_body"
	 $content = $content->parse_body("Hi!");

       Parse body chunk.

   "parse_body_once"
	 $content = $content->parse_body_once("Hi!");

       Parse body chunk once.

   "parse_until_body"
	 $content
	   = $content->parse_until_body("Content-Length: 12

Hello World!");

       Parse chunk and stop after headers.

   "progress"
	 my $size = $content->progress;

       Size of content already received from message in bytes.

   "write"
	 $content->write('Hello!');
	 $content->write('Hello!', sub {...});

       Write dynamic content non-blocking, the optional drain callback will be invoked once all data has been written.

   "write_chunk"
	 $content->write_chunk('Hello!');
	 $content->write_chunk('Hello!', sub {...});

       Write dynamic content non-blocking with "chunked" transfer encoding, the optional drain callback will be invoked once all data has been
       written.

SEE ALSO
       Mojolicious, Mojolicious::Guides, <http://mojolicio.us>.

perl v5.14.2							    2012-09-05							Mojo::Content(3pm)