Essential API Functions

This API covers a wide range of functionality. While all of this functionality is available to a SmartSockets application developer, the typical SmartSockets application uses only a small fraction of the available functions. This list covers the functions that every SmartSocket application will use.

Message Type Functions

TipcMtCreate — Create a new message type.

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

Message Functions

TipcMsgCreate — Create a message.

TipcMsgSetDest — Set the destination, typically the subject name to which this message will be published.

TipcMsgAppend* — This is a class of functions to append various types of fields to a message, including binaries, strings, real numbers, and so on.

TipcSrvMsgSend and TipcSrvConnMsgSend — Publish a message.

TipcMsgSetCurrent — Set the current field of a message.

TipcMsgNext* (TipcMsgNextBinary through TipcMsgNextXml) — 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, real numbers, and so on.

TipcMsgGetNamed* (TipcMsgGetNamedBinary through TipcMsgGetNamedXml) — 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.

TipcMsgDestroy — Destroy a message.

Communication Functions

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

TipcSrvSubjectCbCreate and TipcSrvConnSubjectCbCreate — Define a new callback to be invoked when a message is received to a particular subject.

TipcSrvSubjectDefaultCbCreate and TipcSrvConnSubjectDefaultCbCreate — Define a default subject callback, to be invoked when no other subject callback is defined for that subject.

TipcSrvSubjectSetSubscribe and TipcSrvConnSubjectSetSubscribe— Start or stop subscribing to a subject.

TipcSrvMainLoop and TipcSrvConnMainLoop — Read and process messages from RTserver.

Utility Functions

These functions are documented in TIBCO SmartSockets Utilities, and provide help with startup, debugging and clean up:

TutCommandParseFile — Parse commands from a .cmd 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.

TutOut — Unconditionally print out to a SmartSockets output window.

TutExit — Call exit handlers and terminate the process. This is required in Windows applications.