ToolTalk™ Programmer's Guide

Document Number: 007-1611-020

Front Matter

| List of Figures | List of Tables |


Table of Contents

Introduction
Who Should Use This Book
How This Book Is Organized
Related Books
Typographic Conventions and Symbols Used in this Manual

1. ToolTalk Overview
ToolTalk Scenarios
How Applications Use ToolTalk Messages
ToolTalk Message Distribution
Modifying Applications to Use the ToolTalk Service
ToolTalk Architecture
Starting a ToolTalk Session
Location of the ToolTalk Service Files
Sample Programs

2. Participating in ToolTalk Sessions
Including the ToolTalk API Header File
Registering with the ToolTalk Service
Setting Up to Receive Messages
Unregistering from the ToolTalk Service

3. Dynamic Message Patterns
Message Pattern Attributes
Defining Dynamic Messages
Updating Message Patterns with the Current Session or File

4. Static Message Patterns
Message Pattern Attributes
Defining Static Messages
Defining Process Types
Defining Object Types
Installing Type Information
Making Type Information Available to the ToolTalk Service
Declaring Process Type
Data Type Registration

5. Sending Messages
How the ToolTalk Service Routes Messages
Message Attributes
ToolTalk Message Delivery Algorithm
Modifying Applications to Send ToolTalk Messages
Request Examples

6. Receiving Messages
Retrieving Messages
Examining Messages
Invoking Callback Routines
Handling Requests
Destroying Messages

7. Objects
Object-Oriented Messaging
Creating Object Specs
Writing Object Specs
Updating Object Specs
Maintaining Object Specs
Destroying Object Specs
Managing Object and File Information
Examples

8. Managing Information Storage
Information Provided to the ToolTalk Service
Information Provided by the ToolTalk Service
Calls Provided to Manage the Storage of Information
Special Case: Callback and Filter Routines

9. Handling Errors
Retrieving ToolTalk Error Status
Returned Pointer Status
Returned Integer Status
Error Propagation

10. ToolTalk API
ToolTalk Enumerated Types
ToolTalk Functions

A. Quick Reference to ToolTalk API

B. ToolTalk API Summary (Functional Grouping)
Initialization
Message Patterns
Session
Files
Messages
Objects
ToolTalk Storage Management
ToolTalk Error Status
Exiting
ToolTalk Error-Handling Macros

C. Initialization Error Messages

D. ToolTalk Error Messages
TT_WRN_NOTFOUND
TT_WRN_NOTFOUND
TT_WRN_STALE_OID
TT_WRN_STOPPED
TT_WRN_SAME_OBJID
TT_WRN_START_MESSAGE
TT_WRN_APPFIRST
TT_WRN_LAST
TT_ERR_CLASS
TT_ERR_DBAVAIL
TT_ERR_DBEXIST
TT_ERR_FILE
TT_ERR_MODE
TT_ERR_ACCESS
TT_ERR_NOMP
TT_ERR_NOTHANDLER
TT_ERR_NUM
TT_ERR_OBJID
TT_ERR_OP
TT_ERR_OTYPE
TT_ERR_ADDRESS
TT_ERR_PATH
TT_ERROR_OTYPE
TT_ERR_PROCID
TT_ERR_PROPLEN
TT_ERR_PROPNAME
TT_ERR_PTYPE
TT_ERR_DISPOSITION
TT_ERR_SCOPE
TT_ERR_SESSION
TT_ERR_VTYPE
TT_ERR_NO_VALUE
TT_ERR_INTERNAL
TT_ERR_READONLY
TT_ERR_NO_MATCH
TT_ERR_UNIMP
TT_ERR_OVERFLOW
TT_ERR_PTYPE_START
TT_ERR_APPFIRST
TT_ERR_LAST
TT_STATUS_LAST

Index