db_plugin Struct Reference

#include <db_plugin.h>

Data Fields
const char *	name
struct db *(*	init )(const struct config_param *param, GError **error_r)
	Allocates and configures a database.
void(*	finish )(struct db *db)
	Free instance data.
bool(*	open )(struct db *db, GError **error_r)
	Open the database.
void(*	close )(struct db *db)
	Close the database, free allocated memory.
struct song *(*	get_song )(struct db *db, const char *uri, GError **error_r)
	Look up a song (including tag data) in the database.
bool(*	visit )(struct db *db, const struct db_selection *selection, const struct db_visitor *visitor, void *ctx, GError **error_r)
	Visit the selected entities.

---

Detailed Description

Definition at line 41 of file db_plugin.h.

---

Field Documentation

void(* db_plugin::close)(struct db *db)

Close the database, free allocated memory.

Definition at line 62 of file db_plugin.h.

void(* db_plugin::finish)(struct db *db)

Free instance data.

Definition at line 52 of file db_plugin.h.

struct song*(* db_plugin::get_song)(struct db *db, const char *uri, GError **error_r) [read]

Look up a song (including tag data) in the database.

Parameters:

the	URI of the song within the music directory (UTF-8)

Definition at line 70 of file db_plugin.h.

struct db*(* db_plugin::init)(const struct config_param *param, GError **error_r) [read]

Allocates and configures a database.

Definition at line 47 of file db_plugin.h.

const char* db_plugin::name

Definition at line 42 of file db_plugin.h.

bool(* db_plugin::open)(struct db *db, GError **error_r)

Open the database.

Read it into memory if applicable.

Definition at line 57 of file db_plugin.h.

bool(* db_plugin::visit)(struct db *db, const struct db_selection *selection, const struct db_visitor *visitor, void *ctx, GError **error_r)

Visit the selected entities.

Definition at line 76 of file db_plugin.h.

---

The documentation for this struct was generated from the following file:

• src/db_plugin.h