Diskheap Library

Version 1.5.1

March 2002

• 1. Library Copying and Licensing Conditions
• 2. Installation Notes, Defintions, and Sample Code
  • 2.1 How to Install the Library
  • 2.2 General Memory Terms and Concepts
  • 2.3 Small Sample of Code Showing Usage of the Library
  • 2.4 Some Ideas on How to Utilize the Library
• 3. List of functions provided by the library.
  • 3.1 Standard Functions such as Open, Close, Store, and Retrieve.
    • 3.1.1 diskheap_create -- Create a new diskheap file
    • 3.1.2 diskheap_open -- Open an existing diskheap file
    • 3.1.3 diskheap_close -- Close a diskheap structure
    • 3.1.4 diskheap_store -- Store a buffer of bytes in the heap
    • 3.1.5 diskheap_retrieve -- Retrieve a previously stored buffer
    • 3.1.6 diskheap_retrieve_to_buf -- Retrieve into a fixed buffer.
    • 3.1.7 diskheap_update -- Update a stored buffer with new data.
    • 3.1.8 diskheap_delete -- Remove a store buffer from the heap.
  • 3.2 Administrative Functions
    • 3.2.1 diskheap_set_free_space -- Adjust Space for Free Information
    • 3.2.2 diskheap_set_sync_often -- When to Sync Administrative Information
    • 3.2.3 diskheap_sync_header -- Sync Administrative Header Information
    • 3.2.4 diskheap_sync_free_list -- Sync Free-List Information.
  • 3.3 Functions to Associate String Labels with Locations
    • 3.3.1 diskheap_label_set -- Associate a label with a diskheap location.
    • 3.3.2 diskheap_label_get -- Get the location associated with a label.
    • 3.3.3 diskheap_label_get_entry -- Get a specific entry from the label array.
  • 3.4 Administrative Functions
    • 3.4.1 diskheap_linear_first -- Get the location of first entry in the heap.
    • 3.4.2 diskheap_linear_next -- Get the location of next entry in the heap.
  • 3.5 Miscellaneous Functions
    • 3.5.1 diskheap_fsync -- Sync the diskheap with disk using fsync.
    • 3.5.2 diskheap_seed_random -- Seed the random number generator.
    • 3.5.3 diskheap_strerror -- Return string equivalent to diskheap error.
• 4. Index of Concepts

This document was generated on 31 March 2002 using texi2html 1.56k.

Diskheap Home Page. Copyright 2002 by Gray Watson