.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Response 3"
.TH Response 3 "2012-07-13" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
POEx::HTTP::Server::Response \- Object encapsulating an HTTP response
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use POEx::HTTP::Server;
.Ve
.PP
.Vb 1
\&    POEx::HTTP::Server->spawn( handler => 'poe:my-alias/handler' );
.Ve
.PP
.Vb 3
\&    # events of session my-alias:
\&    sub handler {
\&        my( $heap, $req, $resp ) = @_[HEAP,ARG0,ARG1];
.Ve
.PP
.Vb 5
\&        $resp->content_type( 'text/html' );
\&        $resp->content( $HTML );
\&        $resp->respond;
\&        $resp->done;
\&    }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A \f(CW\*(C`POEx::HTTP::Server::Response\*(C'\fR object is supplied as \f(CW\*(C`ARG1\*(C'\fR to each
\&\f(CW\*(C`POEx::HTTP::Server::\*(C'\fR request handler.  
.PP
It is a sub-class of HTTP::Response with the following additions:
.SH "METHODS"
.IX Header "METHODS"
.Sh "done"
.IX Subsection "done"
.Vb 1
\&    $req->done;
.Ve
.PP
Finishes the request.  If keepalive isn't active, this will close the
connection.  Must be called after \f(CW\*(C`respond\*(C'\fR or \f(CW\*(C`send\*(C'\fR.  Having a seperate
done and <respond> means that you can do some post processing after the
response was sent.
.PP
.Vb 3
\&    $resp->content( $HTML );
\&    $resp->respond;
\&    $poe_kernel->yield( 'other_event', $resp );
.Ve
.PP
.Vb 2
\&    # Do some work in other_event
\&    $resp->done;
.Ve
.Sh "error"
.IX Subsection "error"
.Vb 1
\&    $resp->error( $CODE, $TEXT );
.Ve
.PP
Send \f(CW$TEXT\fR as error message to the browser with status code of \f(CW$CODE\fR.
The default \fIContent-Type\fR is \fItext/plain\fR, but this may be overridden by
setting the \fIContent-Type\fR before hand.
.PP
When \*(L"error\*(R" is called, the response is sent to the browser
(\f(CW\*(C`\*(L"respond\*(R"\*(C'\fR) and the request is finished (\f(CW\*(C`\*(L"done\*(R"\*(C'\fR).
.Sh "finished"
.IX Subsection "finished"
False; will be set to true when \*(L"done\*(R" is called.
.Sh "respond"
.IX Subsection "respond"
.Vb 1
\&    $resp->respond;
.Ve
.PP
Sends the response to the browser.  Sends headers if they aren't already
sent.  No more content may be sent to the browser after this method call.
\&\*(L"done\*(R" must still be called to finish the request.
.Sh "send"
.IX Subsection "send"
.Vb 1
\&    $resp->send( [$CONTENT] );
.Ve
.PP
Sends the response header (if not already sent) and \f(CW$CONTENT\fR to the
browser (if defined). The request is kept open and furthur calls to \f(CW\*(C`send\*(C'\fR
are allowed to send more content to the browser.
.PP
\fIsendfile\fR
.IX Subsection "sendfile"
.PP
.Vb 2
\&    $resp->sendfile( $FILE );
\&    $resp->sendfile( $FILE, $CONTENT_TYPE );
.Ve
.PP
Sends the static file \f(CW$FILE\fR to the browser.  This method also deals with the
requirements of \f(CW\*(C`HEAD\*(C'\fR requests and \f(CW\*(C`If\-Modified\-Since\*(C'\fR requests.
.PP
You may specify the content-type of the file either by calling
content_type directly or by passing \f(CW$CONTENT_TYPE\fR as a parameter. If
the content-type hasn't already been selected, it defaults to
\&\f(CW\*(C`application/octet\-stream\*(C'\fR.
.PP
If Sys::Sendfile is installed, \f(CW\*(C`sendfile\*(C'\fR is used to efficiently send
the file over the socket.  Otherwise the file is sent in 
\&\*(L"blocksize\*(R" in POEx::HTTP::Server sized chunks.
.PP
\fIheaders_sent\fR
.IX Subsection "headers_sent"
.PP
.Vb 4
\&    unless( $resp->headers_sent ) {
\&        $resp->headers_sent( 1 );
\&        # ...
\&    }
.Ve
.PP
Gets or sets the fact that a response header has already been sent.
.PP
\fIstreaming\fR
.IX Subsection "streaming"
.PP
.Vb 1
\&    $resp->streaming( 1 );
.Ve
.PP
Turns on streaming mode for the socket.  \*(L"send\*(R" does this also.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
POEx::HTTP::Server, POEx::HTTP::Server::Response.
.SH "AUTHOR"
.IX Header "AUTHOR"
Philip Gwyn, <gwyn \-at\- cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2010 by Philip Gwyn
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.8 or,
at your option, any later version of Perl 5 you may have available.