fameConnection: Fame 'master/dbback' server connection

In fame: Interface for FAME Time Series Database

Description

Creates a connection to a Fame service running on a remote host.

Usage

fameConnection(service = "", host = "", user = "", password = "", stopOnFail = TRUE)
## S3 method for class 'fameConnection'
print(x, ...)
## S3 method for class 'fameConnection'
close(con, ...)

Arguments

service	The name of the service on the server, e.g., "someService"
host	The server name
user	User name on the server
password	A string
stopOnFail	if TRUE (the default), failing to connect generates an R error. Otherwise, the function completes but the result is kind of useless.
x	A fameConnection
con	A fameConnection
...	For print, these are arguments passed on to print.matrix. For close, they're ignored.

Details

fameConnection uses the C HLI function cfmopen to create a connection to a Fame service. The connection it returns can be used in subsequent calls to fameWildlist or getfame.

The print and close functions, when called on a fameConnection, do what they say.

Value

A fameConnection is an integer with attributes "service", "host", "user" and "password".

Note

These functions have not really been tested at all, as the package maintainer does not have ready access to a Fame server.

See Also

getfame, fameWildlist

fame documentation built on Nov. 6, 2021, 1:06 a.m.