| 1 |
\name{MultiCURLHandle-class} |
| 2 |
\docType{class} |
| 3 |
\alias{MultiCURLHandle-class} |
| 4 |
\alias{pop} |
| 5 |
\alias{push} |
| 6 |
\alias{pop,MultiCURLHandle,CURLHandle-method} |
| 7 |
\alias{pop,MultiCURLHandle,character-method} |
| 8 |
\alias{push,MultiCURLHandle,CURLHandle-method} |
| 9 |
|
| 10 |
\title{Class "MultiCURLHandle" for asynchronous, concurrent HTTP requests} |
| 11 |
\description{ |
| 12 |
This is a class that represents a handle to an internal |
| 13 |
C-level data structure provided by libcurl to |
| 14 |
perform multiple HTTP requests in a single operation |
| 15 |
and process the responses in an inter-leaved fashion, |
| 16 |
i.e. a chunk from one, followed by a chunk from another. |
| 17 |
|
| 18 |
Objects of this class contain not only a reference to the |
| 19 |
internal C-level data structure, but also have a list |
| 20 |
of the \code{\link{CURLHandle-class}} objects |
| 21 |
that represent the individual HTTP requests that make up |
| 22 |
the collection of concurrent requests. |
| 23 |
These are maintained for garbage collection reasons. |
| 24 |
|
| 25 |
Essentially, the data in objects of this class are for internal use; |
| 26 |
this is an opaque class in R. |
| 27 |
} |
| 28 |
\section{Objects from the Class}{ |
| 29 |
The constructor function \code{\link{getCurlMultiHandle}} |
| 30 |
is the only way to create meaningful instances of this class. |
| 31 |
} |
| 32 |
\section{Slots}{ |
| 33 |
\describe{ |
| 34 |
\item{\code{ref}:}{Object of class \code{"externalptr"}. This is |
| 35 |
a reference to the instance of the libcurl data structure |
| 36 |
\code{CURLM} pointer. |
| 37 |
} |
| 38 |
\item{\code{subhandles}:}{Object of class \code{"list"}. |
| 39 |
This is a list of \code{\link{CURLHandle-class}} |
| 40 |
instances that have been \code{push()}ed onto the |
| 41 |
multi-handle stack. |
| 42 |
} |
| 43 |
} |
| 44 |
} |
| 45 |
\section{Methods}{ |
| 46 |
\describe{ |
| 47 |
\item{pop}{\code{signature(obj = "MultiCURLHandle", val = "CURLHandle")}: ... } |
| 48 |
\item{pop}{\code{signature(obj = "MultiCURLHandle", val = "character")}: ... } |
| 49 |
\item{push}{\code{signature(obj = "MultiCURLHandle", val = "CURLHandle")}: ... } |
| 50 |
} |
| 51 |
} |
| 52 |
|
| 53 |
\references{Curl homepage \url{https://curl.se/}} |
| 54 |
\author{Duncan Temple Lang} |
| 55 |
\seealso{ |
| 56 |
\code{\link{getCurlMultiHandle}} |
| 57 |
\code{\link{curlMultiPerform}} |
| 58 |
\code{\link{multiTextGatherer}} |
| 59 |
} |
| 60 |
%\examples{} |
| 61 |
\keyword{classes} |