poe::component::client::http::requestfactory(3pm) [debian man page]
POE::Component::Client::HTTP::RequestFactory(3pm) User Contributed Perl Documentation POE::Component::Client::HTTP::RequestFactory(3pm) NAME
POE::Component::Client::HTTP::RequestFactory - an HTTP request factory object VERSION
version 0.947 SYNOPSIS
# Used internally by POE::Component::Client::HTTP CONSTRUCTOR
new Create a new request factory object. It expects its parameters in a hashref. The following parameters are accepted. They are explained in detail in POE::Component::Client::HTTP. o Agent o MaxSize o Streaming o Protocol o From o CookieJar o NoProxy o Proxy o FollowRedirects o Timeout METHODS
timeout [$timeout] Method that lets you query and/or change the timeout value for requests created by this factory. is_streaming Accessor for the Streaming parameter agent Accessor to the Agent parameter from getter/setter for the From parameter create_request Creates a new POE::Component::Client::HTTP::Request max_response_size Method to retrieve the maximum size of a response, as set by the "MaxSize" parameter to Client::HTTP's "spawn()" method. block_size Accessor for the Streaming parameter frob_cookies $response Store the cookies from the HTTP::Response parameter passed into our cookie jar 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 "spawn" method. parse_proxy $proxy This static method is used for parsing proxies. The $proxy can be array reference like [host, port] or comma separated string like "http://1.2.3.4:80/,http://2.3.4.5:80/". parse_proxy() returns an array reference of two-element tuples (also array ferences), each containing a host and a port: [ [ host1, port1 ], [ host2, port2 ], ... ] perl v5.14.2 2012-06-03 POE::Component::Client::HTTP::RequestFactory(3pm)
Check Out this Related Man Page
POE::Component::Client::HTTP::Request(3pm) User Contributed Perl Documentation POE::Component::Client::HTTP::Request(3pm) NAME
POE::Component::Client::HTTP::Request - an HTTP request class VERSION
version 0.947 SYNOPSIS
# Used internally by POE::Component::Client::HTTP DESCRIPTION
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. CONSTRUCTOR
new NAMED_PARAMETERS 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 HTTP::Request. Required. 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 events. Optional. Proxy Sets the proxy used for this request, if requested by the user. Optional. METHODS
ID Return the request's unique ID. return_response Sends a response back to the user's session. Called by POE::Component::Client::HTTP when a complete response has arrived. add_eof Called by POE::Component::Client::HTTP to indicate EOF has arrived. add_content PARSED_DATA 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 response's content. timer TIMER Accessor to manipulate the request's timeout timer. Sets the request's timer if TIMER is specified, otherwise merely fetches the one currently associated with the request. create_timer TIMEOUT Creates and sets a timer for this request. TIMEOUT is the number of seconds this request may live. remove_timeout Turn off the timer associated with this request, and discard it. postback POSTBACK Accessor to manipulate the postback associated with this request. Sets the postback if POSTBACK is defined, otherwise merely fetches it. does_redirect SOMETHING FIXME - Not sure what this accessor does. check_redirect 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. send_to_wheel Transmit the request to the socket associated with this request. wheel 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 user's session. connect_error CONNECT_FAILURE_MESSAGE Generate a connection error response, and post it back to the user's session. host Return the host this request is attempting to work with. port Return the port this request is attempting to work with. scheme Return the scheme for this request. SEE ALSO
POE::Component::Client::HTTP POE BUGS
None are currently known. AUTHOR &; COPYRIGHTS POE::Component::Client::HTTP::Request is o Copyright 2004-2005 Martijn van Beers o Copyright 2006 Rocco Caputo 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. CONTRIBUTORS
Your name could be here. CONTACT
Rocco may be contacted by e-mail via <mailto:rcaputo@cpan.org>, and Martijn may be contacted by email via <mailto:martijn@cpan.org>. The preferred way to report bugs or requests is through RT though. See http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE-Component-Client-HTTP <http://rt.cpan.org/NoAuth/Bugs.html?Dist=POE-Component-Client-HTTP> or mail mailto:bug-POE-Component-Client-HTTP@rt.cpan.org <mailto:bug- POE-Component-Client-HTTP@rt.cpan.org> For questions, try the POE mailing list (poe@perl.org) perl v5.14.2 2012-06-03 POE::Component::Client::HTTP::Request(3pm)