Handshake: Make a "handshake" with the server to figure out which API to...

View source: R/internal.R

HandshakeR Documentation

Make a "handshake" with the server to figure out which API to use. When this function returns value "retval": - attr(retval, "connection")$scidb.version will be the server version - class(retval) will be the correct class to handle API calls - Other fields on retval and attr(retval, "connection") will contain necessary information for the subclass to talk to the server - All other fields are inherited from the input argument "db".

Description

Make a "handshake" with the server to figure out which API to use. When this function returns value "retval": - attr(retval, "connection")$scidb.version will be the server version - class(retval) will be the correct class to handle API calls - Other fields on retval and attr(retval, "connection") will contain necessary information for the subclass to talk to the server - All other fields are inherited from the input argument "db".

Usage

Handshake(db)

Arguments

db

a scidb database connection from scidbconnect

Value

db with modifications reflecting information from the handshake


Paradigm4/SciDBR documentation built on Nov. 9, 2023, 4:58 a.m.