rneos (version 0.4-0)

CreateNeosComm: Creating an object for communications with NEOS

Description

This function creates an object of class NeosComm that will contain all necessary information for dealing with HTTP requests to NEOS. This object will be needed in all requests to NEOS and hence must be created in advance of XML-RPC requests.

Usage

CreateNeosComm(curlopts = list(httpheader = c(`Content-Type` =
"text/xml", `User-Agent` = "R"), port = 3333), curlhandle =
getCurlHandle())

Arguments

curlopts

A named list of elements that are passed as options to curl. By default, the httpheader and the port options are preset.

curlhandle

An object of class CURLHandle. By default the returned object of getCurlHandle() is employed.

Value

An object of class NeosComm.

Details

A list of valid curl options can be retrieved from listCurlOptions(). Please note, that the relevant HTTP-bodies within the requests will be created directly in the API-functions provided in this package and must not be provided as list elements in curloptions. However, if one accesses NEOS via a Proxy-Server, for instance, than the values for the relevant options must be set within the list-argument curlopts. The values of the returned object will be passed down to the function xml.rpc() which is utilised for all calls to the function Nfoo contained in this package. Hereby, foo signify the name of NEOS-API.

References

NEOS API: https://neos-server.org/neos/xml-rpc.html

See Also

'>NeosComm

Examples

# NOT RUN {
nc <- CreateNeosComm()
nc
# }