Support Kit

Collection of utility classes that are used throughout the API. More...

Classes
class	BArchivable
	Interface for objects that can be archived into a BMessage. More...
class	BArchiver
	A class that simplifies the archiving of complicated BArchivable hierarchies. More...
class	BAutolock
	Convenient utility to make parts of your code thread-safe easily. More...
class	BBlockCache
	A class that creates and maintains a pool of memory blocks. More...
class	BBufferIO
	A buffered adapter for BPositionIO objects. More...
class	BDataIO
	Abstract interface for objects that provide read and write access to data. More...
class	BFlattenable
	Interface for classes that can flatten and unflatten themselves to a stream of bytes. More...
class	BList
	An ordered container that is designed to hold generic void* objects. More...
class	BLocker
	Semaphore-type class for thread safety. More...
class	BMallocIO
	A BPositionIO derived class that creates a memory buffer. More...
class	BMemoryIO
	A BPositionIO derived class that works on memory buffers. More...
class	BPositionIO
	Abstract interface that provides advanced read, write and seek access to data. More...
class	BStopWatch
	A simple class used to time events like a stop watch. More...
class	BString
	String class supporting common string operations. More...
class	BUnarchiver
	A class that simplifies the unarchiving of complicated BArchivable hierarchies. More...
Modules
	Global functions in the support kit
Files
file	Archivable.h
	Provides the BArchivable interface and declares the BArchiver and BUnarchiver classes.
file	Archivable.h
	Provides the BArchivable interface and declares the BArchiver and BUnarchiver classes.
file	Archivable.h
	Provides the BArchivable interface and declares the BArchiver and BUnarchiver classes.
file	Autolock.h
	Implements a handy locking utility.
file	Beep.h
	Functions to generate sounds from the computer.
file	BlockCache.h
	Implements a mechanism to store and retrieve memory blocks.
file	BufferIO.h
	Provides the BBufferIO class.
file	DataIO.h
	Defines abstract BDataIO and BPositionIO and the derived BMallocIO and BMemoryIO classes.
file	Flattenable.h
	Provides the BFlattenable interface.
file	List.h
	Defines the BList class.
file	Locker.h
	Provides locking class BLocker.
file	parsedate.h
	Date parsing functions.
file	StopWatch.h
	Provides the BStopWatch class.
file	String.h
	Defines the BString class and global operators and functions for handling strings.
file	SupportDefs.h
	Defines basic types and definitions for the Haiku API.
file	TLS.h
	Functions to use Thread Local Storage.
file	TypeConstants.h
	Represents typecodes that are used in various part of the Haiku API.

---

Detailed Description

Collection of utility classes that are used throughout the API.

The Support Kit provides a handy set of classes that you can use in your applications. These classes provide:

• Thread Safety. Haiku can execute multiple threads of an application in parallel, letting certain parts of an application continue when one part is stalled, as well as letting an application process multiple pieces of data at the same time on multicore or multiprocessor systems. However, there are times when multiple threads desire to work on the same piece of data at the same time, potentially causing a conflict where variables or pointers are changed by one thread causing another to execute incorrectly. To prevent this, Haiku implements a "locking" mechanism, allowing one thread to "lock out" other threads from executing code that might modify the same data.
  • Archiving and IO. These classes allow a programmer to convert objects into a form that can more easily be transferred to other applications or stored to disk, as well as performing basic input and output operations.
  • Memory Allocation. This class allows a programmer to hand off some of the duties of memory accounting and management.
  • Common Datatypes. To avoid unnecessary duplication of code and to make life easier for programmers, Haiku includes classes that handle management of ordered lists and strings.

There are also a number of utility functions to time actions, play system alert sounds, compare strings, and atomically manipulate integers. Have a look at the overview, or go straight to the complete list of components of this kit.

Overview

• Thread Safety:
  • BLocker provides a semaphore-like locking mechanism allowing for recursive locks.
  • BAutolock provides a simple method of automatically removing a lock when a function ends.
  • Thread Local Storage allows a global variable\'s content to be sensitive to thread context.
• Archiving and IO:
  • BArchivable provides an interface for "archiving" objects so that they may be sent to other applications where an identical copy will be recreated.
  • BArchiver simplifies archiving of BArchivable hierarchies.
  • BUnarchiver simplifies unarchiving hierarchies that have been archived using BArchiver.
  • BFlattenable provides an interface for "flattening" objects so that they may be easily stored to disk.
• BDataIO provides an interface for generalized read/write streams.
  • BPositionIO extends BDataIO to allow seeking within the data.
  • BBufferIO creates a buffer and attaches it to a BPositionIO stream, allowing for reduced load on the underlying stream.
  • BMemoryIO allows operation on an already-existing buffer.
  • BMallocIO creates and allows operation on a buffer.
• Memory Allocation:
  • BBlockCache allows an application to allocate a "pool" of memory blocks that the application can fetch and dispose of as it pleases, letting the application make only a few large memory allocations, instead of many small expensive allocations.
• Common Datatypes:
  • BList allows simple ordered lists and provides common access, modification, and comparison functions.
  • BString allows strings and provides common access, modification, and comparison functions.
• BStopWatch allows an application to measure the time an action takes.
  • Global functions
  • Common types and constants
  • Error codes for all kits

For a better overview, have a look at Introduction to the Support Kit .