SQLite VFS Shim: sqlitevfs::SQLiteFileImpl Struct Reference

SQLite VFS Shim

Single header with classes for easily implementing SQLite VFS shims in C++11

Loading...

Searching...

No Matches

#include <SQLiteVfs.hpp>

Public Member Functions
virtual int	iVersion () const

virtual int	xClose ()

virtual int	xRead (void *p, int iAmt, sqlite3_int64 iOfst)

virtual int	xWrite (const void *p, int iAmt, sqlite3_int64 iOfst)

virtual int	xTruncate (sqlite3_int64 size)

virtual int	xSync (int flags)

virtual int	xFileSize (sqlite3_int64 *pSize)

virtual int	xLock (int flags)

virtual int	xUnlock (int flags)

virtual int	xCheckReservedLock (int *pResOut)

virtual int	xFileControl (int op, void *pArg)

virtual int	xSectorSize ()

virtual int	xDeviceCharacteristics ()

virtual int	xShmMap (int iPg, int pgsz, int flags, void volatile **pp)

virtual int	xShmLock (int offset, int n, int flags)

virtual void	xShmBarrier ()

virtual int	xShmUnmap (int deleteFlag)

virtual int	xFetch (sqlite3_int64 iOfst, int iAmt, void **pp)

virtual int	xUnfetch (sqlite3_int64 iOfst, void *p)

Public Attributes
sqlite3_file *	original_file

Detailed Description

SQLite File implementation with virtual methods for C++.

The default method implementations forward execution to original_file.

You should not create objects of this type manually. Instead, you should subclass it, overriding any of the methods necessary, and pass your subclass to SQLiteVfsImpl<>.

Note: Destructors will be called automatically by SQLiteFile right after xClose is called.

See also: https://sqlite.org/c3ref/file.html

Member Function Documentation

◆ iVersion()

virtual int sqlitevfs::SQLiteFileImpl::iVersion ( ) const

inlinevirtual

Determine which functions are supported by this implementation.

The default implementation returns original_file's iVersion, or 1 if it is NULL. Override this to report a different version.

See also: https://sqlite.org/c3ref/io_methods.html

◆ xCheckReservedLock()

virtual int sqlitevfs::SQLiteFileImpl::xCheckReservedLock ( int * pResOut )

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xClose()

virtual int sqlitevfs::SQLiteFileImpl::xClose ( )

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xDeviceCharacteristics()

virtual int sqlitevfs::SQLiteFileImpl::xDeviceCharacteristics ( )

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xFetch()

virtual int sqlitevfs::SQLiteFileImpl::xFetch	(	sqlite3_int64	iOfst,
		int	iAmt,
		void **	pp
	)

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xFileControl()

virtual int sqlitevfs::SQLiteFileImpl::xFileControl	(	int	op,
		void *	pArg
	)

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xFileSize()

virtual int sqlitevfs::SQLiteFileImpl::xFileSize ( sqlite3_int64 * pSize )

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xLock()

virtual int sqlitevfs::SQLiteFileImpl::xLock ( int flags )

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xRead()

virtual int sqlitevfs::SQLiteFileImpl::xRead	(	void *	p,
		int	iAmt,
		sqlite3_int64	iOfst
	)

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xSectorSize()

virtual int sqlitevfs::SQLiteFileImpl::xSectorSize ( )

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xShmBarrier()

virtual void sqlitevfs::SQLiteFileImpl::xShmBarrier ( )

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xShmLock()

virtual int sqlitevfs::SQLiteFileImpl::xShmLock	(	int	offset,
		int	n,
		int	flags
	)

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xShmMap()

virtual int sqlitevfs::SQLiteFileImpl::xShmMap	(	int	iPg,
		int	pgsz,
		int	flags,
		void volatile **	pp
	)

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xShmUnmap()

virtual int sqlitevfs::SQLiteFileImpl::xShmUnmap ( int deleteFlag )

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xSync()

virtual int sqlitevfs::SQLiteFileImpl::xSync ( int flags )

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xTruncate()

virtual int sqlitevfs::SQLiteFileImpl::xTruncate ( sqlite3_int64 size )

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xUnfetch()

virtual int sqlitevfs::SQLiteFileImpl::xUnfetch	(	sqlite3_int64	iOfst,
		void *	p
	)

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xUnlock()

virtual int sqlitevfs::SQLiteFileImpl::xUnlock ( int flags )

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

◆ xWrite()

virtual int sqlitevfs::SQLiteFileImpl::xWrite	(	const void *	p,
		int	iAmt,
		sqlite3_int64	iOfst
	)

inlinevirtual

See also: https://sqlite.org/c3ref/io_methods.html

Member Data Documentation

◆ original_file

sqlite3_file* sqlitevfs::SQLiteFileImpl::original_file

File used by the default method implementations.

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

SQLiteVfs.hpp