.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .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" '' . ds C` . ds C' '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 >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "WWW::Curl::Simple 3pm" .TH WWW::Curl::Simple 3pm "2020-10-04" "perl v5.30.3" "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" WWW::Curl::Simple \- A Simpler interface to WWW::Curl .SH "VERSION" .IX Header "VERSION" version 0.100191 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& my $curl = WWW::Curl::Simple\->new(); \& \& my $res = $curl\->get(\*(Aqhttp://www.google.com/\*(Aq); .Ve .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" .SS "timeout / timeout_ms" .IX Subsection "timeout / timeout_ms" Sets the timeout of individual requests, in seconds or milliseconds. .SS "max_redirects" .IX Subsection "max_redirects" Sets the maximum number of redirects that should be transparently followed. Set this to 0 if you don't want to follow redirects. Default: 5. .SS "check_ssl_certs" .IX Subsection "check_ssl_certs" Specifies whether the underlying Curl library should check \s-1SSL\s0 certificates when making https requests. Defaults to 1 (i.e. do check certs, to err on safe side). .SS "ssl_cert_bundle" .IX Subsection "ssl_cert_bundle" Specifies the bundle to look for \s-1CA\s0 certificates in. Leave blank for system default, which should work if your libcurl is properly compiled. .SS "connection_timeout /connection_timeout_ms" .IX Subsection "connection_timeout /connection_timeout_ms" Sets the timeout of the connect phase of requests, in seconds or milliseconds. .SS "fatal" .IX Subsection "fatal" Defaults to true, but if set to false, it will make failure in multi-requests warn instead of die. .SH "METHODS" .IX Header "METHODS" .SS "request($req)" .IX Subsection "request($req)" \&\f(CW$req\fR should be a HTTP::Request object. .PP If you have a \s-1URI\s0 string or object, look at the \f(CW\*(C`get\*(C'\fR method instead. Returns a WWW::Curl::Simple::Request object. .SS "get($uri || \s-1URI\s0)" .IX Subsection "get($uri || URI)" Accepts one parameter, which should be a reference to a \s-1URI\s0 object or a string representing a \s-1URI.\s0 Returns a HTTP::Response object. .ie n .SS "post($uri || \s-1URI,\s0 $form)" .el .SS "post($uri || \s-1URI,\s0 \f(CW$form\fP)" .IX Subsection "post($uri || URI, $form)" Creates a HTTP::Request of type \s-1POST\s0 to \f(CW$uri\fR, which can be a string or a \s-1URI\s0 object, and sets the form of the request to \f(CW$form\fR. See HTTP::Request for more information on the format of \f(CW$form\fR. .SS "add_request($req)" .IX Subsection "add_request($req)" Adds \f(CW$req\fR (a HTTP::Request object) to the list of URLs to fetch. Returns a WWW::Curl::Simple::Request object. .SS "register($req)" .IX Subsection "register($req)" An alias for \f(CW\*(C`add_request\*(C'\fR. .ie n .SS "has_request $request" .el .SS "has_request \f(CW$request\fP" .IX Subsection "has_request $request" Will return true if \f(CW$request\fR is one of the object's requests. .ie n .SS "delete_request $req" .el .SS "delete_request \f(CW$req\fP" .IX Subsection "delete_request $req" Removes \f(CW$req\fR from the object's list of requests. .SS "perform" .IX Subsection "perform" Does all the requests added with \f(CW\*(C`add_request\*(C'\fR and returns a list of WWW::Curl::Simple::Request objects. .SS "wait" .IX Subsection "wait" This method is here to provide an easier transition from LWP::Parallel::UserAgent. It is by no means a drop in replacement, but using \&\f(CW\*(C`wait\*(C'\fR instead of \f(CW\*(C`perform\*(C'\fR makes the return value more like that of \s-1LWP::UA.\s0 .SH "AUTHOR" .IX Header "AUTHOR" Andreas Marienborg .SH "CONTRIBUTORS" .IX Header "CONTRIBUTORS" .IP "\(bu" 4 Bjørn\-Olav Strand .IP "\(bu" 4 Graham Knop .IP "\(bu" 4 Marcus Ramberg .IP "\(bu" 4 Neil Bowers .IP "\(bu" 4 chromatic .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2013 by Andreas Marienborg. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.