xref: /third_party/pulseaudio/src/pulsecore/database.h

#ifndef foopulsecoredatabasehfoo
#define foopulsecoredatabasehfoo

/***
  This file is part of PulseAudio.

  Copyright 2009 Lennart Poettering

  PulseAudio is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2.1 of the
  License, or (at your option) any later version.

  PulseAudio is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
***/

#include <sys/types.h>

#include <pulsecore/macro.h>

/* A little abstraction over simple databases, such as gdbm, tdb, and
 * so on. We only make minimal assumptions about the supported
 * backend: it does not need to support locking, it does not have to
 * be arch independent. */

typedef struct pa_database pa_database;

typedef struct pa_datum {
    void *data;
    size_t size;
} pa_datum;

void pa_datum_free(pa_datum *d);

/* Database implementation; returns non-empty database filename extension string */
const char* pa_database_get_filename_suffix(void);

/* Opens a database file. The file is loaded from the directory indicated by
 * path. The file name is constructed by using fn as the base and then adding
 * several parts:
 *   1) If prependmid is true, the machine id is prepended to the file name.
 *   2) The database implementation specific suffix is added.
 *   3) Older versions of PulseAudio in some cases added the CPU architecture
 *      to the file name, which was later deemed unnecessary, but for
 *      compatibility reasons we still need to look for those files, so we scan
 *      the directory for files that match the prefix (possible machine id plus
 *      fn) and the suffix, and if any matches are found, we use the first one.
 *
 * When no existing file is found, we create a new file for the database
 * (without the CPU architecture part in the name).
 *
 * For a read-only database, set for_write to false. */

pa_database* pa_database_open(const char *path, const char *fn, bool prependmid, bool for_write);

/* Database implementation; opens specified database file using provided path. */
pa_database* pa_database_open_internal(const char *path, bool for_write);
void pa_database_close(pa_database *db);

pa_datum* pa_database_get(pa_database *db, const pa_datum *key, pa_datum* data);

int pa_database_set(pa_database *db, const pa_datum *key, const pa_datum* data, bool overwrite);
int pa_database_unset(pa_database *db, const pa_datum *key);

int pa_database_clear(pa_database *db);

signed pa_database_size(pa_database *db);

pa_datum* pa_database_first(pa_database *db, pa_datum *key, pa_datum *data /* may be NULL */);
pa_datum* pa_database_next(pa_database *db, const pa_datum *key, pa_datum *next, pa_datum *data /* may be NULL */);

int pa_database_sync(pa_database *db);

#endif