POE::Component::Client::HTTP::Request(3pm)

1POE::Component::Client:U:sHeTrTPC:o:nRterqiubeustte(d3P)POeEr:l:CDoomcpuomneenntta:t:iColnient::HTTP::Request(3)
2
3
4

NAME

6       POE::Component::Client::HTTP::Request - an HTTP request class
7

SYNOPSIS

9         # Used internally by POE::Component::Client::HTTP
10

DESCRIPTION

12       POE::Component::Client::HTTP::Request encapsulates the state of
13       requests POE::Component::Client::HTTP requests throughout their life
14       cycles.  There turns out to be a lot of state to manage.
15

CONSTRUCTOR

17   new NAMED_PARAMETERS
18       Create a POE::Component::Client::HTTP object to manage a request.  The
19       constructor takes several named parameters:
20
21       Request => HTTP_REQUEST
22         A POE::Component::Client::HTTP::Request object encapsulates a plain
23         HTTP::Request.  Required.
24
25       Factory => POE_COMPONENT_CLIENT_HTTP_REQUESTFACTORY
26         The request may create additional requests during its lifetime, for
27         example when following redirects.  The Factory parameter specifies
28         the POE::Component::Client::HTTP::RequestFactory that may be used to
29         create them.  Required.
30
31       Postback => RESPONSE_POSTBACK
32         POE::Component::Client::HTTP creates a postback that will be used to
33         send responses to the requesting session.  Required.
34
35       Progress => PROGRESS_POSTBACK
36         Sets the progress notification if the user has requested progress
37         events.  Optional.
38
39       Proxy
40         Sets the proxy used for this request, if requested by the user.
41         Optional.
42

METHODS

44   ID
45       Return the request's unique ID.
46
47   return_response
48       Sends a response back to the user's session.  Called by
49       POE::Component::Client::HTTP when a complete response has arrived.
50
51   add_eof
52       Called by POE::Component::Client::HTTP to indicate EOF has arrived.
53
54   add_content PARSED_DATA
55       Called by POE::Component::Client::HTTP to add content data to an
56       incrementally built response.  If PARSED_DATA is an object, it is
57       treated like an HTTP::Headers object and its headers are assimilated
58       into the response being built by the request.  Otherwise the
59       PARSED_DATA is appended to the response's content.
60
61   timer TIMER
62       Accessor to manipulate the request's timeout timer.  Sets the request's
63       timer if TIMER is specified, otherwise merely fetches the one currently
64       associated with the request.
65
66   create_timer TIMEOUT
67       Creates and sets a timer for this request.  TIMEOUT is the number of
68       seconds this request may live.
69
70   remove_timeout
71       Turn off the timer associated with this request, and discard it.
72
73   postback POSTBACK
74       Accessor to manipulate the postback associated with this request.  Sets
75       the postback if POSTBACK is defined, otherwise merely fetches it.
76
77   does_redirect SOMETHING
78       FIXME - Not sure what this accessor does.
79
80   check_redirect
81       Check whether the last response is a redirect, the request is permitted
82       to follow redirects, and the maximum number of redirects has not been
83       met.  Initiate a redirect if all conditions are favorable.
84
85   send_to_wheel
86       Transmit the request to the socket associated with this request.
87
88   wheel
89       An accessor to return the wheel associated with this request.
90
91   error ERROR_CODE, ERROR_MESSAGE
92       Generate an error response, and post it back to the user's session.
93
94   connect_error CONNECT_FAILURE_MESSAGE
95       Generate a connection error response, and post it back to the user's
96       session.
97
98   host
99       Return the host this request is attempting to work with.
100
101   port
102       Return the port this request is attempting to work with.
103
104   scheme
105       Return the scheme for this request.
106

BUGS

111       None are currently known.
112

AUTHOR & COPYRIGHTS

114       POE::Component::Client::HTTP::Request is
115
116       · Copyright 2004-2005 Martijn van Beers
117
118       · Copyright 2006 Rocco Caputo
119
120       All rights are reserved.  POE::Component::Client::HTTP::Request is free
121       software; you may redistribute it and/or modify it under the same terms
122       as Perl itself.
123

CONTRIBUTORS

125       Your name could be here.
126

CONTACT

128       Rocco may be contacted by e-mail via <mailto:rcaputo@cpan.org>, and
129       Martijn may be contacted by email via <mailto:martijn@cpan.org>.
130
131       The preferred way to report bugs or requests is through RT though.  See
132       http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE-Component-Client-HTTP
133       <http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE-Component-Client-HTTP> or
134       mail mailto:bug-POE-Component-Client-HTTP@rt.cpan.org <mailto:bug-POE-
135       Component-Client-HTTP@rt.cpan.org>
136
137       For questions, try the POE mailing list (poe@perl.org)
138
139
140
141perl v5.12.0                      2010-P0O1E-:3:1Component::Client::HTTP::Request(3)