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

VERSION

9       version 0.949
10

SYNOPSIS

12         # Used internally by POE::Component::Client::HTTP
13

DESCRIPTION

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

CONSTRUCTOR

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

METHODS

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

BUGS

118       None are currently known.
119

AUTHOR & COPYRIGHTS

121       POE::Component::Client::HTTP::Request is
122
123       • Copyright 2004-2005 Martijn van Beers
124
125       • Copyright 2006 Rocco Caputo
126
127       All rights are reserved.  POE::Component::Client::HTTP::Request is free
128       software; you may redistribute it and/or modify it under the same terms
129       as Perl itself.
130

CONTRIBUTORS

132       Your name could be here.
133

CONTACT

135       Rocco may be contacted by e-mail via <mailto:rcaputo@cpan.org>, and
136       Martijn may be contacted by email via <mailto:martijn@cpan.org>.
137
138       The preferred way to report bugs or requests is through RT though.  See
139       <http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE-Component-Client-HTTP> or
140       mail <mailto:bug-POE-Component-Client-HTTP@rt.cpan.org>
141
142       For questions, try the POE mailing list (poe@perl.org)
143
144
145
146perl v5.34.0                      2021-P0O7E-:2:2Component::Client::HTTP::Request(3)