xmlrpc: Call the Remote Procedure

View source: R/xmlrpc2.R

xmlrpcR Documentation

Call the Remote Procedure

Description

Call a reomte procedure with the XML-RPC protocol.

Usage

xmlrpc(
  url,
  method,
  params = list(),
  handle = NULL,
  opts = list(),
  convert = TRUE,
  useragent = "xmlrpc",
  raise_error = TRUE
)

Arguments

url

a character string giving the url to the server.

method

a character string giving the name of the method to be invoked.

params

a list containing the parmeters which are added to the XML file sent via the remote procedure call.

handle

a object of class "curl_handle".

opts

a list of options passed to the function "handle_setopt".

convert

a logical, if convert is TRUE (default) the curl response is converted else it is left unchanged.

useragent

a character string giving the name of the "User-Agent".

raise_error

a logical controling the behavior if the status code of curl_fetch_memory signals an error. If raise_error is TRUE an error is raised, if raise_error is FALSE no error is raised and an object inheriting from c("fetch_error", error")} is returned. This object is the return value from \code{curl_fetch_memory} where just the class \code{c("fetch_error", error") is added.

Value

the reponse of curl or the response converted to R objects.

Examples

## Not run: 
url <- "https://www.neos-server.org"
xmlrpc(url, "listAllSolvers")
xmlrpc(url, "listSolversInCategory", params = list(category = "socp"))

## End(Not run)


xmlrpc2 documentation built on June 8, 2025, 10:46 a.m.