Database Functions

The following functions manipulate GDBM databases.

PUBLIC void db_openRead(char *filename, Database *db, DbBuilder builder, mode_t mode)

Opens a database for reading.

• filename is the name of the file containing the GDBM database.
• db is the GDBM database.
• builder is a function to invoke if the database needs to be built.
• mode is the optional mode to use if the GDBM database created.

No return value.

PUBLIC void db_openWrite(char *filename, Database *db, DbBuilder builder, mode_t mode)

• filename is the name of the file containing the GDBM database.
• db is the GDBM database.
• builder is a function to invoke if the database needs to be built.
• mode is the optional mode to use if the GDBM database created.

No return value.

PUBLIC void db_reopenRead(Database *db)

Reopens a database in read mode.

• db is the GDBM database.

No return value.

PUBLIC void db_reopenWrite(Database *db)

Reopens a database in write mode.

• db is the GDBM database.

No return value.

PUBLIC void db_close(Database *db)

Closes a database.

• db is the GDBM database.

No return value.

PUBLIC time_t db_getAccessTime(Database *db, char *obj)

Returns the time that an object in the database was last accessed by a particular client and user. The information is stored under the tuple <ClientHost, User, Object>.

• db is the GDBM database.
• obj is the object's name.

Returns the access time for the object, or 0 if the the object is not found in the database.

PUBLIC void db_setAccessTime(Database *db, char *obj, time_t stamp)

Sets the time that an object in the database was last accessed by a particular client and user. The information is stored under the tuple <ClientHost, User, Object>.

• db is the GDBM database.
• obj is the object's name.
• stamp is the object's new access time.

No return value.

PUBLIC char *db_getUID(Database *db, char *template)

Generates a unique object identifier.

• db is the GDBM database.
• template is the format string used to generate unique names; it should contain single %ld within the format.

Returns a newly allocated string containing a unique object identifier. The caller is responsible for freeing the string.

Log Manipulation Functions

All the following functions manipulate the operation log for a particular object.

PUBLIC void log_add(Database *db, char *obj, time_t stamp, char *host, int logID, HTOpStatus status, char *operation, int opsize)

Adds a log record to an object in the data base.

PUBLIC void log_clean(Database *db, char *obj, LogCleaner cleaner)

Clean the log records for an object in the database.

• db is the GDBM database.
• obj is the object's name.
• cleaner is the the function to invoke with each log record.

No return value.

PUBLIC void log_flush(Database *db)

Flush out all log information and log records.

• db is the GDBM database.

No return value.

PUBLIC void log_info(Database *db, char *obj, time_t *start, time_t *end, int *size, time_t *time)

Return information about an object's log records.

• db is the GDBM database.
• obj is the object's name.
• The function sets start to the number of the object's first log record.
• The function sets end to the number of the object's last log record.
• The function sets size to the number of log records for the object.
• The function sets time to the time of the object's last log record.

Returns -1, if no log information is found for the object. Otherwise, returns 1.

PUBLIC int log_outstrSuffix(Log *log)

Given a log record, output it as a log suffix record.

• db is the GDBM database.
• log is the log record.

Returns 1.

PUBLIC void log_purge(Database *db, char *obj)

Purge the log records for an object.

• db is the GDBM database.
• obj is the object's name.

No return value.

PUBLIC void log_purgeAll(Database *db)

Purge the log records for all objects in the database.

• db is the GDBM database.

No return value.

PUBLIC void log_print(Database *db, char *obj, LogPrinter printer, FILE *file)

Print the log records for an object in the database.

• db is the GDBM database.
• obj is the object's name.
• printer is the function to invoke with each log record.
• file is the file pointer to write each log record to.

No return value.

PUBLIC Log *log_search(Database *db, char *obj, char *host, int logID)

Search for a matching log record for an object in the database.

• db is the GDBM database.
• obj is the object's name.
• host is the remote host's name.
• logID is the remote host's log ID.

Returns the log record, if one is found. Otherwise, returns NULL.

PUBLIC void log_suffix(Database *db, char *obj, time_t start, LogUpdater updater)

Generate a log suffix for an object in the database.

• db is the GDBM database.
• obj is the object's name.
• start is the starting time for the suffix.
• updater is the function to invoke with each log record in the suffix.

No return value.