Essential API Functions

The SmartSockets publish-subscribe API covers a wide range of function. While all of this function is available to a SmartSockets application developer, the typical SmartSockets application uses only a small fraction of the available functions. The following is a list of the few functions that every SmartSockets application uses, followed by a brief description.

If you plan to use SmartSockets with C, see the TIBCO SmartSockets Application Programming Interface reference for the information you need to use these functions. It contains the complete reference information for all the C API functions.

If you plan to use SmartSockets with C++, see the TIBCO SmartSockets C++ User’s Guide reference for the information you need to use these functions.

If you plan to use SmartSockets with Java, see the TIBCO SmartSockets Java Library User’s Guide and Tutorial and the online Java reference in JavaDoc format for the information you need. The names of the C functions are similar to the names of the classes and methods used for Java. If you are interested in support for the Java Message Service (JMS), contact TIBCO Product Support for more information on TIBCO JMS products.

Message Type Functions:

Message Functions:

TipcMtCreate	Create a new message type.
TipcMtLookup	Look up a message type by name. This is necessary to create a new message.


TipcMsgAddNamed*	This is a class of functions to add various types of fields to a message by name, including binaries, strings, and reals.
TipcMsgAppend*	This is a class of functions to append various types of fields to a message, including binaries, strings, and reals.
TipcMsgCreate	Create a message.
TipcMsgDeleteNamed	Delete fields to a message by name, including binaries, strings, and reals.
TipcMsgDestroy	Destroy a message.
TipcMsgGetNamed*	This is a class of functions that gets a field by name. Analogous to the TipcMsgAddNamed* functions, there is a "get named" for binaries, strings, reals, and other types.
TipcMsgNext*	This is a class of functions that reads the next field of the type specified. Analogous to the TipcMsgAppend* functions, there is a "get next" for binaries, strings, reals, and other types.
TipcMsgSetCurrent	Set the current field of a message.
TipcMsgSetDest	Set the destination, typically the subject name to which this message will be published.
TipcMsgUpdateNamed*	This is a class of functions to update various types of fields to a message by name, including binaries, strings, and reals.
TipcSrvMsgSend	Publish a message.

Communication Functions:

These are RTclient functions that communicate with RTserver to receive and process messages:


TipcSrvMainLoop	Read and process messages from RTserver.
TipcSrvMsgNext	Get the next message from the connection to RTserver.
TipcSrvMsgProcess	Process a message in the connection to RTserver.
TipcSrvMsgSend	Publish (send) a message through the connection to RTserver.
TipcSrvSubjectCbCreate	Define a new callback to be invoked when a message is received to a particular subject.
TipcSrvSubjectDefaultCbCreate	Define a default subject callback, to be invoked when no other subject callback is defined for that subject.
TipcSrvSubjectSetSubscribe	Start or stop subscribing to a subject.

Utility Functions:

These functions help with startup, debugging and clean up. See the TIBCO SmartSockets Utilities reference for the information you need to use these functions:


TutCommandParseFile	Parses commands from a file for startup configuration.
TutErrNumGet	Get the value of the global SmartSockets error number.
TutErrStrGet	Get the SmartSockets global error number as a descriptive string.
TutExit	Call exit handlers and terminate the process. This is required in Windows applications.
TutOut	Unconditionally print out to a SmartSockets output window.