📄 lwp::protocol.3
字号:
.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05).\".\" Standard preamble:.\" ========================================================================.de Sh \" Subsection heading.br.if t .Sp.ne 5.PP\fB\\$1\fR.PP...de Sp \" Vertical space (when we can't use .PP).if t .sp .5v.if n .sp...de Vb \" Begin verbatim text.ft CW.nf.ne \\$1...de Ve \" End verbatim text.ft R.fi...\" Set up some character translations and predefined strings. \*(-- will.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left.\" double quote, and \*(R" will give a right double quote. \*(C+ will.\" give a nicer C++. Capital omega is used to do unbreakable dashes and.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,.\" nothing in troff, for use with C<>..tr \(*W-.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'.ie n \{\. ds -- \(*W-. ds PI pi. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch. ds L" "". ds R" "". ds C` "". ds C' ""'br\}.el\{\. ds -- \|\(em\|. ds PI \(*p. ds L" ``. ds R" '''br\}.\".\" Escape single quotes in literal strings from groff's Unicode transform..ie \n(.g .ds Aq \(aq.el .ds Aq '.\".\" If the F register is turned on, we'll generate index entries on stderr for.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index.\" entries marked with X<> in POD. Of course, you'll have to process the.\" output yourself in some meaningful fashion..ie \nF \{\. de IX. tm Index:\\$1\t\\n%\t"\\$2"... nr % 0. rr F.\}.el \{\. de IX...\}.\".\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2)..\" Fear. Run. Save yourself. No user-serviceable parts.. \" fudge factors for nroff and troff.if n \{\. ds #H 0. ds #V .8m. ds #F .3m. ds #[ \f1. ds #] \fP.\}.if t \{\. ds #H ((1u-(\\\\n(.fu%2u))*.13m). ds #V .6m. ds #F 0. ds #[ \&. ds #] \&.\}. \" simple accents for nroff and troff.if n \{\. ds ' \&. ds ` \&. ds ^ \&. ds , \&. ds ~ ~. ds /.\}.if t \{\. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u". ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'.\}. \" troff and (daisy-wheel) nroff accents.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'.ds 8 \h'\*(#H'\(*b\h'-\*(#H'.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#].ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#].ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#].ds ae a\h'-(\w'a'u*4/10)'e.ds Ae A\h'-(\w'A'u*4/10)'E. \" corrections for vroff.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'. \" for low resolution devices (crt and lpr).if \n(.H>23 .if \n(.V>19 \\{\. ds : e. ds 8 ss. ds o a. ds d- d\h'-1'\(ga. ds D- D\h'-1'\(hy. ds th \o'bp'. ds Th \o'LP'. ds ae ae. ds Ae AE.\}.rm #[ #] #H #V #F C.\" ========================================================================.\".IX Title "LWP::Protocol 3".TH LWP::Protocol 3 "2007-07-19" "perl v5.10.0" "User Contributed Perl Documentation".\" For nroff, turn off justification. Always turn off hyphenation; it makes.\" way too many mistakes in technical documents..if n .ad l.nh.SH "NAME"LWP::Protocol \- Base class for LWP protocols.SH "SYNOPSIS".IX Header "SYNOPSIS".Vb 3\& package LWP::Protocol::foo;\& require LWP::Protocol;\& @ISA=qw(LWP::Protocol);.Ve.SH "DESCRIPTION".IX Header "DESCRIPTION"This class is used a the base class for all protocol implementationssupported by the \s-1LWP\s0 library..PPWhen creating an instance of this class using\&\f(CW\*(C`LWP::Protocol::create($url)\*(C'\fR, and you get an initialised subclassappropriate for that access method. In other words, the\&\fILWP::Protocol::create()\fR function calls the constructor for one of itssubclasses..PPAll derived LWP::Protocol classes need to override the \fIrequest()\fRmethod which is used to service a request. The overridden method canmake use of the \fIcollect()\fR function to collect together chunks of dataas it is received..PPThe following methods and functions are provided:.ie n .IP "$prot\fR = LWP::Protocol\->\fInew()" 4.el .IP "\f(CW$prot\fR = LWP::Protocol\->\fInew()\fR" 4.IX Item "$prot = LWP::Protocol->new()"The LWP::Protocol constructor is inherited by subclasses. As this is avirtual base class this method should \fBnot\fR be called directly..ie n .IP "$prot = LWP::Protocol::create($scheme)" 4.el .IP "\f(CW$prot\fR = LWP::Protocol::create($scheme)" 4.IX Item "$prot = LWP::Protocol::create($scheme)"Create an object of the class implementing the protocol to handle thegiven scheme. This is a function, not a method. It is more an objectfactory than a constructor. This is the function user agents shoulduse to access protocols..ie n .IP "$class = LWP::Protocol::implementor($scheme, [$class])" 4.el .IP "\f(CW$class\fR = LWP::Protocol::implementor($scheme, [$class])" 4.IX Item "$class = LWP::Protocol::implementor($scheme, [$class])"Get and/or set implementor class for a scheme. Returns '' if thespecified scheme is not supported..ie n .IP "$prot\->request(...)" 4.el .IP "\f(CW$prot\fR\->request(...)" 4.IX Item "$prot->request(...)".Vb 3\& $response = $protocol\->request($request, $proxy, undef);\& $response = $protocol\->request($request, $proxy, \*(Aq/tmp/sss\*(Aq);\& $response = $protocol\->request($request, $proxy, \e&callback, 1024);.Ve.SpDispatches a request over the protocol, and returns a responseobject. This method needs to be overridden in subclasses. Refer toLWP::UserAgent for description of the arguments..ie n .IP "$prot\fR\->collect($arg, \f(CW$response\fR, \f(CW$collector)" 4.el .IP "\f(CW$prot\fR\->collect($arg, \f(CW$response\fR, \f(CW$collector\fR)" 4.IX Item "$prot->collect($arg, $response, $collector)"Called to collect the content of a request, and process itappropriately into a scalar, file, or by calling a callback. If \f(CW$arg\fRis undefined, then the content is stored within the \f(CW$response\fR. If\&\f(CW$arg\fR is a simple scalar, then \f(CW$arg\fR is interpreted as a file name andthe content is written to this file. If \f(CW$arg\fR is a reference to aroutine, then content is passed to this routine..SpThe \f(CW$collector\fR is a routine that will be called and which isresponsible for returning pieces (as ref to scalar) of the content toprocess. The \f(CW$collector\fR signals \s-1EOF\s0 by returning a reference to anempty sting..SpThe return value from \fIcollect()\fR is the \f(CW$response\fR object reference..Sp\&\fBNote:\fR We will only use the callback or file argument if\&\f(CW$response\fR\->\fIis_success()\fR. This avoids sending content data forredirects and authentication responses to the callback which would beconfusing..ie n .IP "$prot\fR\->collect_once($arg, \f(CW$response\fR, \f(CW$content)" 4.el .IP "\f(CW$prot\fR\->collect_once($arg, \f(CW$response\fR, \f(CW$content\fR)" 4.IX Item "$prot->collect_once($arg, $response, $content)"Can be called when the whole response content is available as\&\f(CW$content\fR. This will invoke \fIcollect()\fR with a collector callback thatreturns a reference to \f(CW$content\fR the first time and an empty string thenext..SH "SEE ALSO".IX Header "SEE ALSO"Inspect the \fILWP/Protocol/file.pm\fR and \fILWP/Protocol/http.pm\fR filesfor examples of usage..SH "COPYRIGHT".IX Header "COPYRIGHT"Copyright 1995\-2001 Gisle Aas..PPThis library is free software; you can redistribute it and/ormodify it under the same terms as Perl itself..SH "POD ERRORS".IX Header "POD ERRORS"Hey! \fBThe above document had some coding errors, which are explained below:\fR.IP "Around line 281:" 4.IX Item "Around line 281:"You forgot a '=back' before '=head1'
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -