This file provides the GWEN DB import/export framework. More...

#include <gwenhywfar/gwenhywfarapi.h>
#include <gwenhywfar/plugin.h>
#include <gwenhywfar/path.h>
#include <gwenhywfar/syncio.h>
#include <gwenhywfar/types.h>
#include <gwenhywfar/misc.h>
#include <gwenhywfar/inherit.h>
#include <gwenhywfar/db.h>
#include <gwenhywfar/libloader.h>
#include <gwenhywfar/error.h>
#include <stdio.h>

Include dependency graph for dbio.h:

Go to the source code of this file.

Macros
#define	GWEN_DBIO_FOLDER "dbio"

#define	GWEN_DBIO_PLUGIN_NAME "dbio"

Typedefs
typedef struct GWEN_DBIO	GWEN_DBIO

Enumerations
enum	GWEN_DBIO_CHECKFILE_RESULT { GWEN_DBIO_CheckFileResultOk =0 , GWEN_DBIO_CheckFileResultNotOk , GWEN_DBIO_CheckFileResultUnknown }

Functions
Functions To Be Used By Applications
GWENHYWFAR_API void	GWEN_DBIO_Attach (GWEN_DBIO *dbio)

GWENHYWFAR_API GWEN_DBIO_CHECKFILE_RESULT	GWEN_DBIO_CheckFile (GWEN_DBIO dbio, const char fname)

GWENHYWFAR_API int	GWEN_DBIO_Export (GWEN_DBIO dbio, GWEN_SYNCIO sio, GWEN_DB_NODE db, GWEN_DB_NODE params, uint32_t flags)

GWENHYWFAR_API int	GWEN_DBIO_ExportToBuffer (GWEN_DBIO dbio, GWEN_BUFFER buf, GWEN_DB_NODE db, GWEN_DB_NODE params, uint32_t flags)

GWENHYWFAR_API int	GWEN_DBIO_ExportToFile (GWEN_DBIO dbio, const char fname, GWEN_DB_NODE db, GWEN_DB_NODE params, uint32_t flags)

GWENHYWFAR_API void	GWEN_DBIO_free (GWEN_DBIO *dbio)

GWENHYWFAR_API const char *	GWEN_DBIO_GetDescription (const GWEN_DBIO *dbio)

GWENHYWFAR_API const char *	GWEN_DBIO_GetName (const GWEN_DBIO *dbio)

GWENHYWFAR_API int	GWEN_DBIO_Import (GWEN_DBIO dbio, GWEN_SYNCIO sio, GWEN_DB_NODE db, GWEN_DB_NODE params, uint32_t flags)

GWENHYWFAR_API int	GWEN_DBIO_ImportFromFile (GWEN_DBIO dbio, const char fname, GWEN_DB_NODE db, GWEN_DB_NODE params, uint32_t flags)

Functions To Be Used By Administration Functions
Functions in this group are to be used for administration purposes only.
GWENHYWFAR_API GWEN_DBIO *	GWEN_DBIO_GetPlugin (const char *modname)

GWEN_DBIO plugins
GWENHYWFAR_API GWEN_DBIO *	GWEN_DBIO_Plugin_Factory (GWEN_PLUGIN *pl)

typedef GWEN_DBIO (	GWEN_DBIO_PLUGIN_FACTORYFN) (GWEN_PLUGIN *pl)

Detailed Description

This file provides the GWEN DB import/export framework.

Definition in file dbio.h.

Macro Definition Documentation

◆ GWEN_DBIO_FOLDER

#define GWEN_DBIO_FOLDER "dbio"

name of the folder below Gwen's PLUGIN folder which holds DBIO plugins

Definition at line 56 of file dbio.h.

◆ GWEN_DBIO_PLUGIN_NAME

#define GWEN_DBIO_PLUGIN_NAME "dbio"

Definition at line 50 of file dbio.h.

Typedef Documentation

◆ GWEN_DBIO

typedef struct GWEN_DBIO GWEN_DBIO

Definition at line 43 of file dbio.h.

◆ GWEN_DBIO_PLUGIN_FACTORYFN

typedef GWEN_DBIO *(* GWEN_DBIO_PLUGIN_FACTORYFN) (GWEN_PLUGIN *pl)

Definition at line 92 of file dbio.h.

Enumeration Type Documentation

◆ GWEN_DBIO_CHECKFILE_RESULT

enum GWEN_DBIO_CHECKFILE_RESULT

Enumerator
GWEN_DBIO_CheckFileResultOk
GWEN_DBIO_CheckFileResultNotOk
GWEN_DBIO_CheckFileResultUnknown

Definition at line 79 of file dbio.h.

Function Documentation

◆ GWEN_DBIO_Attach()

GWENHYWFAR_API void GWEN_DBIO_Attach ( GWEN_DBIO * dbio )

Increments the internal usage counter. This counter is decremented upon GWEN_DBIO_free.

Definition at line 243 of file dbio.c.

◆ GWEN_DBIO_CheckFile()

GWENHYWFAR_API GWEN_DBIO_CHECKFILE_RESULT GWEN_DBIO_CheckFile	(	GWEN_DBIO *	dbio,
		const char *	fname
	)

Checks whether the given file is supported by the given DBIO.

Definition at line 297 of file dbio.c.

References DBG_INFO, GWEN_DBIO_CheckFileResultUnknown, and GWEN_LOGDOMAIN.

◆ GWEN_DBIO_Export()

GWENHYWFAR_API int GWEN_DBIO_Export	(	GWEN_DBIO *	dbio,
		GWEN_SYNCIO *	sio,
		GWEN_DB_NODE *	db,
		GWEN_DB_NODE *	params,
		uint32_t	flags
	)

Writes data to the given GWEN_BUFFEREDIO in the format of this particular GWEN_DBIO.

Definition at line 277 of file dbio.c.

References DBG_INFO, and GWEN_LOGDOMAIN.

Referenced by GWEN_DBIO_ExportToBuffer(), and GWEN_DBIO_ExportToFile().

Here is the caller graph for this function:

◆ GWEN_DBIO_ExportToBuffer()

GWENHYWFAR_API int GWEN_DBIO_ExportToBuffer	(	GWEN_DBIO *	dbio,
		GWEN_BUFFER *	buf,
		GWEN_DB_NODE *	db,
		GWEN_DB_NODE *	params,
		uint32_t	flags
	)

Definition at line 468 of file dbio.c.

References DBG_INFO, GWEN_DBIO_Export(), GWEN_LOGDOMAIN, GWEN_SyncIo_free(), and GWEN_SyncIo_Memory_new().

Here is the call graph for this function:

◆ GWEN_DBIO_ExportToFile()

GWENHYWFAR_API int GWEN_DBIO_ExportToFile	(	GWEN_DBIO *	dbio,
		const char *	fname,
		GWEN_DB_NODE *	db,
		GWEN_DB_NODE *	params,
		uint32_t	flags
	)

Definition at line 380 of file dbio.c.

References DBG_ERROR, DBG_INFO, DBG_WARN, GWEN_DB_DEFAULT_LOCK_TIMEOUT, GWEN_DB_FLAGS_APPEND_FILE, GWEN_DB_FLAGS_LOCKFILE, GWEN_DBIO_Export(), GWEN_FSLock_free(), GWEN_FSLock_Lock(), GWEN_FSLock_new(), GWEN_FSLock_ResultOk, GWEN_FSLock_TypeFile, GWEN_FSLock_Unlock(), GWEN_LOGDOMAIN, GWEN_SyncIo_AddFlags(), GWEN_SyncIo_Connect(), GWEN_SyncIo_Disconnect(), GWEN_SyncIo_File_CreationMode_CreateAlways, GWEN_SYNCIO_FILE_FLAGS_APPEND, GWEN_SYNCIO_FILE_FLAGS_READ, GWEN_SYNCIO_FILE_FLAGS_UREAD, GWEN_SYNCIO_FILE_FLAGS_UWRITE, GWEN_SYNCIO_FILE_FLAGS_WRITE, GWEN_SyncIo_File_new(), and GWEN_SyncIo_free().

Referenced by GWEN_DB_WriteFileAs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GWEN_DBIO_free()

GWENHYWFAR_API void GWEN_DBIO_free ( GWEN_DBIO * dbio )

Releases the ressources associated with the given GWEN_DBIO if the usage counter reaches zero.

Definition at line 225 of file dbio.c.

References GWEN_FREE_OBJECT, GWEN_INHERIT_FINI, and GWEN_LIST_FINI.

◆ GWEN_DBIO_GetDescription()

GWENHYWFAR_API const char * GWEN_DBIO_GetDescription ( const GWEN_DBIO * dbio )

Returns a descriptive text about this particular GWEN_DBIO.

Definition at line 321 of file dbio.c.

◆ GWEN_DBIO_GetName()

GWENHYWFAR_API const char * GWEN_DBIO_GetName ( const GWEN_DBIO * dbio )

Returns the name of a GWEN_DBIO.

Definition at line 313 of file dbio.c.

◆ GWEN_DBIO_GetPlugin()

GWENHYWFAR_API GWEN_DBIO * GWEN_DBIO_GetPlugin ( const char * modname )

This function creates a GWEN_DBIO of the given name. It therefore loads the appropriate plugin if necessary. The caller becomes the owner of the object returned, so he/she is responsible for freeing it (Note: Previous version kept the ownership so that the caller was not allowed to free the object. This has changed).

Definition at line 352 of file dbio.c.

References DBG_ERROR, DBG_INFO, GWEN_DBIO_Plugin_Factory(), GWEN_LOGDOMAIN, GWEN_PluginManager_FindPluginManager(), and GWEN_PluginManager_GetPlugin().

Referenced by GWEN_DB_ReadFileAs(), and GWEN_DB_WriteFileAs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GWEN_DBIO_Import()

GWENHYWFAR_API int GWEN_DBIO_Import	(	GWEN_DBIO *	dbio,
		GWEN_SYNCIO *	sio,
		GWEN_DB_NODE *	db,
		GWEN_DB_NODE *	params,
		uint32_t	flags
	)

Reads data from the given io layer and stores the data read into the given DB. The stream represented by the buffered io is expected to have the format for this particular GWEN_DBIO.

Definition at line 251 of file dbio.c.

References DBG_ERROR, DBG_INFO, GWEN_LOGDOMAIN, GWEN_SyncIo_GetStatus(), GWEN_SyncIo_GetTypeName(), and GWEN_SyncIo_Status_Connected.

Referenced by GWEN_DB_ReadFileAs(), and GWEN_DBIO_ImportFromFile().

Here is the call graph for this function: