File: xml.rpc.Rd

package info (click to toggle)
r-omegahat-xmlrpc 0.3-0-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 92 kB
  • sloc: xml: 28; makefile: 2
file content (87 lines) | stat: -rw-r--r-- 3,445 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
\name{xml.rpc}
\alias{xml.rpc}
\title{Invoke XML-RPC method from R}
\description{
 This function can be used to invoke a method provided by an XML-RPC
 (remote procedure call) server.
 It can pass R objects in the request by serializing them to XML format
 and also converts the result back to R.
}
\usage{
xml.rpc(url, method, ..., .args = list(...), .opts = list(),
        .defaultOpts = list(httpheader = c("Content-Type" = "text/xml"),
                            followlocation = TRUE,
                            useragent = useragent),
         .convert = TRUE, .curl = getCurlHandle(),
          useragent = "R-XMLRPC")
}
%- maybe also 'usage' for other objects documented here.
\arguments{
  \item{url}{the URL of the XML-RPC server}
  \item{method}{a string giving the name of the XML-RPC method to invoke}
  \item{\dots}{a collection of argument valuesn}
  \item{.args}{an alternative way to specify the collection (list) of arguments}
  \item{.opts}{a list of options passed on to
    \code{\link[RCurl]{postForm}}. This is for the caller to specify
     server-specific curl options as opposed to general XML-RPC options
     which are set via \code{.defaultOpts}.
    }
  \item{.defaultOpts}{standard/default RCurl options used when making
    this call}
  \item{.convert}{either a logical value indicating whether to perform
    the defalt conversion (via \code{convertToR}) or not,
    or alternatively a function which  is called with a string
    giving the body of the HTTP response of the XML-RPC call.}
  \item{.curl}{a CURLHandle object that the caller can specify to allow
    reusing existing handles and connections. This can greatly improve
    efficiency.}
  \item{useragent}{the string identifying the application that is
    reported to the Web server as making the request.}
}

\value{
  If \code{.convert} is a logical value and \code{TRUE},  an R object
  giving the result of the XML-RPC method invocation. If \code{.convert}
  is \code{FALSE}, a string giving the body of the response.

  If \code{.convert} is a function, it is called with the body of the
  XML-RPC response as a string.
}
\references{\url{http://www.xmlrpc.com/spec}
 \url{http://www.cafeconleche.org/books/xmljava/chapters/ch02s05.html}
  for a DTD for XML-RPC and examples and discussion.
}
\author{Duncan Temple Lang }

\seealso{
  \code{\link[RCurl]{postForm}}
  \code{\link[RCurl]{getURL}} and REST Web services
  \code{SSOAP} package.
}
\examples{
 # See http://www.advogato.org/xmlrpc.html

xml.rpc('http://www.advogato.org/XMLRPC', 'test.square', 9L)
xml.rpc('http://www.advogato.org/XMLRPC', 'test.sumprod', 9L, 10L)
xml.rpc('http://www.advogato.org/XMLRPC', 'test.strlen', 'abcdef')
xml.rpc('http://www.advogato.org/XMLRPC', 'test.capitalize', 'abcdef')

xml.rpc('http://www.advogato.org/XMLRPC', 'user.exists', 'duncan')
xml.rpc('http://www.advogato.org/XMLRPC', 'cert.get', 'duncan')

xml.rpc('http://www.advogato.org/XMLRPC', 'diary.len', 'duncan')
xml.rpc('http://www.advogato.org/XMLRPC', 'diary.get', 'duncan', 1L)
xml.rpc('http://www.advogato.org/XMLRPC', 'diary.getDates', 'duncan', 4L)


xml.rpc("http://xmlrpc-c.sourceforge.net/api/sample.php", "sample.sumAndDifference", 3L, 4L)

# Doesn't work
#  xml.rpc('http://ws2.webservices.nl', 'system.methodHelp', 'addressReeksPostcodeSearch')

# xml.rpc('http://www.cookcomputing.com/xmlrpcsamples/RPC2.ashx', 'example.getStateName', 2L)


}
\keyword{IO}
\keyword{programming}