Class: TSQLDBProtocol

Declaration: SQLDataAccess.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSQLProduct

Inherited By:

TSQLStandardDBProtocolODBC TSQLStandardDBProtocolOpenClientDBLib TSQLStandardDBProtocolSQLNet

Purpose:

TSQLDBProtocol is a concrete class that describes a database access protocol, such as ODBC or OpenClient. A database protocol specification is required when instantiating a database connection object.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Providers need to derive a new class for every new protocol that they want to support. Although this is a concrete class, SQLDAS clients typically make use of one of its derived classes to specify a particular protocol.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSQLDBProtocol::TSQLDBProtocol

TSQLDBProtocol ()
TSQLDBProtocol (const TText & vendor, const TText & identifier, const TText & version, const TText & name, const TText & platform =TStandardText :: GetEmptyText ())
TSQLDBProtocol (const TSQLDBProtocol & source)

Interface Category:

API.

Purpose:

Default constructor. It is not intended for clients, but for providers of connections and so forth.
Instantiates derived classes.
Copy constructor.

Calling Context:

Called by the stream-in operators and any other function that needs to construct an uninitialized object.
Call this function directly.
Called to copy an object.

Parameters:

Takes no parameters.
const TText & vendor -The vendor name.
const TText & identifier -The unique protocol identifier.
const TText & version -The protocol version.
const TText & name -The protocol name.
const TText & platform =TStandardText :: GetEmptyText () -TStandardText :: GetEmptyText () -The platform supporting the protocol, for example, AIX. The platform is normally not specified, because vendors try to ensure compatibility across platforms.
const TSQLDBProtocol & source -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLDBProtocol::~TSQLDBProtocol

virtual ~ TSQLDBProtocol ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLDBProtocol::operator=

TSQLDBProtocol & operator =(const TSQLDBProtocol & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLDBProtocol & right -The protocol to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLDBProtocol::CanAccess

virtual bool CanAccess (const TSQLDataStore &) const

Interface Category:

API.

Purpose:

Determines if the database access protocol can access the given datastore. Based on the result of this call, clients can limit the complexity of choices presented to the end user.

Calling Context:

Call this function directly.

Parameters:

const TSQLDataStore & -The datastore to check for accessibility.

Return Value:

Returns true if the database access protocol can access the given datastore.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.