NAME<\/a> LWP::Protocol \u2212 Base class for LWP protocols<\/p>\n package LWP::Protocol::foo; This class is used as the base class for all protocol implementations supported by the LWP<\/small> library.<\/p>\n When creating an instance of this class using “LWP::Protocol::create($url)”, and you get an initialized subclass appropriate for that access method. In other words, the “create” in LWP::Protocol function calls the constructor for one of its subclasses.<\/p>\n All derived “LWP::Protocol” classes need to override the request()<\/b> method which is used to service a request. The overridden method can make use of the collect()<\/b> function to collect together chunks of data as it is received.<\/p>\n The following methods and functions are provided:<\/p>\n new<\/b> The LWP::Protocol constructor is inherited by subclasses. As this is a virtual base class this method should not<\/b> be called directly.<\/p>\n create<\/b> Create an object of the class implementing the protocol to handle the given scheme. This is a function, not a method. It is more an object factory than a constructor. This is the function user agents should use to access protocols.<\/p>\n implementor<\/b> Get and\/or set implementor class for a scheme. Returns ” if the specified scheme is not supported.<\/p>\n request<\/b> Dispatches a request over the protocol, and returns a response object. This method needs to be overridden in subclasses. Refer to LWP::UserAgent for description of the arguments.<\/p>\n collect<\/b> Collect the content of a request, and process it appropriately into a scalar, file, or by calling a callback. If the first parameter is undefined, then the content is stored within the $response. If it\u2019s a simple scalar, then it\u2019s interpreted as a file name and the content is written to this file. If it\u2019s a code reference, then content is passed to this routine.<\/p>\n The collector is a routine that will be called and which is responsible for returning pieces (as ref to scalar) of the content to process. The $collector signals “EOF” by returning a reference to an empty string.<\/p>\n The return value is the HTTP::Response object reference.<\/p>\n Note:<\/b> We will only use the callback or file argument if “$response\u2212>is_success()”. This avoids sending content data for redirects and authentication responses to the callback which would be confusing.<\/p>\n collect_once<\/b> Can be called when the whole response content is available as content. This will invoke “collect” in LWP::Protocol with a collector callback that returns a reference to $content the first time and an empty string the next.<\/p>\n
SYNOPSIS<\/a>
DESCRIPTION<\/a>
METHODS<\/a>
SEE ALSO<\/a>
COPYRIGHT<\/a> <\/p>\n
\nNAME <\/a> <\/h2>\n
SYNOPSIS <\/a> <\/h2>\n
use base qw(LWP::Protocol);<\/p>\nDESCRIPTION <\/a> <\/h2>\n
METHODS <\/a> <\/h2>\n
my $prot = LWP::Protocol\u2212>new();<\/p>\n
my $prot = LWP::Protocol::create($scheme)<\/p>\n
my $class = LWP::Protocol::implementor($scheme, [$class])<\/p>\n
$response = $protocol\u2212>request($request, $proxy, undef);
$response = $protocol\u2212>request($request, $proxy, ‘\/tmp\/sss’);
$response = $protocol\u2212>request($request, $proxy, &callback, 1024);<\/p>\n
my $res = $prot\u2212>collect(undef, $response, $collector); # stored in $response
my $res = $prot\u2212>collect($filename, $response, $collector);
my $res = $prot\u2212>collect(sub { … }, $response, $collector);<\/p>\n
$prot\u2212>collect_once($arg, $response, $content)<\/p>\nSEE ALSO <\/a> <\/h2>\n