CONTENTS

Shore Programmer's Manual - 2 August 96

SYNOPSIS

common

ErrLog

Shore Error Logging Class

latch_t

Data Vector Classes

lid_t, lvid_t

Logical ID Classes

nbox_t

Multi-dimensional box class

Options

Shore options - processing package

rsrc_m, rsrc_i

Resource Manager and Iterator Classes

serial_t

Serial Number for Logical ID

vec_t, cvec_t

Data Vector Classes

cxxlb

assign

REF(T) assignment

const

constant declarations

construct

Ref constructors

create

create Shore object

create_xref

create cross reference

destroy

destroy anonymous object

equal

compare references for equality

errors

debugging a Shore application

fetch

fetch object into object cache

flush

remove object from object cache

get_lockmode

get current lock state of object

get_loid

convert ref to logical oid

get_type

get type object

index

SDL index attribute types

is_resident

determine cache residency of object

lookup

find object by pathname

method

method calls on Shore objects

new

create Shore object

ostat

retrieve information about an object

param

C++ language binding for method parameters

REF

pointer to Shore object

set, bag, sequence, array

set bag, sequence, and array attributes

string, text

SDL string and text attribute types

union

union attributes

update

mark object dirty

valid

determine validity of a reference to a Shore object

fc

w_error_t

Shore error-handling

w_list_t

generic list structures

w_rc_t

Shore return code

w_statistics_t

generic statistics structure

oc

access

determine read, write, exec access to an object

chdir

change working directory

chmod

change access permissions bits of a registered object

chown

change ownership of a registered object

errors

error codes and messages for the Shore language-independent

getcwd

get pathname of current working directory

init

object cache initialization and shutdown methods

mkdir

make a directory

options

configuration options used by the Shore Value-Added Server

pool

create or remove a pool

process_options

customizing options

readlink

read contents of symbolic link

rename

change name of registered object

rmdir

remove a directory

stat

retrieve information about an object

stats

application statistics gathering

symlink

create symbolic link

TRANSACTION

Methods and Macros for Transactions

umask

set registered object creation mode mask

unixcompat

Unix compatibility methods

unlink

remove a directory entry

utimes

update registered object time stamps

sdl

SDLCXX

SDL C++ Language Binding Generation

shore

lrid_t

Shore Object Identifiers

smount, sumount

Mount or unmount a Shore file system as an NFS file

ssm

DEBUG

Debugging with the Shore Storage Manager (SSM)

concurrency_t, store_property_t

Enumerations for Class ss_m

errors

Error codes returned by the Shore Storage Manager (SSM)

append_rec, create_file, create_id, create_rec, create_rec_id, destroy_file, destroy_rec, lfid_of_lrid, truncate_rec, update_rec, update_rec_hdr

Class ss_m Methods for File/Record Operations

ss_m, set_shutdown_flag, setup_options

Class ss_m Methods for Initialization

link_to_remote_id, convert_to_local_id, lfid_of_lrid, set_lid_cache_enable, lid_cache_enabled

Class ss_m Methods for Logical ID Operations

lock, unlock, query_lock, set_lock_cache_enable, lock_cache_enabled

Class ss_m Methods for Locking

pin_i, pin, repin, unpin

Class for Pinning Records

scan_file_i

Classes for Scanning Files in the Shore Storage Manager

scan_index_i

Class for Scanning B+tree Indexes

scan_rt_i

Class for Scanning an R*tree index in the Shore Storage Manager

SHORE_FILE_PAGE_T

TODO

smthread_t

SSM Thread Class

sort_file

Class ss_m Sorting Methods

sort_stream_i

Sorting Utility Class

statistics

Shore Storage Manager performance information

begin_xct, commit_xct, abort_xct, chain_xct, save_work, rollback_work, tid_to_xct, xct_to_tid, state_xct, prepare_xct, enter_2pc, recover_2pc

Class ss_m methods for transactions

generate_new_lvid, create_vol, destroy_vol, add_logical_id_index, has_logical_id_index, get_volume_quota, print_lid_index, vol_root_index, get_du_statistics

Class ss_m Methods for Volume Management

sthread

errors

Error codes returned by the Shore Thread Package

sfile_hdl_base_t, sfile_read_hdl_t

File Descriptor I/O Handler Classes

scond_t

Shore Condition Variable Class

sevsem_t

Shore Event Semaphore Class

smutex_t

Shore Mutex Class

sthread_t

Shore Thread Abstract Base Class

svas

df

Shore disk usage and free space report

environment

environment variables recognized by the Shore Value-Added Server

log

error logging in the Shore Value-Added Server

mount

Shore file systems and volumes

options

configuration options used by the Shore Value-Added Server

shell

Tcl interface to the Shore Value-Added Server

sshutdown

how to shut down the Shore Value-Added Server

statistics

Shore performance information

VERSION

SPONSORSHIP

COPYRIGHT