Manual Reference Pages - POE::COMPONENT::CLIENT::HTTP::REQUEST (3)
POE::Component::Client::HTTP::Request - an HTTP request class
# Used internally by POE::Component::Client::HTTP
POE::Component::Client::HTTP::Request encapsulates the state of
requests POE::Component::Client::HTTP requests throughout their life
cycles. There turns out to be a lot of state to manage.
Create a POE::Component::Client::HTTP object to manage a request. The
constructor takes several named parameters:
Request => HTTP_REQUEST
A POE::Component::Client::HTTP::Request object encapsulates a plain
Factory => POE_COMPONENT_CLIENT_HTTP_REQUESTFACTORY
The request may create additional requests during its lifetime, for
example when following redirects. The Factory parameter specifies the
POE::Component::Client::HTTP::RequestFactory that may be used to
create them. Required.
Postback => RESPONSE_POSTBACK
POE::Component::Client::HTTP creates a postback that will be used to
send responses to the requesting session. Required.
Progress => PROGRESS_POSTBACK
Sets the progress notification if the user has requested progress
Sets the proxy used for this request, if requested by the user.
Return the requests unique ID.
Sends a response back to the users session. Called by
POE::Component::Client::HTTP when a complete response has arrived.
Called by POE::Component::Client::HTTP to indicate EOF has arrived.
Called by POE::Component::Client::HTTP to add content data to an
incrementally built response. If PARSED_DATA is an object, it is
treated like an HTTP::Headers object and its headers are assimilated
into the response being built by the request. Otherwise the
PARSED_DATA is appended to the responses content.
Accessor to manipulate the requests timeout timer. Sets the
requests timer if TIMER is specified, otherwise merely fetches the
one currently associated with the request.
Creates and sets a timer for this request. TIMEOUT is the number of
seconds this request may live.
Turn off the timer associated with this request, and discard it.
Accessor to manipulate the postback associated with this request.
Sets the postback if POSTBACK is defined, otherwise merely fetches it.
FIXME - Not sure what this accessor does.
Check whether the last response is a redirect, the request is
permitted to follow redirects, and the maximum number of redirects has
not been met. Initiate a redirect if all conditions are favorable.
Transmit the request to the socket associated with this request.
An accessor to return the wheel associated with this request.
error ERROR_CODE, ERROR_MESSAGE
Generate an error response, and post it back to the users session.
Generate a connection error response, and post it back to the users
Return the host this request is attempting to work with.
Return the port this request is attempting to work with.
Return the scheme for this request.
None are currently known.
AUTHOR & COPYRIGHTS
All rights are reserved. POE::Component::Client::HTTP::Request is
free software; you may redistribute it and/or modify it under the same
terms as Perl itself.
Copyright 2004-2005 Martijn van Beers
Copyright 2006 Rocco Caputo
Your name could be here.
Rocco may be contacted by e-mail via <mailto:firstname.lastname@example.org>, and
Martijn may be contacted by email via <mailto:email@example.com>.
The preferred way to report bugs or requests is through RT though.
or mail <mailto:bug-POE-Component-Client-HTTP@rt.cpan.org>
For questions, try the POE mailing list (firstname.lastname@example.org)
|perl v5.20.3 ||POE::COMPONENT::CLIENT::HTTP::REQUEST (3) ||2013-05-06 |
Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.