Sq3BlobC_CC_API

Sq3BlobC - the class known as sq3blob or Blob define by Sq3BlobS … More...

Collaboration diagram for Sq3BlobC_CC_API:

Topics
	Sq3BlobC_Class_CC_API
	Sq3BlobC - define the class …
	Sq3BlobC_TOR_CC_API
	Sq3BlobC - various functions to create, initialize and destroy …
	Sq3BlobC_Misc_CC_API
	Sq3BlobC - various functions to perform misc operations …

Classes
struct	ccsq3lite::Sq3BlobC_A
	Struct to represent the data of the Sq3BlobC … → C-API: libsq3lite::Sq3BlobS More...
class	ccsq3lite::Sq3BlobC
	Struct to represent the data of the Sq3BlobC … → C-API: libsq3lite::Sq3BlobS More...

Functions
	ccsq3lite::Sq3BlobC::Sq3BlobC (SQ3_BLOB hdl)
static Sq3BlobC *	ccsq3lite::Sq3BlobC::Sq3BlobC_ObjNew (MK_RT_ARGS SQ3_BLOB hdl)
	return Sq3BlobC from LibMsgqueObject
SQ3_BLOB	ccsq3lite::Sq3BlobC::getBLOB () const
	return the LibMsgqueObject from current Sq3BlobC instance
SQ3_BLOB	ccsq3lite::Sq3BlobC::getBLOB__null_allow () const
	return the LibMsgqueObject from current Sq3BlobC instance
SQ3_BLOBN	ccsq3lite::Sq3BlobC::getBLOBN () const
	(const) return the LibMsgqueObject from current Sq3BlobC instance
SQ3_BLOBN	ccsq3lite::Sq3BlobC::getBLOBN__null_allow () const
	(const) return the LibMsgqueObject from current Sq3BlobC instance
static SQ3_BLOB	ccsq3lite::Sq3BlobC::getBLOB (Sq3BlobC *clsHdl)
	return LibMsgqueObject from current Sq3BlobC pointer
static SQ3_BLOB	ccsq3lite::Sq3BlobC::getBLOB__null_allow (Sq3BlobC *clsHdl)
	return LibMsgqueObject from current Sq3BlobC pointer
static SQ3_BLOBN	ccsq3lite::Sq3BlobC::getBLOBN (const Sq3BlobC *clsHdl)
	(const) return LibMsgqueObject from current Sq3BlobC pointer
static SQ3_BLOBN	ccsq3lite::Sq3BlobC::getBLOBN__null_allow (const Sq3BlobC *clsHdl)
	(const) return LibMsgqueObject from current Sq3BlobC pointer
static SQ3_BLOB	ccsq3lite::Sq3BlobC::getBLOB (const Sq3BlobC &clsHdl)
	return LibMsgqueObject from current Sq3BlobC reference
static SQ3_BLOB	ccsq3lite::Sq3BlobC::getBLOB__null_allow (const Sq3BlobC &clsHdl)
	return LibMsgqueObject from current Sq3BlobC reference
static SQ3_BLOBN	ccsq3lite::Sq3BlobC::getBLOBN (const Sq3BlobC &clsHdl)
	(const) return LibMsgqueObject from current Sq3BlobC reference
static SQ3_BLOBN	ccsq3lite::Sq3BlobC::getBLOBN__null_allow (const Sq3BlobC &clsHdl)
	(const) return LibMsgqueObject from current Sq3BlobC reference
bool	ccsq3lite::Sq3BlobC::Check () const
	check if pointer is still valid

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

Detailed Description

Sq3BlobC - the class known as sq3blob or Blob define by Sq3BlobS …

Struct to represent the data of the Sq3BlobC …

A Handle To An Open BLOB …

An instance of this object represents an open BLOB on which incremental BLOB I/O can be performed. Objects of this type are created by Sq3BlobOpen () and destroyed by Sq3BlobClose (). The Sq3BlobRead () and Sq3BlobWrite () interfaces can be used to read or write small subsections of the BLOB. The Sq3BlobBytes () interface returns the size of the BLOB in bytes.

Reference code from sqlite3:

typedef struct sqlite3_blob sqlite3_blob;

Function Documentation

Check()

bool ccsq3lite::Sq3BlobC::Check ( ) const

inline

check if pointer is still valid

Definition at line 152 of file Sq3BlobC_cc.hh.

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

getBLOB() [1/3]

SQ3_BLOB ccsq3lite::Sq3BlobC::getBLOB ( ) const

inline

return the LibMsgqueObject from current Sq3BlobC instance

Definition at line 84 of file Sq3BlobC_cc.hh.

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

Here is the caller graph for this function:

getBLOB() [2/3]

static SQ3_BLOB ccsq3lite::Sq3BlobC::getBLOB ( const Sq3BlobC & clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3BlobC reference

Definition at line 132 of file Sq3BlobC_cc.hh.

                                                      {
        return clsHdl.getBLOB();
      };

getBLOB() [3/3]

static SQ3_BLOB ccsq3lite::Sq3BlobC::getBLOB ( Sq3BlobC * clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3BlobC pointer

Definition at line 108 of file Sq3BlobC_cc.hh.

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

getBLOB__null_allow() [1/3]

SQ3_BLOB ccsq3lite::Sq3BlobC::getBLOB__null_allow ( ) const

inline

return the LibMsgqueObject from current Sq3BlobC instance

Definition at line 91 of file Sq3BlobC_cc.hh.

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

Here is the caller graph for this function:

getBLOB__null_allow() [2/3]

static SQ3_BLOB ccsq3lite::Sq3BlobC::getBLOB__null_allow ( const Sq3BlobC & clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3BlobC reference

Definition at line 137 of file Sq3BlobC_cc.hh.

                                                                  {
        return clsHdl.getBLOB__null_allow();
      };

getBLOB__null_allow() [3/3]

static SQ3_BLOB ccsq3lite::Sq3BlobC::getBLOB__null_allow ( Sq3BlobC * clsHdl )

inlinestatic

return LibMsgqueObject from current Sq3BlobC pointer

Definition at line 115 of file Sq3BlobC_cc.hh.

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

getBLOBN() [1/3]

SQ3_BLOBN ccsq3lite::Sq3BlobC::getBLOBN ( ) const

inline

(const) return the LibMsgqueObject from current Sq3BlobC instance

Definition at line 96 of file Sq3BlobC_cc.hh.

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

Here is the caller graph for this function:

getBLOBN() [2/3]

static SQ3_BLOBN ccsq3lite::Sq3BlobC::getBLOBN ( const Sq3BlobC & clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3BlobC reference

Definition at line 142 of file Sq3BlobC_cc.hh.

                                                        {
        return clsHdl.getBLOBN();
      };

getBLOBN() [3/3]

static SQ3_BLOBN ccsq3lite::Sq3BlobC::getBLOBN ( const Sq3BlobC * clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3BlobC pointer

Definition at line 120 of file Sq3BlobC_cc.hh.

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

getBLOBN__null_allow() [1/3]

SQ3_BLOBN ccsq3lite::Sq3BlobC::getBLOBN__null_allow ( ) const

inline

(const) return the LibMsgqueObject from current Sq3BlobC instance

Definition at line 103 of file Sq3BlobC_cc.hh.

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

Here is the caller graph for this function:

getBLOBN__null_allow() [2/3]

static SQ3_BLOBN ccsq3lite::Sq3BlobC::getBLOBN__null_allow ( const Sq3BlobC & clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3BlobC reference

Definition at line 147 of file Sq3BlobC_cc.hh.

                                                                    {
        return clsHdl.getBLOBN__null_allow();
      };

getBLOBN__null_allow() [3/3]

static SQ3_BLOBN ccsq3lite::Sq3BlobC::getBLOBN__null_allow ( const Sq3BlobC * clsHdl )

inlinestatic

(const) return LibMsgqueObject from current Sq3BlobC pointer

Definition at line 127 of file Sq3BlobC_cc.hh.

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

Sq3BlobC()

ccsq3lite::Sq3BlobC::Sq3BlobC ( SQ3_BLOB hdl )

inline

Definition at line 75 of file Sq3BlobC_cc.hh.

: MkObjectC(Sq3BlobC_X2obj(hdl)) {};

Sq3BlobC_ObjNew()

static Sq3BlobC * ccsq3lite::Sq3BlobC::Sq3BlobC_ObjNew ( MK_RT_ARGS SQ3_BLOB hdl )

inlinestatic

return Sq3BlobC from LibMsgqueObject

Definition at line 79 of file Sq3BlobC_cc.hh.

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

Here is the caller graph for this function:

Variable Documentation

MK_NULL_REF

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

static

Definition at line 36 of file Sq3BlobC_cc.hh.