Purpose

The ObjectStore Component Server Framework User Guide describes how to use the Component Server API, the thin client API, and the Component Server executable to build scalable, multitier ObjectStore applications that make optimal use of ObjectStore's Cache-Forward architecture. This book supports ObjectStore Release 5.1.

Audience

This book assumes the reader is experienced with C++.

Scope

Information in this book assumes that ObjectStore and the Component Server Framework are installed and configured.

How This Book Is Organized

The book begins with a chapter that introduces the Framework APIs and the Component Server executable. The chapter also contains a section on using OLEDB and ADO instead of the thin client API. The last three sections of the chapter provide detailed information on building and deploying thin clients and components, as well as on starting and configuring the ObjectStore Component Server.

The next two chapters provide overviews of the Server and client APIs. The two chapters after that provide a basic example and an intermediate example, respectively. The next chapter discusses using ObjectStore Inspector data views together with the Framework.

The subsequent several chapters provide references on each class in the Server and client APIs. The last chapter provides an exception reference.

Notation Conventions

This document uses the following conventions:

Convention	Meaning
Bold	Bold typeface indicates user input or code.
Sans serif	Sans serif typeface indicates system output.
Italic sans serif	Italic sans serif typeface indicates a variable for which you must supply a value. This most often appears in a syntax line or table.
Italic serif	In text, italic serif typeface indicates the first use of an important term.
[ ]	Brackets enclose optional arguments.
{ a | b | c }	Braces enclose two or more items. You can specify only one of the enclosed items. Vertical bars represent OR separators. For example, you can specify a or b or c.
...	Three consecutive periods indicate that you can repeat the immediately previous item. In examples, they also indicate omissions.
	Indicates that the operating system named inside the circle supports or does not support the feature being discussed.

ObjectStore C++ Release 5.1 Documentation

The ObjectStore Release 5.1 documentation is chiefly distributed on line in Web-browsable format. If you want to order printed books, contact your Object Design sales representative.

Your use of ObjectStore documentation depends on your role and level of experience with ObjectStore. You can find an overview description of each book in the ObjectStore documentation set at URL http://www.objectdesign.com. Select Products and then select Product Documentation to view these descriptions.

Internet Sources of More Information

Object Design's support organization provides a number of information resources. These are available to you through a Web browser such as Internet Explorer or Netscape. You can obtain information by accessing the Object Design home page with the URL http://www.objectdesign.com. Select Technical Support. Select Support Communications for detailed instructions about different methods of obtaining information from support.

Internet gateway

You can obtain such information as frequently asked questions (FAQs) from Object Design's Internet gateway machine as well as from the Web. This machine is called ftp.objectdesign.com and its Internet address is 198.3.16.26. You can use ftp to retrieve the FAQs from there. Use the login name odiftp and the password obtained from patch-info. This password also changes monthly, but you can automatically receive the updated password by subscribing to patch-info. See the README file for guidelines for using this connection. The FAQs are in the subdirectory ./FAQ. This directory contains a group of subdirectories organized by topic. The file ./FAQ/FAQ.tar.Z is a compressed tar version of this hierarchy that you can download.

Automatic email notification

In addition to the previous methods of obtaining Object Design's latest patch updates (available on the ftp server as well as the Object Design Support home page) you can now automatically be notified of updates. To subscribe, send email to patch-info-request@objectdesign.com with the keyword SUBSCRIBE patch-info <your siteid> in the body of your email. This will subscribe you to Object Design's patch information server daemon that automatically provides site access information and notification of other changes to the online support services. Your site ID is listed on any shipment from Object Design, or you can contact your Object Design Sales Administrator for the site ID information.

Training

If you are in North America, for information about Object Design's educational offerings, or to order additional documents, call 781.674.5000, Monday through Friday from 8:30 AM to 5:30 PM Eastern Time.

If you are outside North America, call your Object Design sales representative.

Your Comments

Object Design welcomes your comments about ObjectStore documentation. Send your feedback to support@objectdesign.com. To expedite your message, begin the subject with Doc:. For example:

      Subject: Doc: Incorrect message on page 76 of reference manual

You can also fax your comments to 781.674.5440.

Copyright Information

ObjectStore Release 5.1 for all platforms, March 1998

ObjectStore, Object Design, the Object Design logo, LEADERSHIP BY DESIGN, and Object Exchange are registered trademarks of Object Design, Inc. ObjectForms and Object Manager are trademarks of Object Design, Inc.

All other trademarks are the property of their respective owners.

Copyright © 1989 to 1998 Object Design, Inc. All rights reserved. Printed in the United States of America. Except as permitted under the Copyright Act of 1976, no part of this publication may be reproduced or distributed in any form or by any means, or stored in a database or retrieval system, without the prior written permission of the publisher.

COMMERCIAL ITEM - The Programs are Commercial Computer Software, as defined in the Federal Acquisition Regulations and Department of Defense FAR Supplement, and are delivered to the United States Government with only those rights set forth in Object Design's software license agreement.

Data contained herein are proprietary to Object Design, Inc., or its licensors, and may not be used, disclosed, reproduced, modified, performed or displayed without the prior written approval of Object Design, Inc.

This document contains proprietary Object Design information and is licensed for use pursuant to a Software License Services Agreement between Object Design, Inc., and Customer.

The information in this document is subject to change without notice. Object Design, Inc., assumes no responsibility for any errors that may appear in this document.

Object Design, Inc.
Twenty Five Mall Road
Burlington, MA 01803-4194

Part number: SW-OS-DOC-CSF-510