About this book

Audience

This book is for developers creating coordination modules for OpenSwitch version 15.0 and assumes that the reader has:

A general knowledge of the operating system
Familiarity with all platform-specific commands used to manipulate the software and hardware, such as those for changing directories and mounting the CD
General knowledge of Sybase^® servers
General knowledge of failover systems
In-depth knowledge of and experience with programming in the C language
Basic knowledge of Sybase Open Client^™ programming

How to use this book

This document includes these chapters:

Chapter 1, “Introduction,” describes coordination modules—user-built applications that connect to the OpenSwitch server and control client logins and failover patterns within OpenSwitch.
Chapter 2, “Using Coordination Modules,” describes the basic steps for building OpenSwitch coordination modules (CM) and provides example programs.
Chapter 3, “Coordination Module Routines and Registered Procedures,” provides a reference for each coordination module routine and registered procedure.
Chapter 4, “Using the Replication Coordination Module,” describes the sample replication coordination module (RCM) provided with OpenSwitch. You can use this Sybase-created RCM with Replication Server^® in an OpenSwitch implementation.

Other sources of information

Use the Sybase Getting Started CD, the SyBooks CD, and the Sybase Product Manuals Web site to learn more about your product:

The Getting Started CD contains release bulletins and installation guides in PDF format, and may also contain other documents or updated information not included on the SyBooks CD. It is included with your software. To read or print documents on the Getting Started CD, you need Adobe Acrobat Reader, which you can download at no charge from the Adobe Web site using a link provided on the CD.
The SyBooks CD contains product manuals and is included with your software. The Eclipse-based SyBooks browser allows you to access the manuals in an easy-to-use, HTML-based format.

Some documentation may be provided in PDF format, which you can access through the PDF directory on the SyBooks CD. To read or print the PDF files, you need Adobe Acrobat Reader.

Refer to the SyBooks Installation Guide on the Getting Started CD, or the README.txt file on the SyBooks CD for instructions on installing and starting SyBooks.
The Sybase Product Manuals Web site is an online version of the SyBooks CD that you can access using a standard Web browser. In addition to product manuals, you will find links to EBFs/Maintenance, Technical Documents, Case Management, Solved Cases, newsgroups, and the Sybase Developer Network.

To access the Sybase Product Manuals Web site, go to Product Manuals.

Sybase certifications on the Web

Technical documentation at the Sybase Web site is updated frequently.

Finding the latest information on product certifications

Point your Web browser to Technical Documents.
Select Products from the navigation bar on the left.
Select a product name from the product list and click Go.
Select the Certification Report filter, specify a time frame, and click Go.
Click a Certification Report title to display the report.

Finding the latest information on component certifications

Point your Web browser to Availability and Certification Reports.
Either select the product family and product under Search by Product; or select the platform and product under Search by Platform.
Select Search to display the availability and certification report for the selection.

Creating a personalized view of the Sybase Web site (including support pages)

Set up a MySybase profile. MySybase is a free service that allows you to create a personalized view of Sybase Web pages.

Point your Web browser to Technical Documents.
Click MySybase and create a MySybase profile.

Sybase EBFs and software maintenance

Finding the latest information on EBFs and software maintenance

Point your Web browser to the Sybase Support Page.
Select EBFs/Maintenance. If prompted, enter your MySybase user name and password.
Select a product.
Specify a time frame and click Go. A list of EBF/Maintenance releases is displayed.

Padlock icons indicate that you do not have download authorization for certain EBF/Maintenance releases because you are not registered as a Technical Support Contact. If you have not registered, but have valid information provided by your Sybase representative or through your support contract, click Edit Roles to add the “Technical Support Contact” role to your MySybase profile.
Click the Info icon to display the EBF/Maintenance report, or click the product description to download the software.

Conventions

The formatting conventions used in this document are:

Formatting example	To indicate
command names and method names	When used in descriptive text, this font indicates keywords such as: Command names used in descriptive text C++ and Java method or class names used in descriptive text Java package names used in descriptive text
myCounter variable `Server.log` myfile.txt	Italic font indicates: Program variables Parts of input text that must be substituted File names
sybase/bin	Directory names appearing in text display in lowercase unless the system is case sensitive. A forward slash (“/”) indicates generic directory information. A backslash (“\”) applies to Windows users only.
File \| Save	Menu names and menu items display in plain text. The vertical bar indicates how to navigate menu selections, such as from the File menu to the Save option.
`create table` `table created`	Monospace font indicates: Information that you enter on a command line or as program text Example output fragments

Accessibility features

This document is available in an HTML version that is specialized for accessibility. You can navigate the HTML with an adaptive technology such as a screen reader, or view it with a screen enlarger.

OpenSwitch version 15.0 and the HTML documentation have been tested for compliance with U.S. government Section 508 Accessibility requirements. Documents that comply with Section 508 generally also meet non-U.S. accessibility guidelines, such as the World Wide Web Consortium (W3C) guidelines for Web sites.

You might need to configure your accessibility tool for optimal use. Some screen readers pronounce text based on its case; for example, they pronounce ALL UPPERCASE TEXT as initials, and Mixed Case Text as words. You might find it helpful to configure your tool to announce syntax conventions. Consult the documentation for your tool.

For information about how Sybase supports accessibility, see Sybase Accessibility. The Sybase Accessibility site includes links to information on Section 508 and W3C standards.

If you need help

Each Sybase installation that has purchased a support contract has one or more designated people who are authorized to contact Sybase Technical Support. If you cannot resolve a problem using the manuals or online help, please have the designated person contact Sybase Technical Support or the Sybase subsidiary in your area.

View this book as PDF