.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" 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 "Net::HTTPServer::Response 3pm"
.TH Net::HTTPServer::Response 3pm "2014-06-30" "perl v5.18.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Net::HTTPServer::Response \- HTTP response
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Net::HTTPServer::Response handles formatting the response to the client.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Net::HTTPServer::Response provides a nice \s-1OOP\s0 interface for easy control
of headers, cookies, sessions, and/or the content that will be sent to
the requesting client.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
my \f(CW$response\fR = new \fINet::HTTPServer::Response()\fR;
.PP
my \f(CW$response\fR = new Net::HTTPServer::Response(code=>200,
                                             headers=>{
                                            );
.PP
my \f(CW$response\fR = \f(CW$request\fR\->\fIResponse()\fR;
.SH "METHODS"
.IX Header "METHODS"
.SS "new(%cfg)"
.IX Subsection "new(%cfg)"
Given a config hash, return a server object that you can start, process,
and stop.  The config hash takes the options:
.PP
.Vb 2
\&    body => string      \- The contents of the response.
\&                          ( Default: "" )
\&
\&    code => int         \- The return code of this reponse.
\&                          ( Default: 200 )
\&                      
\&    cookies => hashref  \- Hash reference to a set of cookies to send.
\&                          Most people should just use the Cookie method
\&                          to set these.
\&                          ( Default: {} )
\&
\&    headers => hashref  \- Hash reference to the headers to send.  Most
\&                          people should just use the Header method.
\&                          ( Default: {} )
.Ve
.SS "Body([string])"
.IX Subsection "Body([string])"
Returns the current value of the response body.  Sets the content of
the response if a value is specified.
.SS "\fIClear()\fP"
.IX Subsection "Clear()"
Reset the body to "".
.SS "Code(int)"
.IX Subsection "Code(int)"
Returns the current value of the response code.  Set the status code
of the response if a value is specified.
.SS "Cookie(name[,value[,%options]])"
.IX Subsection "Cookie(name[,value[,%options]])"
Returns the cookie value for the specified name, or undef if it is
not set.  If the value is also specified, then the cookie is set
to the value.  The optional hash options that you can provide to
the cookie are:
.PP
.Vb 3
\&    domain => string   \- If specified, the client will return the
\&                         cookie for any hostname that is part of
\&                         the domain.
\&
\&    expires => string  \- When should the cookie expire.  Must be
\&                         formatted according to the rules:
\&                             Wednesday, 30\-June\-2004 18:14:24 GMT
\&                         Optionally you can specify "now" which
\&                         will resolve to the current time.
\&                      
\&    path => string     \- The path on the server that the client should
\&                         return the cookie for.
\&
\&    secure => 0|1      \- The client will only return the cookie over
\&                         an HTTPS connection.
.Ve
.SS "Header(name[,value])"
.IX Subsection "Header(name[,value])"
Returns the header value for the specified name, or undef if it is not
set.  If the value is specified, then the header is set to the value.
.SS "Print(arg1[,arg2,...,argN])"
.IX Subsection "Print(arg1[,arg2,...,argN])"
Appends the arguments to the end of the body.
.SS "Redirect(url)"
.IX Subsection "Redirect(url)"
Redirect the client to the specified \s-1URL.\s0
.SS "Session(object)"
.IX Subsection "Session(object)"
Register the Net::HTTPServer::Session object with the response.  When
the server builds the actual reponse to the client it will set the
appropriate cookie and save the session.  If the response is
created from the request object, and there was a session created
from the request object then this, will be prepopulated with that
session.
.SS "\fICaptureSTDOUT()\fP"
.IX Subsection "CaptureSTDOUT()"
If you use the \s-1CGI\s0 perl module then it wants to print everything to
\&\s-1STDOUT. \s0 \fICaptureSTDOUT()\fR will put the Reponse object into a mode
where it will capture all the output from the module. See
\&\fIProcessSTDOUT()\fR for more information.
.SS "ProcessSTDOUT([%args])"
.IX Subsection "ProcessSTDOUT([%args])"
This will harvest all of the data printed to \s-1STDOUT\s0 and put it into
the Response object via a \fIPrint()\fR call.  This will also stop
monitoring \s-1STDOUT\s0 and release it.  You can specify some options:
.PP
.Vb 4
\&  strip_header => 0|1     \- If you use the CGI module and you
\&                            print the headers then ProcessSTDOUT()
\&                            can try to strip those out.  The best
\&                            plan is not to print them.
.Ve
.PP
See \fICaptureSTDOUT()\fR for more information.
.SH "AUTHOR"
.IX Header "AUTHOR"
Ryan Eatmon
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2003\-2005 Ryan Eatmon <reatmon@mail.com>. All rights
reserved.  This program is free software; you can redistribute it
and/or modify it under the same terms as Perl itself.