TIBCO ActiveSpaces® C API Reference
Software Release 2.2
May 2016
- Important Information
- TIBCO Documentation and Support Services
- Overview
TIBCO ActiveSpaces® provides API sets in several programming languages that allow developers to utilize TIBCO ActiveSpaces functionality from within their applications. - C API Header Files
The header files containing the function declarations and typedefs that make up the TIBCO ActiveSpaces C API are found in the AS_HOME/include/c directory. - Status Codes
Most of the functions in the TIBCO ActiveSpaces C API return a result of type tibas_status, which is defined in the header file types.h. - Application Compilation and Linking
The C language examples directory for TIBCO ActiveSpaces includes a Makefile that you can use to compile and link the example programs. It is recommended that you examine this Makefile to see which compiler flags and linker options to use for building your application. - Metaspace
A metaspace represents: - Space
A space provides shared virtual storage for data. - Admin
The administrative tasks for TIBCO ActiveSpaces, are performed using the TIBCO ActiveSpaces administration language commands. - SpaceDef
- MemberDef
The MemberDef functions create and set the attributes of a MemberDef object that controls how a space member connects to a metaspace and communicates with other space members. - FieldDef
Field definitions describe the format of the data that will be stored in the space. - FieldDefList
Field definition lists are holders for collections of FieldDef objects. - KeyDef
KeyDef functions allow you to set up a primary key for searches within a space, and set the type of indexing used with the key. - IndexDef
The IndexDef operations allow you to create secondary indexes, set and retrieve the fields in the indexes, and specify the type of index that is used. - BrowserDef
Browsers are used to iterate through tuples stored in a space. A browser can have either of two scopes, time scope and distribution scope, which are defined by setting the values of fields in the browser’s BrowserDef object. - Browser
There are two Browser APIs: tibasBrowser_next() and tibasBrowser_Free(). - EventBrowserDef
Event browsers are used to iterate through the stream of events that occur in a space. - EventBrowser
ActiveSpaces provides two EventBrowser APIs: tibasEventBrowser_Free() and tibasEventBrowser_Next() - ListenerDef
ActiveSpaces provides a set of ListenerDef APIs. - Listener
ActiveSpaces provides a set of Listener APIs. - SpaceEvent SpaceMemberEvent SpaceRemoteMemberEvent and RemoteMemberEvent
Typically, ActiveSpaces applications use the SpaceEvent functions in a callback function that processes events from an event browser. - Tuple
A tuple is similar to a row in a database table: it is a container for data. More specifically, it is a sequence of named elements called fields (similar to the columns in a database table) which contain values of a specific type. Each tuple in a space represents a set of related data. - TupleList
TupleLists are lists of tuples that can be created and populated by you application. - SpaceResult and InvokeResult
You can use the SpaceResult operations to retrieve tuples from SpaceResult lists and perform other operations on a SpaceResult object. - SpaceResultList and InvokeResultList
SpaceResultList objects are returned by batch operations. Besides giving access to individual Result objects, SpaceResultList objects provide convenience functions for accessing individual tuples and status values directly from the list. - Filter
The filter operations are used to create filters and apply them to specified tuples. Filters can be also be used in space browsers to limit the information that is browsed. - Member
A Member represents either a metaspace member or a space member. - MemberList
MemberList provides the following APIs: tibasMemberList_Size(), tibasMemberList_Get(), and tibasMemberList_Free(). - Persister Action Op OpList ActionResult LogLevel and Recovery Functions
The Persister object enables the user to specify a set of functions that collectively implement the Persister interface. Once a Persister object is created, it can then be registered on a space using the tibasSpace_SetPersister function. - StringList
ActiveSpaces provides a set of StringList APIs. - Error Codes
- Datatypes
TIBCO ActiveSpaces uses various C Datatypes and enumerated types.
Copyright © Cloud Software Group, Inc. All rights reserved.