SHORE Storage Manager Application Programming Interface (SSM API)

Collaboration diagram for SHORE Storage Manager Application Programming Interface (SSM API):

---

Detailed Description

Most of the SHORE Storage Manager functionality is presented in two C++ classes, ss_m and smthread_t. The ss_m is the storage manager, an instance of which must be constructed before any storage manager methods may be used. The construction of the single instance performs recovery.

All storage manager methods must be called in the context of a storage manager thread, smthread_t. This means they must be called (directly or indirectly) by the run() method of a class derived from smthread_t. See: smthread_t, Starting Up, Shutting Down, Thread Context.

The storage manager is paramaterized with options and their associated values, some of which have defaults and others of which must be given values by the server. An options-processing package is provided for this purpose.

See

• List of Run-Time Options for an inventory of the storage manager's options,
• Run-Time Options for a discussion of code to initialize the options,
• Starting Up, Shutting Down, Thread Context for a discussion of how to initialize and start up a storage manager,
• startstop::cpp for an example of the minimal required use of options in a server, and
• the example consisting of create_rec::cpp and init_config_options::cpp for a more complete example

The rest of this page points to examples of code that uses the storage manager, and the modules listed below describe various aspects of the functionality and methods provided by the storage manager.

Examples of Server Code

Minimal Example

Any code that uses the SHORE Storage Manager requires

 #include <sm_vas.h>

For a simple example, see startstop::cpp

Setting Up Run-Time Options

The example init_config_options::cpp demonstrates a more extensive handling of option, and is used in other examples, below.

Creating a file of Records

The example create_rec::cpp shows a server that creates a file of records. It must also contain, of course, the creation of options, starting up and shutting down a storage manager.

Use of ss_m::ss_m Arguments

The example log_exceed::cpp demonstrates the use of the ss_m::ss_m arguments. It is an extension of the above example that generates enough log to run out of log space.

Modules
	Programming Idioms
	Significant C Preprocessor Macros
	Identifiers
	Starting Up, Shutting Down, Thread Context
	Run-Time Options
	Storage Structures
	Transactions, Locking and Logging
	Storage Manager Statistics
	Virtual Tables
	Miscellaneous

---