Main Page | Class Hierarchy | Data Structures | File List | Data Fields | Globals | Related Pages

CDBconnection Class Reference

The next database client library connection class. More...

#include <CDB.h>


Public Member Functions

 CDBconnection (CDB *tDB, const CDBstring &conn_str)
 (Deprecated) Constructor
 CDBconnection (CDB *tDB)
 Default initialization constructor.
 CDBconnection (CDBconnection &c)
 Copy-constructor.
int Connect (const CDBstring &conn_str)
 Connect to database.
void Disconnect ()
 Terminate connection.
CDBstring Error ()
 Retrieve error message.
Tptr getConn ()
 Get pointer to drivers connection object.
CDB * getDB ()
 Get pointer to driver wrapping class.
void setopt (int opt)
 Set connection specific options.
int Status ()
 Check status of this connection.
virtual ~CDBconnection ()
 Virtual destructor.

Private Attributes

Tptr mConn
CDB * mDB


Detailed Description

The next database client library connection class.

This class is an abstract view of a possibility to connect to a sql database. Use The default constructor and the Connect method for efficient connection handling.


Constructor & Destructor Documentation

CDBconnection (  CDBconnection &  c  ) 
 

Copy-constructor.

CDBconnection (  CDB *  tDB  ) 
 

Default initialization constructor.

This is the recommend constructor to instanciate any kind (dynamic or static) of this class. It is needed to pass a valid connection object. A NULL pointer is NOT supported. There is no possibility to chain the CDB instance.

Parameters:
tDB Pointer to CDB class instance.

CDBconnection (  CDB *  tDB,
const CDBstring &  conn_str
) 
 

(Deprecated) Constructor

Deprecated:

This is a deprecated initialization constructor. Don't use this any more. The possibilities for error handling are very raw.

Parameters:
tDB Pointer to CDB class instance.
conn_str Connection sring

virtual ~CDBconnection (   )  [virtual]
 

Virtual destructor.


Member Function Documentation

int Connect (  const CDBstring &  conn_str  ) 
 

Connect to database.

This method makes a connection to the database.

Parameters:
conn_str CDB like Connection string ("user=... password=... dbname=... host=...")
Returns:
1 on succes, smaller than if error arises.

void Disconnect (   ) 
 

Terminate connection.

Terminate this instance of connection

CDBstring Error (   ) 
 

Retrieve error message.

This function retrieve error messages from erros arises during connect.

Returns:
Pointer to statical allocated memory.

Tptr getConn (   ) 
 

Get pointer to drivers connection object.

CDB* getDB (   ) 
 

Get pointer to driver wrapping class.

void setopt (  int  opt  ) 
 

Set connection specific options.

Set options corresponds to the session of this connection

int Status (   ) 
 

Check status of this connection.

Use this function to determine the status of the connection instance.

Returns:
1 if connected, 0 if not connected, smaller than if error arises.


Field Documentation

Tptr mConn [private]
 

CDB* mDB [private]
 


Generated on Mon Feb 6 00:30:32 2006 for CDB by  doxygen 1.4.4