Go to the source code of this file.
Data Structures | |
struct | RGMAResourceEndpoint |
struct | RGMAException |
struct | RGMAStorageLocation |
struct | RGMAStringList |
struct | RGMARow |
struct | RGMAResultSet |
struct | RGMATupleStore |
struct | RGMATupleStoreList |
struct | RGMAProducerTableEntry |
struct | RGMAProducerTableEntryList |
struct | RGMAIndex |
struct | RGMAIndexList |
struct | RGMAColumnDefinition |
struct | RGMATableDefinition |
struct | RGMAException_S |
struct | RGMAStorageLocation_S |
struct | RGMAResultSet_S |
struct | RGMATableAuthorization_S |
Typedefs | |
typedef RGMAResource_S | RGMAResource |
typedef RGMAException_S | RGMAException |
typedef RGMAStorageLocation_S | RGMAStorageLocation |
typedef RGMAResultSet_S | RGMAResultSet |
typedef RGMATableAuthorization_S | RGMATableAuthorization |
Functions | |
int | RGMA_createConsumer (int terminationInterval, const char *selectStatement, int queryType, int timeInterval, RGMAResource **resourcePP) |
int | RGMA_createPrimaryProducer (int terminationInterval, int properties, int storageType, RGMAStorageLocation *storageLocation, RGMAResource **resourcePP) |
int | RGMA_createSecondaryProducer (int terminationInterval, int properties, int storageType, RGMAStorageLocation *storageLocation, RGMAResource **resourcePP) |
int | RGMA_createOnDemandProducer (int terminationInterval, const char *uri, RGMAResource **resourcePP) |
int | RGMA_reconnect (RGMAResourceEndpoint *endpointP, int resourceType, RGMAResource **resourcePP) |
int | RGMAPrimaryProducer_declareTable (RGMAResource *resourceP, const char *tableName, const char *predicate, int hrpSec, int lrpSec) |
int | RGMAPrimaryProducer_insert (RGMAResource *resourceP, const char *insertStatement, int lrpSec) |
int | RGMAPrimaryProducer_insertList (RGMAResource *resourceP, int numInserts, char **insertStatements, int lrpSec) |
RGMATupleStoreList * | RGMAPrimaryProducer_listTupleStores (RGMAException *exceptionP) |
int | RGMAPrimaryProducer_dropTupleStore (const char *logicalName, RGMAException *exceptionP) |
int | RGMAPrimaryProducer_getHistoryRetentionPeriod (RGMAResource *resourceP, const char *tableName) |
int | RGMAPrimaryProducer_getLatestRetentionPeriod (RGMAResource *resourceP, const char *tableName) |
int | RGMASecondaryProducer_declareTable (RGMAResource *resourceP, const char *tableName, const char *predicate, int hrpSec) |
RGMATupleStoreList * | RGMASecondaryProducer_listTupleStores (RGMAException *exceptionP) |
int | RGMASecondaryProducer_dropTupleStore (const char *logicalName, RGMAException *exceptionP) |
int | RGMASecondaryProducer_getHistoryRetentionPeriod (RGMAResource *resourceP, const char *tableName) |
int | RGMAOnDemandProducer_declareStaticTable (RGMAResource *resourceP, const char *tableName, const char *predicate) |
int | RGMAConsumer_start (RGMAResource *resourceP, int timeoutSec) |
int | RGMAConsumer_startDirected (RGMAResource *resourceP, int timeoutSec, int numProducers, RGMAResourceEndpoint *producers) |
int | RGMAConsumer_abort (RGMAResource *resourceP) |
int | RGMAConsumer_hasAborted (RGMAResource *resourceP) |
RGMAResultSet * | RGMAConsumer_pop (RGMAResource *resourceP, int maxCount) |
int | RGMA_getTerminationInterval (RGMAResource *resourceP) |
int | RGMA_showSignOfLife (RGMAResource *resourceP) |
int | RGMA_close (RGMAResource *resourceP) |
int | RGMA_destroy (RGMAResource *resourceP) |
int | RGMARegistry_createRegistry (const char *vdbName, const char *registryService, RGMAException *exceptionP) |
int | RGMARegistry_destroyRegistry (const char *vdbName, const char *registryService, RGMAException *exceptionP) |
RGMAProducerTableEntryList * | RGMARegistry_getAllProducersForTable (const char *vdbName, const char *tableName, RGMAException *exceptionP) |
int | RGMASchema_createSchema (const char *vdbName, const char *schemaService, RGMAException *exceptionP) |
int | RGMASchema_destroySchema (const char *vdbName, const char *schemaService, RGMAException *exceptionP) |
int | RGMASchema_createTable (const char *vdbName, const char *createTableStatement, int numRules, char **rules, RGMAException *exceptionP) |
int | RGMASchema_dropTable (const char *vdbName, const char *tableName, RGMAException *exceptionP) |
int | RGMASchema_createIndex (const char *vdbName, const char *createIndexStatement, RGMAException *exceptionP) |
int | RGMASchema_dropIndex (const char *vdbName, const char *indexName, RGMAException *exceptionP) |
int | RGMASchema_createView (const char *vdbName, const char *createViewStatement, int numRules, char **rules, RGMAException *exceptionP) |
int | RGMASchema_dropView (const char *vdbName, const char *viewName, RGMAException *exceptionP) |
RGMAStringList * | RGMASchema_getAllTables (const char *vdbName, RGMAException *exceptionP) |
RGMATableDefinition * | RGMASchema_getTableDefinition (const char *vdbName, const char *tableName, RGMAException *exceptionP) |
RGMAIndexList * | RGMASchema_getTableIndexes (const char *vdbName, const char *tableName, RGMAException *exceptionP) |
int | RGMASchema_setAuthorizationRules (const char *vdbName, const char *tableName, int numRules, char **rules, RGMAException *exceptionP) |
RGMAStringList * | RGMASchema_getAuthorizationRules (const char *vdbName, const char *tableName, RGMAException *exceptionP) |
int | RGMA_setProperty (int service, const char *name, const char *parameter, const char *value, RGMAException *exceptionP) |
char * | RGMA_getProperty (int service, const char *name, const char *parameter, RGMAException *exceptionP) |
char * | RGMA_getVersion (int service, RGMAException *exceptionP) |
RGMAResourceEndpoint * | RGMA_getEndpoint (RGMAResource *resourceP) |
const RGMAException * | RGMA_getException (RGMAResource *resourceP) |
char * | RGMA_getResultSetValue (RGMAResultSet *rs, int rowNum, int colNum, const char *colName) |
void | RGMA_printResultSet (FILE *stream, RGMAResultSet *rs) |
void | RGMA_freeResource (RGMAResource *resourceP) |
void | RGMA_freeEndpoint (RGMAResourceEndpoint *endpointP) |
void | RGMA_freeException (RGMAException *exceptionP) |
void | RGMA_freeStringList (RGMAStringList *stringListP) |
void | RGMA_freeResultSet (RGMAResultSet *resultSetP) |
void | RGMA_freeTupleStoreList (RGMATupleStoreList *tupleStoreListP) |
void | RGMA_freeProducerTableEntryList (RGMAProducerTableEntryList *producerTableEntryListP) |
void | RGMA_freeIndexList (RGMAIndexList *indexListP) |
void | RGMA_freeTableDefinition (RGMATableDefinition *tableDefinitionP) |
int | RGMA_createPrimaryProducer (int terminationInterval, int properties, int storageType, RGMAStorageLocation *storageLocation, int numVOs, char **voNames, RGMAResource **resourcePP) |
int | RGMA_createSecondaryProducer (int terminationInterval, int properties, int storageType, RGMAStorageLocation *storageLocation, int numVOs, char **voNames, RGMAResource **resourcePP) |
int | RGMA_createOnDemandProducer (int terminationInterval, const char *uri, int numVOs, char **voNames, RGMAResource **resourcePP) |
int | RGMAPrimaryProducer_insert (RGMAResource *resourceP, const char *insertStatement) |
int | RGMAPrimaryProducer_insertList (RGMAResource *resourceP, int numInserts, char **insertStatements) |
int | RGMAConsumer_isExecuting (RGMAResource *resourceP) |
int | RGMAConsumer_count (RGMAResource *resourceP) |
|
The RGMAResource structure represents a single producer or consumer resource, and holds all API settings related to the resource. This includes the resource-endpoint, the handle to the gSOAP environment, the resource type and any errors associated with the resource. It is an opaque structure and you are not expected to read or change its contents. You should free it when no longer required by calling RGMA_freeResource. |
|
|
|
|
|
|
|
|
|
Creates a new Consumer resource. Extracts the URL of the Consumer Service from the R-GMA configuration file $RGMA_HOME/etc/rgma/rgma.conf. Both the environment variable, and the file, must exist. Continuous, latest and history queries may optionally take a time interval to limit the age of tuples returned. This is indicated by combining the query type with the RGMAQueryType_INTERVAL qualifier, for example: (RGMAQueryType_CONTINUOUS | RGMAQueryType_INTERVAL).
|
|
Creates a new Primary Producer resource. Extracts the URL of the Primary Producer Service from the R-GMA configuration file $RGMA_HOME/etc/rgma/rgma.conf. Both the environment variable, and the file, must exist.
|
|
Creates a new Secondary Producer resource. Extracts the URL of the Secondary Producer Service from the R-GMA configuration file $RGMA_HOME/etc/rgma/rgma.conf. Both the environment variable, and the file, must exist.
|
|
Creates a new On-demand Producer resource. Extracts the URL of the On-demand Producer Service from the R-GMA configuration file $RGMA_HOME/etc/rgma/rgma.conf. Both the environment variable, and the file, must exist.
|
|
Re-connects the API to the remote resource at a given resource-endpoint, i.e. it creates and initialises a local resource structure to interface to the given resource-endpoint. Does not contact the server - you should call RGMA_showSignOfLife() after reconnect() if you want to keep the resource alive. This function is useful to re-attach to a remote resource following termination of the program that originally it. The behviour of the system is undefined if you make multiple connections to the same resource.
|
|
Registers a Primary Producer in the Registry, as a producer for the specified table.
|
|
Publishes data for a single tuple (row) into a table, using an SQL INSERT statement.
|
|
Publishes data for multiple tuples (rows) into a table, using SQL INSERT statements.
|
|
Returns a list of names and database parameters of all permanent tuple stores belonging to the user (or all tuple stores in the service if it is running insecurely). You should free the list when no longer required, by calling RGMA_freeTupleStoreList().
|
|
Drops one of user's permanent tuple stores. Tuple stores that are currently being used by a producer cannot be dropped.
|
|
Queries Primary Producer's retention period for history tuples in specified table.
|
|
Queries Primary Producer's retention period for latest tuples in specified table.
|
|
Registers a Secondary Producer in the Registry, as a producer for the specified table.
|
|
Returns a list of names and database parameters of all permanent tuple stores belonging to the user (or all tuple stores in the service if it is running insecurely). You should free the list when no longer required, by calling RGMA_freeTupleStoreList().
|
|
Drops one of user's permanent tuple stores. Tuple stores that are currently being used by a producer cannot be dropped.
|
|
Queries Secondary Producer's retention period for history tuples in specified table.
|
|
Registers an On-demand Producer in the Registry, as a producer for the specified static table. A static table only supports static queries and has no time-stamps associated with its tuples.
|
|
Starts this consumer's query, using the mediator to find relevant producers to contact. The query will automatically abort after the specified time interval. You cannot prevent the query from timing out, but you can set a very large time interval. The query is run asynchronously. You should keep poping tuples from the consumer by calling RGMAConsumer_pop() repeatedly until it returns a result set with its endOfResults flag set to 1 (true). You can stop a query's execution by calling RGMAConsumer_abort(). Any un-popped tuples will be lost if a query is restarted.
|
|
Starts this consumer's query, contacting all producers in a list provided by the user. In all other respects, this function is identical to RGMAConsumer_start(). Since the mediator is not used, it is up to the user to ensure that the producers in the list can, taken together, give a complete and correct answer to the query.
|
|
Aborts a running query, after a call to start() or startDirected()). Does nothing if the query has already finished. Any tuples which had already been delivered to the consumer service may still be retrieved via pop.
|
|
Determines whether a Consumer's query has aborted (either following a call to abort(), or because its query has timed out). Note that as this involves a remote call, you should be careful to check for errors.
|
|
Retrieves at most maxCount tuples from a Consumer which have been returned by producers. The returned list will be empty if there are no tuples currently available. The final result set for a query will have its endOfResults flag set to 1 (true). You should free the result set when no longer required, by calling RGMA_freeResultSet().
|
|
Queries the termination interval for a resource.
|
|
Indicates to a service that a resource should be kept alive. This method should be called periodically if there is no other contact with the resource through another API function.
|
|
Schedules a (remote) resource for destruction. The resource will no longer be available through this API and will be destroyed by the service once it has finished interacting with other components. You should also free up any local memory associated with the resource using RGMA_freeResource().
|
|
Destroys a (remote) resource immediately. The resource will no longer be available to any component. You should also free up any local memory associated with the resource by calling RGMA_freeResource().
|
|
Creates a new instance (replica) of a Registry for a specified virtual database in a Registry Service. This function would only normally be used by system administrators.
|
|
Destroys an instance (replica) of a Registry of a specified virtual database from a Registry Service. The Registry database is wiped. This function would only normally be used by system administrators.
|
|
Returns details of all producers that are registered for a specified table in a specified virtual database.
|
|
Creates a new instance (replica) of a Schema for a specified virtual database in a Schema Service. This function would only normally be used by system administrators.
|
|
Destroys an instance (replica) of a Schema of a specified virtual database from a Schema Service. The Schema database is wiped. This function would only normally be used by system administrators.
|
|
Creates a new table in the schema of a specified virtual database. The table name, column names and column types must conform to the rules in the User Guide. A set of initial authorization rules for the table may also be specified. The format of the rules is described in the User Guide.
|
|
Drops a table from the schema of a specified virtual database.
|
|
Creates a new index definition for a table in the schema of a specified virtual database. The index name and index definition must conform to the rules in the User Guide.
|
|
Drops an index from the schema of a specified virtual database.
|
|
Creates a new view in the schema of a specified virtual database. The view name and view definition must conform to the rules in the User Guide. A set of initial authorization rules for the view may also be specified. The format of the rules is described in the User Guide.
|
|
Drops a view from the schema of a specified virtual database.
|
|
Returns a list of all tables and views in the schema of a specified virtual database. You should free the list returned by calling RGMA_freeStringList when it is no longer required.
|
|
Returns the column definitions of a table or view in the schema of a specified virtual database. You should free the structure returned by calling RGMA_freeTableDefinition when it is no longer required.
|
|
Returns the list of indexes defined on a table in the schema of a specified virtual database. You should free the list returned by calling RGMA_freeIndexList when it is no longer required.
|
|
Replaces the authorization rules on a table or view in the schema of a specified virtual database. The format of the rules is described in the User Guide.
|
|
Returns the authorization rules on a table or view in the schema of a specified virtual database. The format of the rules is described in the User Guide. You should free the list returned by calling RGMA_freeStringList when it is no longer required.
|
|
Sets the value of a service property - see the User Guide for a list of properties that can be set.
|
|
Returns the value of a service property - see the User Guide for a list of properties that can be queried and the values that they return. You should free the string returned (by calling free()) when it is no longer required.
|
|
Returns a string representing the version number of an R-GMA service. You should free the string returned (by calling free()) when it is no longer required.
|
|
Gets the resource-endpoint (URL and id) for a resource, in an RGMAResourceEndpoint structure. You should free the memory associated with it (using RGMA_freeEndpoint()) when you are done with it.
|
|
Returns a pointer to the most recent exception which occurred in a given resource. The pointer is only valid until the resource is freed.
|
|
Convenience function: returns a pointer to the requested value (as a string) from a result set. You must specify a row number and either a column name or column number (if you specify both, the column name will be used).
|
|
Convenience function: prints the contents of a result set to a file stream. If you don't specify a stream (i.e. pass NULL), stderr will be used.
|
|
Frees all memory associated with an RGMAResource structure, but leaves the remote resource intact. If the API never re-connects to the remote resource, it will continue to exist and operate until it exceeds its termination interval.
|
|
Frees all memory associated with an RGMAResourceEndpoint structure.
|
|
Frees all memory contained within an RGMAException structure (but does not free the exception structure itself). Note that if an API call succeeds, no exception will be written by the API and you should not call this function.
|
|
Frees all memory associated with an RGMAStringList structure.
|
|
Frees all memory associated with an RGMAResultSet structure.
|
|
Frees all memory associated with an RGMATupleStoreList structure.
|
|
Frees all memory associated with an RGMAProducerTableEntryList structure.
|
|
Frees all memory associated with an RGMAIndexList structure.
|
|
Frees all memory associated with an RGMATableDefinition structure.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|