Sq3FileC_CC_API

Sq3FileC - the class known as sq3file or File defined by Sq3FileS … More...

Collaboration diagram for Sq3FileC_CC_API:

Topics
	Sq3FileC_Class_CC_API
	Sq3FileC - define the class …
	Sq3FileC_TOR_CC_API
	Sq3FileC - various functions to create, initialize and destroy …

Classes
struct	ccsq3lite::Sq3FileC_A
	Struct to represent the data of the Sq3FileC … → C-API: libsq3lite::Sq3FileS More...
class	ccsq3lite::Sq3FileC
	Struct to represent the data of the Sq3FileC … → C-API: libsq3lite::Sq3FileS More...

Functions
	ccsq3lite::Sq3FileC::Sq3FileC (SQ3_FILE hdl)
static Sq3FileC *	ccsq3lite::Sq3FileC::Sq3FileC_ObjNew (MK_RT_ARGS SQ3_FILE hdl)
	return Sq3FileC from LibMsgqueObject
SQ3_FILE	ccsq3lite::Sq3FileC::getFILE () const
	return the LibMsgqueObject from current Sq3FileC instance
SQ3_FILE	ccsq3lite::Sq3FileC::getFILE__null_allow () const
	return the LibMsgqueObject from current Sq3FileC instance
SQ3_FILEN	ccsq3lite::Sq3FileC::getFILEN () const
	(const) return the LibMsgqueObject from current Sq3FileC instance
SQ3_FILEN	ccsq3lite::Sq3FileC::getFILEN__null_allow () const
	(const) return the LibMsgqueObject from current Sq3FileC instance
static SQ3_FILE	ccsq3lite::Sq3FileC::getFILE (Sq3FileC *clsHdl)
	return LibMsgqueObject from current Sq3FileC pointer
static SQ3_FILE	ccsq3lite::Sq3FileC::getFILE__null_allow (Sq3FileC *clsHdl)
	return LibMsgqueObject from current Sq3FileC pointer
static SQ3_FILEN	ccsq3lite::Sq3FileC::getFILEN (const Sq3FileC *clsHdl)
	(const) return LibMsgqueObject from current Sq3FileC pointer
static SQ3_FILEN	ccsq3lite::Sq3FileC::getFILEN__null_allow (const Sq3FileC *clsHdl)
	(const) return LibMsgqueObject from current Sq3FileC pointer
static SQ3_FILE	ccsq3lite::Sq3FileC::getFILE (const Sq3FileC &clsHdl)
	return LibMsgqueObject from current Sq3FileC reference
static SQ3_FILE	ccsq3lite::Sq3FileC::getFILE__null_allow (const Sq3FileC &clsHdl)
	return LibMsgqueObject from current Sq3FileC reference
static SQ3_FILEN	ccsq3lite::Sq3FileC::getFILEN (const Sq3FileC &clsHdl)
	(const) return LibMsgqueObject from current Sq3FileC reference
static SQ3_FILEN	ccsq3lite::Sq3FileC::getFILEN__null_allow (const Sq3FileC &clsHdl)
	(const) return LibMsgqueObject from current Sq3FileC reference
bool	ccsq3lite::Sq3FileC::Check () const
	check if pointer is still valid

Variables
static thread_local Sq3FileC	ccsq3lite::Sq3FileC::MK_NULL_REF = {(MK_OBJ)0}

Detailed Description

Sq3FileC - the class known as sq3file or File defined by Sq3FileS …

Struct to represent the data of the Sq3FileC …

OS Interface Open File Handle …

An Sq3FileC object represents an open file in the OS interface layer. Individual OS interface implementations will want to subclass this object by appending additional fields for their own use. The pMethods entry is a pointer to an sqlite3_io_methods object that defines methods for performing I/O operations on the open file.

Reference code from sqlite3:

typedef struct sqlite3_file sqlite3_file;
struct sqlite3_file {
  const struct sqlite3_io_methods *pMethods;  // Methods for an open file 
};

Function Documentation

Check()

bool ccsq3lite::Sq3FileC::Check ( ) const

inline

check if pointer is still valid

Definition at line 152 of file Sq3FileC_cc.hh.

                         {
        return (hdl && Sq3FileCheck(hdl));
      };

getFILE() [1/3]

SQ3_FILE ccsq3lite::Sq3FileC::getFILE ( ) const

inline

return the LibMsgqueObject from current Sq3FileC instance

Definition at line 84 of file Sq3FileC_cc.hh.

                               {
        SQ3_FILE ret = reinterpret_cast<SQ3_FILE>(hdl);
        if (unlikely(ret == NULL)) InstHdlIsNullError();
        return ret;
      };

Here is the caller graph for this function:

getFILE() [2/3]

static SQ3_FILE ccsq3lite::Sq3FileC::getFILE ( const Sq3FileC & clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3FileC reference

Definition at line 132 of file Sq3FileC_cc.hh.

                                                      {
        return clsHdl.getFILE();
      };

getFILE() [3/3]

static SQ3_FILE ccsq3lite::Sq3FileC::getFILE ( Sq3FileC * clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3FileC pointer

Definition at line 108 of file Sq3FileC_cc.hh.

                                                {
        SQ3_FILE ret = clsHdl ? reinterpret_cast<SQ3_FILE>(clsHdl->hdl) : NULL;
        if (unlikely(ret == NULL)) ClassHdlIsNullError(Sq3FileC);
        return ret;
      };

getFILE__null_allow() [1/3]

SQ3_FILE ccsq3lite::Sq3FileC::getFILE__null_allow ( ) const

inline

return the LibMsgqueObject from current Sq3FileC instance

Definition at line 91 of file Sq3FileC_cc.hh.

                                           {
        return reinterpret_cast<SQ3_FILE>(hdl);
      };

Here is the caller graph for this function:

getFILE__null_allow() [2/3]

static SQ3_FILE ccsq3lite::Sq3FileC::getFILE__null_allow ( const Sq3FileC & clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3FileC reference

Definition at line 137 of file Sq3FileC_cc.hh.

                                                                  {
        return clsHdl.getFILE__null_allow();
      };

getFILE__null_allow() [3/3]

static SQ3_FILE ccsq3lite::Sq3FileC::getFILE__null_allow ( Sq3FileC * clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3FileC pointer

Definition at line 115 of file Sq3FileC_cc.hh.

                                                            {
        return clsHdl ? reinterpret_cast<SQ3_FILE>(clsHdl->hdl) : NULL;
      };

getFILEN() [1/3]

SQ3_FILEN ccsq3lite::Sq3FileC::getFILEN ( ) const

inline

(const) return the LibMsgqueObject from current Sq3FileC instance

Definition at line 96 of file Sq3FileC_cc.hh.

                                 {
        SQ3_FILEN ret = reinterpret_cast<SQ3_FILEN>(hdl);
        if (unlikely(ret == NULL)) InstHdlIsNullError();
        return ret;
      };

Here is the caller graph for this function:

getFILEN() [2/3]

static SQ3_FILEN ccsq3lite::Sq3FileC::getFILEN ( const Sq3FileC & clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3FileC reference

Definition at line 142 of file Sq3FileC_cc.hh.

                                                        {
        return clsHdl.getFILEN();
      };

getFILEN() [3/3]

static SQ3_FILEN ccsq3lite::Sq3FileC::getFILEN ( const Sq3FileC * clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3FileC pointer

Definition at line 120 of file Sq3FileC_cc.hh.

                                                        {
        SQ3_FILEN ret = clsHdl ? reinterpret_cast<SQ3_FILEN>(clsHdl->hdl) : NULL;
        if (unlikely(ret == NULL)) ClassHdlIsNullError(Sq3FileC);
        return ret;
      };

getFILEN__null_allow() [1/3]

SQ3_FILEN ccsq3lite::Sq3FileC::getFILEN__null_allow ( ) const

inline

(const) return the LibMsgqueObject from current Sq3FileC instance

Definition at line 103 of file Sq3FileC_cc.hh.

                                             {
        return reinterpret_cast<SQ3_FILEN>(hdl);
      };

Here is the caller graph for this function:

getFILEN__null_allow() [2/3]

static SQ3_FILEN ccsq3lite::Sq3FileC::getFILEN__null_allow ( const Sq3FileC & clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3FileC reference

Definition at line 147 of file Sq3FileC_cc.hh.

                                                                    {
        return clsHdl.getFILEN__null_allow();
      };

getFILEN__null_allow() [3/3]

static SQ3_FILEN ccsq3lite::Sq3FileC::getFILEN__null_allow ( const Sq3FileC * clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3FileC pointer

Definition at line 127 of file Sq3FileC_cc.hh.

                                                                    {
        return clsHdl ? reinterpret_cast<SQ3_FILEN>(clsHdl->hdl) : NULL;
      };

Sq3FileC()

ccsq3lite::Sq3FileC::Sq3FileC ( SQ3_FILE hdl )

inline

Definition at line 75 of file Sq3FileC_cc.hh.

: MkObjectC(Sq3FileC_X2obj(hdl)) {};

Sq3FileC_ObjNew()

static Sq3FileC * ccsq3lite::Sq3FileC::Sq3FileC_ObjNew ( MK_RT_ARGS SQ3_FILE hdl )

inlinestatic

return Sq3FileC from LibMsgqueObject

Definition at line 79 of file Sq3FileC_cc.hh.

                                                                 {
        return (hdl ? static_cast<Sq3FileC*>(MkObjectC::atomObjNew(MK_RT_CALL Sq3FileC_X2obj(hdl))) : &MK_NULL_REF);
      }

Here is the caller graph for this function:

Variable Documentation

MK_NULL_REF

thread_local Sq3FileC ccsq3lite::Sq3FileC::MK_NULL_REF = {(MK_OBJ)0}

static

Definition at line 36 of file Sq3FileC_cc.hh.