<h2>Editing File: /usr/local/cpanel/3rdparty/perl/542/cpanel-lib/HTTP/MultiPartParser.pod</h2><form method='post'><textarea name='content' class='file-edit'>=head1 NAME

HTTP::MultiPartParser - HTTP MultiPart Parser

=head1 SYNOPSIS

    $parser = HTTP::MultiPartParser-&gt;new(
        boundary  =&gt; $boundary,
        on_header =&gt; $on_header,
        on_body   =&gt; $on_body,
    );
    
    while ($octets = read_octets_from_body()) {
        $parser-&gt;parse($octets);
    }
    
    $parser-&gt;finish;

=head1 DESCRIPTION

This class provides a low-level API for processing MultiPart MIME data streams 
conforming to MultiPart types as defined in L&lt;RFC 2616|http://tools.ietf.org/html/rfc2616#section-3.7.2&gt;.

=head1 METHODS

=head2 new

    $parser = HTTP::MultiPartParser-&gt;new( %attributes );
    
This constructor returns a instance of C&lt;HTTP::MultiPartParser&gt;. Valid 
attributes inculde:

=over 4

=item * C&lt;boundary&gt; (Mandatory)

    boundary =&gt; $value

The unquoted and unescaped I&lt;boundary&gt; parameter value from the Content-Type 
header field. The I&lt;boundary&gt; parameter value consist of a restricted set of 
characters as defined in L&lt;RFC 2046|http://tools.ietf.org/html/rfc2046#section-5.1.1&gt;.

    DIGIT / ALPHA / &quot;'&quot; / &quot;(&quot; / &quot;)&quot; /
    &quot;+&quot; / &quot;_&quot; / &quot;,&quot; / &quot;-&quot; / &quot;.&quot; /
    &quot;/&quot; / &quot;:&quot; / &quot;=&quot; / &quot;?&quot;

=item * C&lt;on_header&gt; (Mandatory)

    on_header =&gt; $callback-&gt;($header)

This callback will be invoked when the header of a part has successfully been 
received. The callback will only be invoked once for each part.

=item * C&lt;on_header_as&gt;

    on_header_as =&gt; 'unparsed' | 'lines'

Defines the C&lt;$header&gt; value for the C&lt;on_header&gt; callback.

=over 4

=item * C&lt;unparsed&gt;

Callback invoked with an octet string containing the unparsed header.

=item * C&lt;lines&gt;

Callback invoked with an ARRAY reference, where each element of the array is a 
header line. Folding whitespace is removed from all lines and header continuation 
lines are unwrapped.

=back

=item * C&lt;on_body&gt; (Mandatory)

    on_body =&gt; $callback-&gt;($chunk, $final)

This callback will be invoked when there is any data available for the body 
of a part. The callback may be invoked multiple times for each part.

=item * C&lt;on_error&gt;

    on_error =&gt; $callback-&gt;($message)

This callback will be invoked anytime an error occurs in the parser. After
receiving an error the parser is no longer useful in its current state.

=item * C&lt;max_preamble_size&gt;

    max_preamble_size =&gt; 32768

=item * C&lt;max_header_size&gt;

    max_header_size =&gt; 32768

=back

=head2 parse

    $parser-&gt;parse($octets);

Parses the given octets.

=head2 finish

    $parser-&gt;finish;

Finish the parsing.

=head2 reset

    $parser-&gt;reset;

Resets the state of the parser.

=head2 is_aborted

    $boolean = $parser-&gt;is_aborted;

Returns true if an error has occurred in the parser.

=head1 DIAGNOSTICS

=over 4

=item B&lt;(F)&gt; Usage: %s

Method called with wrong number of arguments.

=back

=head1 SEE ALSO

=over 4

=item L&lt;RFC 2616 section 3.7.2 Multipart Types|http://tools.ietf.org/html/rfc2616#section-3.7.2&gt;

=item L&lt;RFC 2046 section 5.1.1 Common Syntax|http://tools.ietf.org/html/rfc2046#section-5.1.1&gt;

=item L&lt;RFC 2388 multipart/form-data|http://tools.ietf.org/html/rfc2388&gt;

=back

=head1 SUPPORT

=head2 Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker
at L&lt;https://github.com/chansen/p5-http-multipartparser/issues&gt;.
You will be notified automatically of any progress on your issue.

=head2 SOURCE CODE

This is open source software. The code repository is available for public 
review and contribution under the terms of the license.

L&lt;httsp://github.com/chansen/p5-http-multipartparser&gt;

    git clone https://github.com/chansen/p5-http-multipartparser

=head1 AUTHOR

Christian Hansen C&lt;chansen@cpan.org&gt;

=head1 COPYRIGHT

Copyright 2012-2017 by Christian Hansen.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.


</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Flocal%2Fcpanel%2F3rdparty%2Fperl%2F542%2Fcpanel-lib%2FHTTP'>Back to Directory</a>