.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 >0, 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
.\" ========================================================================
.\"
.IX Title "POE::Component::Client::HTTP::RequestFactory 3"
.TH POE::Component::Client::HTTP::RequestFactory 3 2023-07-26 "perl v5.38.0" "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
POE::Component::Client::HTTP::RequestFactory \- an HTTP request factory object
.SH VERSION
.IX Header "VERSION"
version 0.949
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  # Used internally by POE::Component::Client::HTTP
.Ve
.SH CONSTRUCTOR
.IX Header "CONSTRUCTOR"
.SS new
.IX Subsection "new"
Create a new request factory object. It expects its parameters in a
hashref.
.PP
The following parameters are accepted.  They are explained in detail
in POE::Component::Client::HTTP.
.IP \(bu 4
Agent
.IP \(bu 4
MaxSize
.IP \(bu 4
Streaming
.IP \(bu 4
Protocol
.IP \(bu 4
From
.IP \(bu 4
CookieJar
.IP \(bu 4
NoProxy
.IP \(bu 4
Proxy
.IP \(bu 4
FollowRedirects
.IP \(bu 4
Timeout
.SH METHODS
.IX Header "METHODS"
.SS "timeout [$timeout]"
.IX Subsection "timeout [$timeout]"
Method that lets you query and/or change the timeout value for requests
created by this factory.
.SS is_streaming
.IX Subsection "is_streaming"
Accessor for the Streaming parameter
.SS agent
.IX Subsection "agent"
Accessor to the Agent parameter
.SS from
.IX Subsection "from"
getter/setter for the From parameter
.SS create_request
.IX Subsection "create_request"
Creates a new POE::Component::Client::HTTP::Request
.SS max_response_size
.IX Subsection "max_response_size"
Method to retrieve the maximum size of a response, as set by the
\&\f(CW\*(C`MaxSize\*(C'\fR parameter to Client::HTTP's \f(CWspawn()\fR method.
.SS block_size
.IX Subsection "block_size"
Accessor for the Streaming parameter
.ie n .SS "frob_cookies $response"
.el .SS "frob_cookies \f(CW$response\fP"
.IX Subsection "frob_cookies $response"
Store the cookies from the HTTP::Response parameter passed into
our cookie jar
.SS "max_redirect_count [$count]"
.IX Subsection "max_redirect_count [$count]"
Function to get/set the maximum number of redirects to follow
automatically. This allows you to retrieve or modify the value
you passed with the FollowRedirects parameter to Client::HTTP's
\&\f(CW\*(C`spawn\*(C'\fR method.
.ie n .SS "parse_proxy $proxy"
.el .SS "parse_proxy \f(CW$proxy\fP"
.IX Subsection "parse_proxy $proxy"
This static method is used for parsing proxies. The \f(CW$proxy\fR can be
array reference like [host, port] or comma separated string like
"http://1.2.3.4:80/,http://2.3.4.5:80/".
.PP
\&\fBparse_proxy()\fR returns an array reference of two-element tuples (also
array ferences), each containing a host and a port:
.PP
.Vb 4
\&  [ [ host1, port1 ],
\&    [ host2, port2 ],
\&    ...
\&  ]
.Ve