R/getURLWithRetries.R
In Sage-Bionetworks/rSynapseClient: Synapse R Client from Sage Bionetworks
# execute web request with exponential back-off for failures
#
# returned value is list(body=<body>, parsedHeaders=list(statusCode, statusString, headers))
getURLWithRetries<-function(url,
postfields = NULL, # the request body
customrequest="GET", # the request method
httpheader=NULL, # the headers
curl=getCurlHandle(), # the curl handle
debugfunction = NULL,
opts,
logErrorsToSynapse=TRUE,
extraRetryStatusCodes=NULL
) {
# result has the form list(result=list(headers,body), httpStatus=<status>)
result<-webRequestWithRetries(
fcn=function(curlHandle) {
if (is.null(postfields)) {
.getURLIntern(url,
customrequest=customrequest,
httpheader=httpheader,
curl=curlHandle,
debugfunction=debugfunction,
.opts=opts
)
} else {
.getURLIntern(url,
postfields=postfields,
customrequest=customrequest,
httpheader=httpheader,
curl=curlHandle,
debugfunction=debugfunction,
.opts=opts
)
}
# returns list(headers,body)
},
curlHandle=curl,
extraRetryStatusCodes=extraRetryStatusCodes,
logErrorsToSynapse
)
parsedHeaders<-parseHttpHeaders(result$result$headers)
list(body=result$result$body, parsedHeaders=parsedHeaders)
}
# this is added for unit testing purposes, providing a function to override
# returned value is list(headers, body), neither headers nor body have been parsed
.getURLIntern<-function(url,
postfields,
customrequest,
httpheader,
curl,
debugfunction,
.opts
) {
if(!is.null(.getCache("debug")) && .getCache("debug")) {
message(".getURLIntern: url:", url)
}
h = basicTextGatherer()
if (missing(postfields)) {
body<-getURL(url=url,
customrequest=customrequest,
httpheader=httpheader,
curl=curl,
debugfunction=debugfunction,
headerfunction=h$update,
.opts=.opts
)
} else {
body<-getURL(url=url,
postfields=postfields,
customrequest=customrequest,
httpheader=httpheader,
curl=curl,
debugfunction=debugfunction,
headerfunction=h$update,
.opts=.opts
)
}
list(headers=h$value(), body=body)
}
# this is added for unit testing purposes, providing a function to override
.getCurlInfo<-function(curlHandle) {
getCurlInfo(curlHandle)
}
Sage-Bionetworks/rSynapseClient documentation built on May 9, 2019, 7:04 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
# execute web request with exponential back-off for failures
#
# returned value is list(body=<body>, parsedHeaders=list(statusCode, statusString, headers))
getURLWithRetries<-function(url,
postfields = NULL, # the request body
customrequest="GET", # the request method
httpheader=NULL, # the headers
curl=getCurlHandle(), # the curl handle
debugfunction = NULL,
opts,
logErrorsToSynapse=TRUE,
extraRetryStatusCodes=NULL
) {
# result has the form list(result=list(headers,body), httpStatus=<status>)
result<-webRequestWithRetries(
fcn=function(curlHandle) {
if (is.null(postfields)) {
.getURLIntern(url,
customrequest=customrequest,
httpheader=httpheader,
curl=curlHandle,
debugfunction=debugfunction,
.opts=opts
)
} else {
.getURLIntern(url,
postfields=postfields,
customrequest=customrequest,
httpheader=httpheader,
curl=curlHandle,
debugfunction=debugfunction,
.opts=opts
)
}
# returns list(headers,body)
},
curlHandle=curl,
extraRetryStatusCodes=extraRetryStatusCodes,
logErrorsToSynapse
)
parsedHeaders<-parseHttpHeaders(result$result$headers)
list(body=result$result$body, parsedHeaders=parsedHeaders)
}
# this is added for unit testing purposes, providing a function to override
# returned value is list(headers, body), neither headers nor body have been parsed
.getURLIntern<-function(url,
postfields,
customrequest,
httpheader,
curl,
debugfunction,
.opts
) {
if(!is.null(.getCache("debug")) && .getCache("debug")) {
message(".getURLIntern: url:", url)
}
h = basicTextGatherer()
if (missing(postfields)) {
body<-getURL(url=url,
customrequest=customrequest,
httpheader=httpheader,
curl=curl,
debugfunction=debugfunction,
headerfunction=h$update,
.opts=.opts
)
} else {
body<-getURL(url=url,
postfields=postfields,
customrequest=customrequest,
httpheader=httpheader,
curl=curl,
debugfunction=debugfunction,
headerfunction=h$update,
.opts=.opts
)
}
list(headers=h$value(), body=body)
}
# this is added for unit testing purposes, providing a function to override
.getCurlInfo<-function(curlHandle) {
getCurlInfo(curlHandle)
}
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.