Home

	Expand Search

Sybase dbQueue Reference Guide

Chapter 2: dbQueue Objects Class Reference

Objects Library

Objects Library

This chapter contains reference pages for the dbQueue objects C++ class library. Table 2-1 lists the dbQueue objects classes and their methods.

Table 2-1: dbQueue Objects classes and methods

Class DbqAppDb
Action Method	Description
DbqAppDb::Add()	Adds the application database for the domain.
DbqAppDb::AlterPassword()	Alters the administrative password for the database.
DbqAppDb::Deinstall()	Removes the database initialization information for queuing.
DbqAppDb::Install()	Installs the SQL implementation to initialize the database for queuing.
DbqAppDb::InstallStatus()	Examines the database to determine whether queue initialization tables and stored procedures have been installed.
DbqAppDb::Ping()	Opens a connection to the database and checks that it is correct.
DbqAppDb::Refresh()	Rereads the database attributes from the catalog.
DbqAppDb::Remove()	Removes the application database from the catalog.
List Methods	Description
DBQ_STATUS ListContainedQueues(DbqEnumerator* list)	Returns a list containing a DbqQueue instance for each queue defined within the application database.
Class DbqConnection
Action Method	Description
DbqConnection::BeginTran()	Begins a user transaction.
DbqConnection::Close()	Closes an open connection to an application database.
DbqConnection::Commit()	Commits a user transaction.
DbqConnection::Open()	Opens a connection to an application database.
DbqConnection::Rollback()	Rolls back a user transaction.
Class DbqDomain
Action Method	Description
DbqDomain::Close()	Closes a connection to the domain.
DbqDomain::Deinstall()	Deinstalls the catalog for a domain.
DbqDomain::FindEntity()	Finds existing domain entities using the entity name.
DbqDomain::Install()	Installs the catalog for a domain.
DbqDomain::InstallStatus()	Returns the installation status of the catalog.
DbqDomain::Open()	Opens a connection to the domain catalog.
DbqDomain::NewEntity()	Allocates blank entity instances that can be used to add new entities to the catalog.
DbqDomain::NewMessage()	Creates an empty message that can be filled in for enqueuing.
DbqDomain::RemoveAll()	Deinstalls and removes all entities in the domain.
List Methods	Description
DBQ_STATUS ListAllAppDbs(DbqEnumerator* list)	Creates a list containing a DbqAppDb instance for each application database in the catalog or an empty list if none exist.
DBQ_STATUS ListAllQueues(DbqEnumerator* list)	Creates a list containing a DbqQueue instance for each queue in the catalog or an empty list if none exist.
DBQ_STATUS ListAllMessageTypes(DbqEnumerator* list)	Creates a list containing a DbqMessageType instance for each message type in the catalog or an empty list if none exist.
DBQ_STATUS ListAllQTMs(DbqEnumerator* list)	Creates a list containing a DbqQtm instance for each QTM in the catalog or an empty list if none exist.
DBQ_STATUS ListAllTransfers(DbqEnumerator* list)	Creates a list containing a DbqTransfer instance for each transfer in the catalog or an empty list if none exist.
Class DbqEnumerator
Action Method	Description
DbqEnumerator::Fetch()	Retrieves the next element from the list.
DbqEnumerator::GetElement()	Retrieves a specific element from the list.
DbqEnumerator::Size()	Returns the number of elements in the list.
DbqEnumerator::Start()	Positions the pointer to the beginning of the list.
Class DbqEnv
Action Method	Description
DbqEnv::NewEnv()	Static method used to get a new environment instance.
DbqEnv::NewConnection()	Allocates a new DbqQueueAccessor instance.
DbqEnv::NewDomain()	Allocates a DbqDomain instance.
DbqEnv::NewQueueAccessor()	Allocates a new DbqQueueAccessor instance.
DbqEnv::NewSharedConnection()	Allocates a new DbqQueueAccessor instance on a shared ODBC connection.
DbqEnv::WriteToLog()	Writes a message to the log maintained by dbQueue objects.
Class DbqErr
Error class used to hold error messages.
Class DbqMessage
Action Method	Description
DbqMessage::FetchCol<Type>()	Fetches the value of a column into a client-supplied buffer.
DbqMessage::PutCol<Type>()	Puts a value into a message column from a client-supplied buffer.
List Method	Description
DBQ_STATUS ListColumns(DbqEnumerator* list)	Returns a DbqMessageColumn instance for each column in the message.
Class DbqMessageColumn
Read-only class used to list the attributes of message columns.
Class DbqMessageType
Action Method	Description
DbqMessageType::InsertColumn()	Adds a column to a message type.
DbqMessageType::Add()	Adds a new message type to the domain.
DbqMessageType::Refresh()	Rereads message type attributes from the catalog.
DbqMessageType::Remove()	Removes message type from the catalog.
List Method	Description
DbqEnumerator* ListMessageColumns()	Returns a DbqMessageColumn instance for each column in the message or an empty list if none exist. The list is in column order.
Class DbqObject
Action Method	Description
DbqObject::Delete()	Cleans up and deletes the instance.
DbqObject::FetchError()	Fetches the next error message, if there is one.
DbqObject::FetchErrorList()	Fetches all available error messages and returns them as a DbqEnumerator instance.
DbqObject::NumErrors()	Returns the number of pending errors.
Class DbqQtm
Action Method	Description
DbqQtm::Add()	Adds a QTM definition.
DbqQtm::Ping()	Connects to the QTM to ensure that it is running.
DbqQtm::Refresh()	Rereads the QTM attributes from the catalog.
DbqQtm::ReloadFromCatalog()	Requests QTM to reload configuration information and its list of transfers from the catalog.
DbqQtm::Remove()	Removes the QTM definition from the catalog.
DbqQtm::Shutdown()	Requests that the QTM terminate.
List Method	Description
DbqEnumerator* ListTransfers()	Returns a DbqTransfer instance for each transfer that the QTM handles or an empty list if none exist
Class DbqQueue
Action Method	Description
DbqQueue::Add()	Adds a new queue definition to the domain.
DbqQueue::Deinstall()	Removes the queue implementation, including the queue itself and any associated message types.
DbqQueue::Install()	Installs SQL to implement the queue and any associated message types.
DbqQueue::InstallStatus()	Examines the queue to determine whether it has been implemented.
DbqQueue::Refresh()	Rereads the queue attributes from the catalog.
DbqQueue::Remove()	Removes the queue from the catalog.
List Method	Description
DBQ_STATUS ListMessages DbqEnumerator* list)	Returns a DbqMessageType instance for each message type associated with the queue or an empty list if none exist.
Class DbqQueueAccessor
Action Method	Description
DbqQueueAccessor::CheckSize()	Finds out the current number of messages in the queue.
DbqQueueAccessor::Dequeue()	Dequeues a message and places it in a new DbqMessage instance.
DbqQueueAccessor::DequeueByMessageTypeName()	Dequeues a message by message type name and places it in a new DbqMessage instance.
DbqQueueAccessor::DequeueBySubject()	Dequeues a message by subject and places it in a new DbqMessage instance.
DbqQueueAccessor::DequeueByMessageID()	Dequeues a message by message ID and places it in a new DbqMessage instance.
DbqQueueAccessor::DequeueByPriority()	Dequeues a message by priority and places it in a new DbqMessage instance.
DbqQueueAccessor::Enqueue()	Enqueues a message.
DbqQueueAccessor::Open()	Initializes a queue for use, which includes confirming that the queue exists and loading the list of message types supported by the queue.
DbqQueueAccessor::Truncate()	Removes all messages from the queue.
List Method	Description
DBQ_STATUS ListMessages DbqEnumerator* list)	Returns a list of all the messages in the queue.
Class DbqTransfer
Action Method	Description
DbqTransfer::Add()	Adds transfer definition.
DbqTransfer::Refresh()	Rereads the transfer attributes from the catalog.
DbqTransfer::Remove()	Removes the transfer definition from the catalog.

Class DbqAppDb

DbqAppDb::Add()

DbqAppDb::AlterPassword()

DbqAppDb::Deinstall()

DbqAppDb::Install()

DbqAppDb::InstallStatus()

DbqAppDb::Ping()

DbqAppDb::Refresh()

DbqAppDb::Remove()

Class DbqConnection

DbqConnection::BeginTran()

DbqConnection::Close()

DbqConnection::Commit()

DbqConnection::Open()

DbqConnection::Rollback()

Class DbqDomain

DbqDomain::Close()

DbqDomain::Deinstall()

DbqDomain::FindEntity()

DbqDomain::Install()

DbqDomain::InstallStatus()

DbqDomain::Open()

DbqDomain::NewEntity()

DbqDomain::NewMessage()

DbqDomain::RemoveAll()

Class DbqEnumerator

DbqEnumerator::Fetch()

DbqEnumerator::GetElement()

DbqEnumerator::Size()

DbqEnumerator::Start()

Class DbqEnv

DbqEnv::NewEnv()

DbqEnv::NewConnection()

DbqEnv::NewDomain()

DbqEnv::NewQueueAccessor()

DbqEnv::NewSharedConnection()

DbqEnv::WriteToLog()

Class DbqErr

Class DbqMessage

DbqMessage::FetchCol<Type>()

DbqMessage::PutCol<Type>()

Class DbqMessageColumn

Class DbqMessageType

DbqMessageType::InsertColumn()

DbqMessageType::Add()

DbqMessageType::Refresh()

DbqMessageType::Remove()

Class DbqObject

DbqObject::Delete()

DbqObject::FetchError()

DbqObject::FetchErrorList()

DbqObject::NumErrors()

Class DbqQtm

DbqQtm::Add()

DbqQtm::Ping()

DbqQtm::Refresh()

DbqQtm::ReloadFromCatalog()

DbqQtm::Remove()

DbqQtm::Shutdown()

Class DbqQueue

DbqQueue::Add()

DbqQueue::Deinstall()

DbqQueue::Install()

DbqQueue::InstallStatus()

DbqQueue::Refresh()

DbqQueue::Remove()

Class DbqQueueAccessor

DbqQueueAccessor::CheckSize()

DbqQueueAccessor::Dequeue()

DbqQueueAccessor::DequeueByMessageTypeName()

DbqQueueAccessor::DequeueBySubject()

DbqQueueAccessor::DequeueByMessageID()

DbqQueueAccessor::DequeueByPriority()

DbqQueueAccessor::DequeueBySequenceNumber()

DbqQueueAccessor::Enqueue()

DbqQueueAccessor::Open()

DbqQueueAccessor::Truncate()

Class DbqTransfer

DbqTransfer::Add()

DbqTransfer::Refresh()

DbqTransfer::Remove()