shoreman - Index to the Shore Manual Pages

DESCRIPTION
SDL
CXXLB
OC
SVAS
SSM
STHREAD
COMMON
FC
SHORE
VERSION
SPONSORSHIP
COPYRIGHT

DESCRIPTION

The Shore manual divied into sections sdl, cxxlb, oc, svas, ssm, sthread, common, fc, and shore. A brief listing of the manual pages in each section follows. See the individual manual pages for more information.

SDL

Shore Data Language

intro: introduction to the Shore Data Language
sdl: the Shore Data Language Compiler
sdlcxx: SDL C++ Language Binding Generation

CXXLB

Shore C++ language binding

assign: REF(T) assignment
const: constant declarations
construct: Ref<T> 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
intro: introduction to the Shore C++ language binding
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

OC

Shore object cache

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
intro: introduction to the Shore object cache
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
transactions: 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

SVAS

Shore Value-Added Server

anonymous: creating and destroying anonymous Shore objects
appendObj: increase the size of a Shore object
device: Shore devices and volumes
df: Shore disk usage and free space report
mkDir, rmDir, getRootDir, chDir, cwd, gwd: using Shore directories
du: Shore disk usage
environment: environment variables recognized by the Shore Value-Added Server
errors: errors returned by Shore Value-Added Server
fileOf: discover file associated with a Shore pool or index
file_system: Shore registered objects
getDirEntries: reading Shore directories
indexscan: scanning Shore indexes
intro: introduction to the Shore Value-Added Server
link: hard links and symbolic links
lockObj: lock a Shore object
log: error logging in the Shore Value-Added Server
lookup, _lookup: locating Shore objects by path name
manualindex: manual indexes in Shore
mkVolRef, offVolRef, snapRef: Shore logical object identifiers
mount: Shore file systems and volumes
new_svas: creating a new instance of a Shore Value-Added Server
object: miscellaneous properties of Shore Objects
options: configuration options used by the Shore Value-Added Server
page: inspect a cached page for objects
chGrp, chMod, chOwn: changing permissions of Shore objects
pool: Shore pools and anonymous objects
PoolScan: locate the objects in a Shore pool
readObj: inspect a Shore object
mkRegistered, mkLink, reName, rmLink1, rmLink2: creating and destroying registered Shore objects
setREuid, setREgid: set real and effective user or group IDs in Shore application
shell: Tcl interface to the Shore Value-Added Server
sshutdown: how to shut down the Shore Value-Added Server
statistics: Shore performance information
svas_server: derived class of shore_vas for VASs
sysprops: system properties of Shore Objects
text: making Shore objects visible to Unix
transaction: making sequences of Shore operations atomic
transient: Shore Objects that are not persistent
truncObj: change the size of a Shore Object
umask: mask for a Shore client's permission bits
unixfile: creating and destroying UnixFile objects
updateObj: combined write and append or trunc
utimes: change the access and modification times of a Shore object
writeObj: update a Shore object

SSM

Shore Storage Manager

bulkld_index, create_assoc, create_index, destroy_assoc, destroy_index, find_assoc, print_index: Class ss_m Methods for B+Tree Index Operations
debug: Debugging with the Shore Storage Manager (SSM)
format_dev, mount_dev, dismount_dev, dismount_all, list_devices, list_volumes, get_device_quota: Class ss_m Methods for Device Management
ss_m::concurrency_t, ss_m::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
intro: Introduction to the Shore Storage Manager
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
bulkld_md_index, create_md_assoc, create_md_index, destroy_md_assoc, destroy_md_index, find_md_assoc, print_md_index, draw_rtree rtree_stats: Class ss_m Methods for R*tree (multi-dimensional) Index Operations
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
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

Shore Threads Package

errors: Error codes returned by the Shore Thread Package
sfile_hdl_base_t, sfile_read_hdl_t: File Descriptor I/O Handler Classes
intro: Introduction to the Shore Threads Package
scond_t: Shore Condition Variable Class
sevsem_t: Shore Event Semaphore Class
smutex_t: Shore Mutex Class
sthread_t: Shore Thread Abstract Base Class

COMMON

Shore Common code

ErrLog: Shore Error Logging Class
intro: Introduction to the Shore Common code
latch_t: Thread Synchronization Latches
lid_t, lvid_t: Logical ID Classes
nbox_t: Multi-dimensional box class
options: Shore option-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

FC

Shore Foundation Classes

w_error_t: Shore error-handling
intro: Introduction to the Shore Foundation Classes
w_list_t: generic list structures
w_rc_t: Shore return code
w_statistics_t: generic statistics structure

SHORE

a Scalable Heterogeneous Object REpository

Shore: a Scalable Heterogeneous Object REpository
lrid_t: Shore Object Identifiers
smount, sumount: Mount or unmount a Shore file system as an NFS file

VERSION

This manual page applies to Version 1.1.1 of the Shore software.

SPONSORSHIP

The Shore project is sponsored by the Advanced Research Project Agency, ARPA order number 018 (formerly 8230), monitored by the U.S. Army Research Laboratory under contract DAAB07-91-C-Q518.

CONTENTS