theSq3Lite 10.0
Loading...
Searching...
No Matches
Sq3ValueC_CC_API

Sq3ValueC - the class known as sq3val or Value define by Sq3ValueSMore...

+ Collaboration diagram for Sq3ValueC_CC_API:

Topics

 Sq3ValueC_Class_CC_API
 Sq3ValueC - define the class …
 
 Sq3ValueC_TOR_CC_API
 Sq3ValueC - various functions to create, initialize and destroy …
 
 Sq3ValueC_Types_CC_API
 Sq3ValueC - get type from value
 
 Sq3ValueC_Info_CC_API
 Sq3ValueC - get type-information
 
 Sq3ValueC_Vtab_CC_API
 Sq3ValueC - work with the virtual-file-system
 

Classes

struct  ccsq3lite::Sq3ValueC_A
 Struct to represent the data of the Sq3ValueC … → C-API: libsq3lite::Sq3ValueS More...
 
class  ccsq3lite::Sq3ValueC
 Struct to represent the data of the Sq3ValueC … → C-API: libsq3lite::Sq3ValueS More...
 

Functions

 ccsq3lite::Sq3ValueC::Sq3ValueC (SQ3_VAL hdl)
 
static Sq3ValueCccsq3lite::Sq3ValueC::Sq3ValueC_ObjNew (MK_RT_ARGS SQ3_VAL hdl)
 return Sq3ValueC from LibMsgqueObject
 
SQ3_VAL ccsq3lite::Sq3ValueC::getVAL () const
 return the LibMsgqueObject from current Sq3ValueC instance
 
SQ3_VAL ccsq3lite::Sq3ValueC::getVAL__null_allow () const
 return the LibMsgqueObject from current Sq3ValueC instance
 
SQ3_VALN ccsq3lite::Sq3ValueC::getVALN () const
 (const) return the LibMsgqueObject from current Sq3ValueC instance
 
SQ3_VALN ccsq3lite::Sq3ValueC::getVALN__null_allow () const
 (const) return the LibMsgqueObject from current Sq3ValueC instance
 
static SQ3_VAL ccsq3lite::Sq3ValueC::getVAL (Sq3ValueC *clsHdl)
 return LibMsgqueObject from current Sq3ValueC pointer
 
static SQ3_VAL ccsq3lite::Sq3ValueC::getVAL__null_allow (Sq3ValueC *clsHdl)
 return LibMsgqueObject from current Sq3ValueC pointer
 
static SQ3_VALN ccsq3lite::Sq3ValueC::getVALN (const Sq3ValueC *clsHdl)
 (const) return LibMsgqueObject from current Sq3ValueC pointer
 
static SQ3_VALN ccsq3lite::Sq3ValueC::getVALN__null_allow (const Sq3ValueC *clsHdl)
 (const) return LibMsgqueObject from current Sq3ValueC pointer
 
static SQ3_VAL ccsq3lite::Sq3ValueC::getVAL (const Sq3ValueC &clsHdl)
 return LibMsgqueObject from current Sq3ValueC reference
 
static SQ3_VAL ccsq3lite::Sq3ValueC::getVAL__null_allow (const Sq3ValueC &clsHdl)
 return LibMsgqueObject from current Sq3ValueC reference
 
static SQ3_VALN ccsq3lite::Sq3ValueC::getVALN (const Sq3ValueC &clsHdl)
 (const) return LibMsgqueObject from current Sq3ValueC reference
 
static SQ3_VALN ccsq3lite::Sq3ValueC::getVALN__null_allow (const Sq3ValueC &clsHdl)
 (const) return LibMsgqueObject from current Sq3ValueC reference
 
bool ccsq3lite::Sq3ValueC::Check () const
 check if pointer is still valid
 

Variables

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

Detailed Description

Sq3ValueC - the class known as sq3val or Value define by Sq3ValueS

Struct to represent the data of the Sq3ValueC

Dynamically Typed Value Object …

SQLite uses the Sq3ValueC object to represent all values that can be stored in a database table. SQLite uses dynamic typing for the values it stores. Values stored in Sq3ValueC objects can be integers, floating point values, strings, BLOBs, or NULL.

An Sq3ValueC object may be either "protected" or "unprotected". Some interfaces require a protected Sq3ValueC. Other interfaces will accept either a protected or an unprotected Sq3ValueC. Every interface that accepts Sq3ValueC arguments specifies whether or not it requires a protected Sq3ValueC. The Sq3ValueDup () interface can be used to construct a new protected Sq3ValueC from an unprotected Sq3ValueC.

The terms "protected" and "unprotected" refer to whether or not a mutex is held. An internal mutex is held for a protected Sq3ValueC object but no mutex is held for an unprotected Sq3ValueC object. If SQLite is compiled to be single-threaded (with SQLITE_THREADSAFE=0 and with Sq3Threadsafe () returning 0) or if SQLite is run in one of reduced mutex modes SQ3_CONFIG_SINGLETHREAD or SQ3_CONFIG_MULTITHREAD then there is no distinction between protected and unprotected Sq3ValueC objects and they can be used interchangeably. However, for maximum code portability it is recommended that applications still make the distinction between protected and unprotected Sq3ValueC objects even when not strictly required.

The Sq3ValueC objects that are passed as parameters into the implementation of application-defined SQL functions are protected. The Sq3ValueC objects returned by sqlite3_vtab_rhs_value () are protected. The Sq3ValueC object returned by Sq3StmtColumnValue () is unprotected. Unprotected Sq3ValueC objects may only be used as arguments to sqlite3_result_value (), Sq3StmtBindValue (), and Sq3ValueDup (). The sqlite3_value_type() family of interfaces require protected Sq3ValueC objects.

Reference code from sqlite3:

typedef struct sqlite3_value sqlite3_value;

Function Documentation

◆ Check()

bool ccsq3lite::Sq3ValueC::Check ( ) const
inline

check if pointer is still valid

Definition at line 152 of file Sq3ValueC_cc.hh.

152 {
153 return (hdl && Sq3ValCheck(hdl));
154 };
static bool Sq3ValCheck(MK_MNGN mng)
check Sq3ValueS -> libmkkernel::MkObjectS::signature …

◆ getVAL() [1/3]

SQ3_VAL ccsq3lite::Sq3ValueC::getVAL ( ) const
inline

return the LibMsgqueObject from current Sq3ValueC instance

Definition at line 84 of file Sq3ValueC_cc.hh.

84 {
85 SQ3_VAL ret = reinterpret_cast<SQ3_VAL>(hdl);
86 if (unlikely(ret == NULL)) InstHdlIsNullError();
87 return ret;
88 };
#define unlikely(x)
struct Sq3ValueS * SQ3_VAL
class-shortcut for struct Sq3ValueS *, all shortcut using the XX_YYY syntax (only for public API) …
+ Here is the caller graph for this function:

◆ getVAL() [2/3]

static SQ3_VAL ccsq3lite::Sq3ValueC::getVAL ( const Sq3ValueC & clsHdl)
inlinestatic

return LibMsgqueObject from current Sq3ValueC reference

Definition at line 132 of file Sq3ValueC_cc.hh.

132 {
133 return clsHdl.getVAL();
134 };

◆ getVAL() [3/3]

static SQ3_VAL ccsq3lite::Sq3ValueC::getVAL ( Sq3ValueC * clsHdl)
inlinestatic

return LibMsgqueObject from current Sq3ValueC pointer

Definition at line 108 of file Sq3ValueC_cc.hh.

108 {
109 SQ3_VAL ret = clsHdl ? reinterpret_cast<SQ3_VAL>(clsHdl->hdl) : NULL;
110 if (unlikely(ret == NULL)) ClassHdlIsNullError(Sq3ValueC);
111 return ret;
112 };

◆ getVAL__null_allow() [1/3]

SQ3_VAL ccsq3lite::Sq3ValueC::getVAL__null_allow ( ) const
inline

return the LibMsgqueObject from current Sq3ValueC instance

Definition at line 91 of file Sq3ValueC_cc.hh.

91 {
92 return reinterpret_cast<SQ3_VAL>(hdl);
93 };
+ Here is the caller graph for this function:

◆ getVAL__null_allow() [2/3]

static SQ3_VAL ccsq3lite::Sq3ValueC::getVAL__null_allow ( const Sq3ValueC & clsHdl)
inlinestatic

return LibMsgqueObject from current Sq3ValueC reference

Definition at line 137 of file Sq3ValueC_cc.hh.

137 {
138 return clsHdl.getVAL__null_allow();
139 };

◆ getVAL__null_allow() [3/3]

static SQ3_VAL ccsq3lite::Sq3ValueC::getVAL__null_allow ( Sq3ValueC * clsHdl)
inlinestatic

return LibMsgqueObject from current Sq3ValueC pointer

Definition at line 115 of file Sq3ValueC_cc.hh.

115 {
116 return clsHdl ? reinterpret_cast<SQ3_VAL>(clsHdl->hdl) : NULL;
117 };

◆ getVALN() [1/3]

SQ3_VALN ccsq3lite::Sq3ValueC::getVALN ( ) const
inline

(const) return the LibMsgqueObject from current Sq3ValueC instance

Definition at line 96 of file Sq3ValueC_cc.hh.

96 {
97 SQ3_VALN ret = reinterpret_cast<SQ3_VALN>(hdl);
98 if (unlikely(ret == NULL)) InstHdlIsNullError();
99 return ret;
100 };
const struct Sq3ValueS * SQ3_VALN
class-shortcut for const struct Sq3ValueS *, all const shortcut using the XX_YYYC syntax (only for pu...
+ Here is the caller graph for this function:

◆ getVALN() [2/3]

static SQ3_VALN ccsq3lite::Sq3ValueC::getVALN ( const Sq3ValueC & clsHdl)
inlinestatic

(const) return LibMsgqueObject from current Sq3ValueC reference

Definition at line 142 of file Sq3ValueC_cc.hh.

142 {
143 return clsHdl.getVALN();
144 };

◆ getVALN() [3/3]

static SQ3_VALN ccsq3lite::Sq3ValueC::getVALN ( const Sq3ValueC * clsHdl)
inlinestatic

(const) return LibMsgqueObject from current Sq3ValueC pointer

Definition at line 120 of file Sq3ValueC_cc.hh.

120 {
121 SQ3_VALN ret = clsHdl ? reinterpret_cast<SQ3_VALN>(clsHdl->hdl) : NULL;
122 if (unlikely(ret == NULL)) ClassHdlIsNullError(Sq3ValueC);
123 return ret;
124 };

◆ getVALN__null_allow() [1/3]

SQ3_VALN ccsq3lite::Sq3ValueC::getVALN__null_allow ( ) const
inline

(const) return the LibMsgqueObject from current Sq3ValueC instance

Definition at line 103 of file Sq3ValueC_cc.hh.

103 {
104 return reinterpret_cast<SQ3_VALN>(hdl);
105 };
+ Here is the caller graph for this function:

◆ getVALN__null_allow() [2/3]

static SQ3_VALN ccsq3lite::Sq3ValueC::getVALN__null_allow ( const Sq3ValueC & clsHdl)
inlinestatic

(const) return LibMsgqueObject from current Sq3ValueC reference

Definition at line 147 of file Sq3ValueC_cc.hh.

147 {
148 return clsHdl.getVALN__null_allow();
149 };

◆ getVALN__null_allow() [3/3]

static SQ3_VALN ccsq3lite::Sq3ValueC::getVALN__null_allow ( const Sq3ValueC * clsHdl)
inlinestatic

(const) return LibMsgqueObject from current Sq3ValueC pointer

Definition at line 127 of file Sq3ValueC_cc.hh.

127 {
128 return clsHdl ? reinterpret_cast<SQ3_VALN>(clsHdl->hdl) : NULL;
129 };

◆ Sq3ValueC()

ccsq3lite::Sq3ValueC::Sq3ValueC ( SQ3_VAL hdl)
inline

Definition at line 75 of file Sq3ValueC_cc.hh.

#define Sq3ValueC_X2obj(x)

◆ Sq3ValueC_ObjNew()

static Sq3ValueC * ccsq3lite::Sq3ValueC::Sq3ValueC_ObjNew ( MK_RT_ARGS SQ3_VAL hdl)
inlinestatic

return Sq3ValueC from LibMsgqueObject

Definition at line 79 of file Sq3ValueC_cc.hh.

79 {
80 return (hdl ? static_cast<Sq3ValueC*>(MkObjectC::atomObjNew(MK_RT_CALL Sq3ValueC_X2obj(hdl))) : &MK_NULL_REF);
81 }
static MK_PTR atomObjNew(MK_RT_ARGS MK_OBJ obj)
#define MK_RT_CALL
static thread_local Sq3ValueC MK_NULL_REF
+ Here is the caller graph for this function:

Variable Documentation

◆ MK_NULL_REF

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

Definition at line 36 of file Sq3ValueC_cc.hh.