c-treeDB API for C++ - Developers Guide

Callback Handle Parameters

The type of handle that is passed to a callback function depends of the type of the callback.

In This Section Sessions Databases Tables Records

Sessions

For these types the handle parameter is a session handle. You can safely typecast the handle parameter to a pCTDBSESSION structure pointer. Please refer to the ctdbsdk.h header file for the declaration of CTDBSESSION structure.

• CTDB_ON_SESSION_LOGON
• CTDB_ON_SESSION_LOGOUT

Databases

For these types the handle parameter is a database handle. You can safely typecast the handle parameter to a pCTDBDATABASE structure pointer. Please refer to the ctdbsdk.h header file for the declaration of CTDBDATABASE structure.

• CTDB_DATABASE_CONNECT
• CTDB_DATABASE_DISCONNECT

Tables

For these types the handle parameter is a table handle. You can safely typecast the handle parameter to a pCTDBTABLE structure pointer. Please refer to the ctdbsdk.h header file for the declaration of CTDBTABLE structure.

• CTDB_ON_TABLE_OPEN
• CTDB_ON_TABLE_CLOSE
• CTDB_ON_TABLE_GET_DODA
• CTDB_ON_TABLE_GET_SCHEMA
• CTDB_ON_TABLE_GET_EXT_INFO
• CTDB_ON_TABLE_GET_RECLEN
• CTDB_ON_TABLE_GET_VTABLE_INFO
• CTDB_ON_TABLE_ALTER
• CTDB_ON_TABLE_REBUILD

Records

For these types the handle parameter is a record handle. You can safely typecast the handle parameter to a pCTDBRECORD structure pointer. Please refer to the ctdbsdk.h header file for the declaration of CTDBRECORD structure.

• CTDB_ON_RECORD_INIT
• CTDB_ON_RECORD_RESET
• CTDB_ON_RECORD_BEFORE_READ
• CTDB_ON_RECORD_AFTER_READ
• CTDB_ON_RECORD_BEFORE_BUILD_KEY
• CTDB_ON_RECORD_AFTER_BUILD_KEY
• CTDB_ON_RECORD_BEFORE_WRITE
• CTDB_ON_RECORD_AFTER_WRITE