BaseXSession: Client Interface To the BaseX Server
In dnusinow/BaseXClient: Client to access the BaseX XML Database

Description Usage Arguments Details Value Author(s) Examples

BaseXSession generates an object that can be used to send commands, queries, and data to a BaseX server. The object implements the standard client interface used to access BaseX by other languages.

1	BaseXSession(user, pass, host = "localhost", port = 1984, ...)

user

The BaseX username

pass

The BaseX user's password

host

The URL to access the BaseX server

port

What port the BaseX server is listening on

...

Any additional arguments. Passed to superclass constructor

BaseXSession will attempt to connect to the BaseX server and if it succeeds it will return a BaseXSession object that can be used to interact with the server over that connection.

A BaseXSession object that has methods to interact with the server. Internally, this is implemented as a reference object (rather than the more common S3 and S4 objects) and so has certain distinctive properties. Because the connection to the server is stateful, the object uses call by reference rather than by value. This means that writing functional code that returns the BaseXSession object is not necessary and you can simply keep making method calls on the same object.

David Nusinow <david@gravitypulls.net>

##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--	or do  help(data=index)  for the standard data sets.

## The function is currently defined as
structure(function (...) 
new("BaseXSession", ...), className = structure("BaseXSession", package = "BaseXClient"), package = "BaseXClient", generator = <S4 object of class structure("refGeneratorSlot", package = "methods")>, class = structure("refObjectGenerator", package = "methods"))