Desperado Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
AbstractThis is a pilot framework for a header file declaring a purely abstract base class
ArgumentImplements a simple parser using strtok_r(3) to break up a character string into an C-style argument vector
AsciiIndexes a table of various names for eight-bit ASCII characters indexed by each numeric character value
Ascii::EntryThis describes a single entry in the ASCII table
AtomicSecondsDuplicates the interface of LeapSeconds but never returns any leap seconds
AttributeUses a Transliterator to parse components of a keyword=value pair from a buffer or a file
BandwidthThrottleThis class implements a throttle based on the Generic Cell Rate Algorithm, but instead of rates measured in cells per second and time in microseconds (as per the ATM standards), it measures rates in bytes per second and time in nanoseconds
BufferInputImplements an input functor that returns data from a buffer in memory
BufferOutputImplements an output functor that writes data into a buffer in memory
CellRateThrottleImplements a throttle that enforces a traffic contract based on a virtual scheduler implementation of a Generic Cell Rate Algorithm (GCRA) as defined in the ATM Forum Traffic Management 4.1 specification
ChainImplements a circular doubly-linked list of Link objects which can be used to implement traditional non-circular data structures such as queues or stacks
cm_t
CommonEraImplements an object containing a Common Era date and UTC time, supporting conversions to and from both UTC seconds, which take leap seconds into account, and TAI seconds, which do not, from the Common Era epoch
CompoundThrottleCreates a throttle by combining zero to two throttles
ConstantImplements some useful manifest constants in a common location
CountersProvides an interface to an array of simple counters which may be individually accessed or modified, particularly useful when all of the counters need to managed as a single object, for example when exporting counters to MIBs, or when instrumenting complex systems for the purpose of debugging during development, in situ troubleshooting, or port mortem forensics
Counters::FunctorDefines an interface to a functor (an object that can be called like a function), that performs an operation on an individual counter
CountersType< _NCOUNTERS_ >This is a template that defines a type of the Counters class in which the counter array of the specified size is allocated inside the CountersType object
Crc< _TYPE_ >Generates sixteen bit and thirty-two bit Cyclic Redundancy Check generators whose algorithms are based on the public domain Rocksoft(tm) Model CRC Algorithm by Ross Williams
CriticalSectionGiven a Mutex, locks it upon construction, and unlocks it upon destruction, allowing a Mutex to be automatically locked and unlocked as the critical section goes in and out of scope
CygwinImplements the Platform interface to the Windows operating system using Cygwin
DateImplements an object that contains a date with fields of sufficient size to contain a Common Era year, month and day of the month
DateTimeComposes a Date object and a Time object into a single object
DaylightSavingTimeDefines an interface to encode a rule to decide whether a given DateTime falls within daylight saving time (DST)
DerivationThis is a pilot framework for a header file declaring a derived class
DescriptorInputImplements an input functor that returns data from a file descriptor, the default descriptor being 0 for standard input
DescriptorOutputImplements an output functor that writes data to a file descriptor, the default descriptor being 1 for standard output
DstAlwaysImplements a daylight saving time rule in which DST is always in effect
DstEuEncodes a rule to decide whether a given DateTime falls within the European Union (EU) daylight saving time (DST)
DstGenericEncodes a rule to decide whether a given DateTime falls within daylight saving time (DST) depending on parameters provided during construction, serving as the base class for most other daylight saving time rules
DstGeneric::EventDescribes an event at which daylight saving time begins or ends
DstNeverEncodes a rule to in which daylight saving time is never in effect
DstUsEncodes a rule to decide whether a given DateTime falls within US daylight saving time (DST) based on the year the various US DST rules came in force
DstUs1966Encodes a rule to decide whether a given DateTime falls within US daylight saving time (DST) as defined in 1966
DstUs1986Encodes a rule to decide whether a given DateTime falls within US daylight saving time (DST) as defined in 1986
DstUs2007Encodes a rule to decide whether a given DateTime falls within US daylight saving time (DST) as defined in 2007
DumpDisplays the contents of a block of memory of an arbitary location, size, and a alignment, in a hexadecimal dump format, in either word or byte form
DumpInputImplements an input functor that uses Dump to display its input stream from another input functor before returning it
DumpOutputImplements an output functor that uses Dump to display its output stream before passing it along to another output functor
EncodeImplements methods to collapse and expand strings containing URL-encoded substrings that are typical of those used in GET and POST query strings generated by web servers
EpochDefines a simple composite of seconds and nanoseconds
EscapeImplements methods to collapse and expand strings containing ANSI C-style escape sequences
ExceptionThis is the base class for Desperado classes which define exceptions
FiclMachineImplements an adaptor to a Ficl machine, where Ficl (pronounced "fickle") is a "FORTH-inspired command language" developed by John Sadler, a FORTH interpreter written in ANSI C and designed to be embedded in other applications
FiclShellCreates a Ficl-based command line shell which can manipulate C-accessible integer variables and invoke C-callable functions which take zero to ten integer arguments and return an integer value
FiclSystemImplements an adaptor to a Ficl system, where Ficl (pronounced "fickle") is a "FORTH-inspired command language" developed by John Sadler, a FORTH interpreter written in ANSI C and designed to be embedded in other applications
Fifo< _TYPE_ >Generates a very lightweight mechanism for implementing a circular buffer for objects of the specified type, most usefully in device drivers, including their interrupt service routines
FifoType< _TYPE_, _CC_ >This is a template that defines a type of the Fifo class in which the circular buffer array of the specified size is allocated inside the FifoType object
FileInputImplements an input functor that returns data from a pre-existing C standard I/O library FILE object, the default FILE object being stdin for standard input
FileOutputImplements an output functor that writes data to a pre-existing C standard I/O library FILE object, the default FILE object being stdout for standard output
GcraThis class implements a throttle that enforces a traffic contract based on the virtual scheduler implementation of the Generic Cell Rate Algorithm (GCRA) as described in the ATM Forum Traffic Management 4.1 specification
GeometricThrottleImplements a throttle that decays geometrically by admitting the first time it is called, then the second time, then the fourth time, then the eight time, and so on
GrayCode< _TYPE_ >Generates methods to convert between any integral type and a binary reflected Gray code of the same width
HeapImplement the interfaces to the C standard library malloc(3), free(3), realloc(3) and calloc(3) functions but using the C++ new and delete operators
ImplementationThis is a pilot framework for a header file declaring an implementation class
InputDefines the interface to an input functor, an object, called like a function, which returns data from some data source
InputOutputDefines a class that offers both an input functor and an output functor interface
Iso3166Contains a table of country names, abbreviations, and country numbers conformant with the ISO 3166-1:1997 standard
Iso3166::EntryThis describes a single entry in the country-code table
JavaVirtualMachineCreates, strarts and destroys a Java Virtual Machine
LeapSecondsImplements an interface to determine the number of cumulative leap seconds for any given CommonEra date and time, used in the conversion between international atomic time (TAI) and coordinated universal time (UTC)
LinkImplements an object which can be inserted into and removed from a circular doubly-linked list, or chain, in which insertions and removals can be done in O(1) time, the head of the chain can be accessed in O(1) time, and a payload object can be on multiple chains simultaneously
Link::FunctorDefines an interface to a functor (an object that can be called like a function), that performs an operation on a link
LinkType< _TYPE_ >Offers a type-safe implemtation of Link by allowing the type of the link to be based on that of the payload object
LinkType< _TYPE_ >::FunctorDefines an interface to a functor (an object that can be called like a function), that performs an operation on a link
LinuxImplements the Platform interface to the Linux operating system
LocalTimeImplements a DataTime in local civilian time (LCT), taking into account leap seconds, time zone offset from UTC, and whether daylight saving time is in effect or not, when converting from a CommonEra DataTime
LoggerDefines a simple interface to a multi-level logging mechanism, and implements a simple logger using it
Maximum< _TYPE_ >Generates a class containing functors to find the maximum from a list of objects
MemoryBarrierInvokes the Desperado portable memory barrier function upon construction
MeterImplements a general mechanism for maintaining the running minimum, maximum, and mean of a ratio measurement, for example, a rate like cycles per second, kilometers per hour, or furlongs per fortnight
Minimum< _TYPE_ >Generates a class containing functors to find the maximum from a list of objects
MutexImplements a mutual exclusion lock, or mutex, for POSIX pthreads
NewCountersImplements a Counter object in which the counters are dynamically allocated
NewFifo< _TYPE_ >Implements a Fifo object in which the queue is dynamically allocated
Number< _TYPE_ >Generates a method to parse a character string and convert it into a binary integer of any integral type whose base is determined from its context, doing so in a slightly more robust manner than either atoi(3) or any of the strtol(3) variants
ObjectThis is the final base class for Desperado classes which implement a virtual destructor, a virtual initializer method, and a virtual show() method
OutputDefines the interface to an output functor, an object, called like a function, which writes data to some data sink
PathInputImplements an input functor that returns data from a C standard I/O library FILE object opened from a given path, the default path being a special one, "-", that denotes standard input
PathOutputImplements an output functor that writes data to a C standard I/O library FILE object opened from a given path, the default path being a special one, "-", that denotes standard output
PlatformDefines an interface to an underlying operating system
com::diag::desperado::PlatformThis class uses JNI to extend the Desperado Platform into the Java world
PrintImplements a printf(3)-style functor that can be used to format a variadic argument list and write it to an output functor
Ram< _TYPE_ >Generates a suite of memory diagnostics for a memory architecture with a width of any integral type, based on Michael Barr's memtest functions as described in his article on software-based memory testing
ServiceImplements a factory that creates sockets for service providers (server side) or service consumers (client side)
StreamSocketImplements an input/output functor that manages a stream socket
SyslogOutputImplements an output functor that writes to the Linux system log file using syslog(3), conspiring with the Logger class to pass along the priority of each log message
ThrottleImplements a generic interface to a throttle, an object which maintains state to control the rate at which some event is allowed to occur or "be admitted"; this particular throttle always admits every event
TicksImplements methods to convert Platform ticks_t to other representations of time duration
TimeImplements an object that contains a time with fields of sufficient size to contain a coordinated universal time hour, minute, second, and nanosecond
TimeStampImplements methods to represent CommonEra and LocalTime dates and times as printable timestamps in a variety of formats
TimeZoneDefines time zone offsets and implements conversions of these offsets into printable strings indicating a time zone
TimeZone::HoursDefines time zone offsets in hours
TimeZone::SecondsDefines time zone offsets in seconds
TimeZone::SuffixDefines time zone offsets as NATO-comformant suffixes
TransliteratorImplements a table driven transliterator useful in constructing pretty complex yet efficient parsers, implementing two interfaces: one for parsing from a buffer, another for parsing from an input functor
TransliteratorType< _CONTEXTS_ >Defines a template that generates a Transliterator class in which the context stack of the specified size is integral to the object
com::diag::desperado::UnitTestJavaVirtualMachineThis class is part of the Desperado JavaVirtualMachine unit test
VintageContains static variables with control information about this product
WordUses a Transliterator to implement a parser that extracts words from a buffer or an input functor
Copyright © 2006 Digital Aggregates Corp., Arvada CO 80001-0587, USA.
Distributed under the terms of the GNU Free Documentation License.
http://www.diag.com/navigation/downloads/Desperado.html