TIBCO ActiveSpaces®

Typedefs
types.h File Reference

ActiveSpaces client datatype definitions. More...

## Typedefs
typedef struct __tibdgBatchResult * | tibdgBatchResult
| A batch result allows a user retrieve the results of a batched operation or an error that occurred during the batch. More...
typedef struct __tibdgEventRec * | tibdgEvent
| An event on a table. More...
typedef struct __tibdgGridMetadataId * | tibdgGridMetadata
| A grid metadata object contains grid configuration information. More...
typedef struct __tibdgIteratorId * | tibdgIterator
| An iterator object supports selectively returning a set of matching rows. More...
typedef struct __tibdgResultSetId * | tibdgResultSet
| A resultset object supports selectively returning a set of matching rows. More...
typedef struct __tibdgResultSetMetadataId * | tibdgResultSetMetadata
| A resultset metadata object contains information about the result of a query. More...
typedef struct __tibdgRow * | tibdgRow
| A row object contains columns. More...
typedef struct __tibdgRowIterator * | tibdgRowIterator
| A row iterator object iterates over the columns in the row. More...
typedef struct __tibdgSessionId * | tibdgSession
| A session object provides the context for a thread of operations involving data grid resources. More...
typedef struct __tibdgStatementId * | tibdgStatement
| A statement object supports a SQL select query. More...
typedef struct __tibdgTableId * | tibdgTable
| A table object contains rows. More...
typedef struct __tibdgTableListenerId * | tibdgTableListener
| A tablelistener allows a user to receive notifications of asynchronous events occurring on a table. More...
typedef struct __tibdgTableMetadataId * | tibdgTableMetadata
| A table metadata object contains table configuration information. More...

## Detailed Description

ActiveSpaces client datatype definitions.

## Typedef Documentation

## ◆ tibdgBatchResult

typedef struct __tibdgBatchResult* tibdgBatchResult

A batch result allows a user retrieve the results of a batched operation or an error that occurred during the batch.

## ◆ tibdgEvent

typedef struct __tibdgEventRec* tibdgEvent

An event on a table.

Depending on the type of event, it may have current and/or previous values.

When a new row that matches the listener's filter is added to the table, the type of the event will be TIBDG_EVENT_TYPE_PUT. The event will have a current value. When a row is updated either from a value that matches the filter or to a value that matches the filter, the type of the event will be TIBDG_EVENT_TYPE_PUT and the event will have both a current value and a previous value.

When a row that matches the listener's filter is deleted from the table, the type of the event will be TIBDG_EVENT_TYPE_DELETE. The event will have a previous value.

When an error occurs in the system that relates to the table, the type of the event will be TIBDG_EVENT_TYPE_ERROR. The event will have an error code and description.

## ◆ tibdgGridMetadata

typedef struct __tibdgGridMetadataId* tibdgGridMetadata

A grid metadata object contains grid configuration information.

A program that creates a grid metadata object must explicitly call tibdgGridMetadata_Destroy to reclaim its resources.

## ◆ tibdgIterator

typedef struct __tibdgIteratorId* tibdgIterator

An iterator object supports selectively returning a set of matching rows.

A program that creates an iterator must explicitly call tibdgIterator_Close to reclaim its resources.

## ◆ tibdgResultSet

typedef struct __tibdgResultSetId* tibdgResultSet

A resultset object supports selectively returning a set of matching rows.

A program that creates an resultset must explicitly call tibdgResultSet_Close to reclaim its resources.

## ◆ tibdgResultSetMetadata

typedef struct __tibdgResultSetMetadataId* tibdgResultSetMetadata

A resultset metadata object contains information about the result of a query.

## ◆ tibdgRow

typedef struct __tibdgRow* tibdgRow

A row object contains columns.

Row objects are not thread-safe. Programs must not access a row from several threads simultaneously.

A program that creates a row must explicitly call tibdgRow_Destroy to reclaim its resources.

## ◆ tibdgRowIterator

typedef struct __tibdgRowIterator* tibdgRowIterator

A row iterator object iterates over the columns in the row.

When you do not know the columns of a row at the time you design a program, your program can use a row iterator to traverse the columns of a row.

A row iterator presents all the fields that are actually set in a row object. The table schema determines the order in which an iterator presents the columns of a row.

Row iterator objects are not thread-safe. Programs must not access a row iterator from several threads simultaneously.

An iterator becomes invalid when its row becomes invalid.

## ◆ tibdgSession

typedef struct __tibdgSessionId* tibdgSession

A session object provides the context for a thread of operations involving data grid resources.

The session object is NOT thread-safe. Do not invoke multiple operations on a single session using more than one thread. Behavior is not defined if this happens.

A program that creates a session must explicitly call tibdgSession_Destroy to reclaim its resources.

## ◆ tibdgStatement

typedef struct __tibdgStatementId* tibdgStatement

A statement object supports a SQL select query.

A program that creates a statement object must explicitly call tibdgStatement_Close to reclaim its resources.

## ◆ tibdgTable

typedef struct __tibdgTableId* tibdgTable

A table object contains rows.

A program that creates a table must explicitly call tibdgTable_Close to reclaim its resources.

## ◆ tibdgTableListener

typedef struct __tibdgTableListenerId* tibdgTableListener

A tablelistener allows a user to receive notifications of asynchronous events occurring on a table.

## ◆ tibdgTableMetadata

typedef struct __tibdgTableMetadataId* tibdgTableMetadata

A table metadata object contains table configuration information.