conn.h File Reference

Applications use a connection object to create sessions. More...

Typedefs
typedef struct __tibdgConnectionId *	tibdgConnection
	The connection object provides access to a data grid. More...

Functions
TIBDG_API void	tibdgConnection_Close (tibEx e, tibdgConnection conn)
	Close a connection object. More...
TIBDG_API tibdgSession	tibdgConnection_CreateSession (tibEx e, tibdgConnection conn, tibProperties props)
	Create a session object to perform operations. More...
TIBDG_API tibdgGridMetadata	tibdgConnection_GetGridMetadata (tibEx e, tibdgConnection conn, tibProperties props)
	Retrieve the current data grid metadata in an object. More...
TIBDG_API tibdgConnection	tibdgGrid_Connect (tibEx e, const char *URL, const char *gridName, tibProperties props)
	Create a connection object. More...

Detailed Description

Applications use a connection object to create sessions.

Typedef Documentation

typedef struct __tibdgConnectionId* tibdgConnection

The connection object provides access to a data grid.

The connection object creates or opens all resources associated with a given data grid.

A program that creates a connection must explicitly call tibdgConnection_Close to reclaim its resources.Connection object type.

Function Documentation

TIBDG_API void tibdgConnection_Close	(	tibEx	e,
		tibdgConnection	conn
	)

Close a connection object.

Releases all resources associated with this connection object.

Note that all resources created or opened by this object are invalidated by this call. These resources should be destroyed or closed before closing this connection.

Parameters

e	The exception object captures information about failures.
conn	The connection to be destroyed.

Returns

void

TIBDG_API tibdgSession tibdgConnection_CreateSession	(	tibEx	e,
		tibdgConnection	conn,
		tibProperties	props
	)

Create a session object to perform operations.

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.

Parameters

e	The exception object captures information about failures.
conn	The connection on which to create this session.
props	Optional. NULL to omit. TIBDG_SESSION_PROPERTY_BOOLEAN_TRANSACTED

Returns

On success, this call returns a new session object.
On failure, this call returns NULL.

TIBDG_API tibdgGridMetadata tibdgConnection_GetGridMetadata	(	tibEx	e,
		tibdgConnection	conn,
		tibProperties	props
	)

Retrieve the current data grid metadata in an object.

A grid metadata object contains information about the data grid including name, version, and additional metadata about tables.

The information in a grid metadata object will be current when the request returns and will not be updated after that point.

A grid metadata object must be closed to release internal state and no further access should be made to the grid metadata object or any nested objects after it has been closed.

Parameters

e	The exception object captures information about failures.
conn	The connection object used to retrieve the data grid metadata.
props	Optional. NULL to omit.

Returns

On success, this call returns a new data grid metadata object.
On failure, this call returns NULL.

TIBDG_API tibdgConnection tibdgGrid_Connect	(	tibEx	e,
		const char *	URL,
		const char *	gridName,
		tibProperties	props
	)

Create a connection object.

Applications use a connection object to create sessions.

Parameters

e	The exception object captures information about failures.
URL	The URL to use for getting FTL realm server information.
gridName	The dataGridName identifies the data grid to which this call connects. Passing NULL selects the default data grid (which is named "_default").
props	Optional. NULL to omit. TIBDG_CONNECTION_PROPERTY_DOUBLE_TIMEOUT

Returns

On success, this call returns a new connection object.
On failure, this call returns NULL.