doc/www/doxygen/html/annotated.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
   3 <title>Barry: Class List</title>
   4 <link href="doxygen.css" rel="stylesheet" type="text/css">
   5 <link href="tabs.css" rel="stylesheet" type="text/css">
   6 </head><body>
   7 <!-- Generated by Doxygen 1.5.6 -->
   8 <div class="navigation" id="top">
   9   <div class="tabs">
  10     <ul>
  11       <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
  12       <li><a href="modules.html"><span>Modules</span></a></li>
  13       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  14       <li class="current"><a href="classes.html"><span>Classes</span></a></li>
  15       <li><a href="files.html"><span>Files</span></a></li>
  16       <li><a href="dirs.html"><span>Directories</span></a></li>
  17     </ul>
  18   </div>
  19   <div class="tabs">
  20     <ul>
  21       <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
  22       <li class="current"><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
  23       <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
  24       <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  25     </ul>
  26   </div>
  27 </div>
  28 <div class="contents">
  29 <h1>Class List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<table>
  30   <tr><td class="indexkey"><a class="el" href="classBarry_1_1AllRecordDumpStore.html">Barry::AllRecordDumpStore</a></td><td class="indexvalue">Derived from <a class="el" href="classBarry_1_1AllRecordStore.html" title="Base class with overloaded functor behaviour for all available record classes.">AllRecordStore</a>, which just calls each record's Dump() member with the given stream </td></tr>
  31   <tr><td class="indexkey"><a class="el" href="classBarry_1_1AllRecordParser.html">Barry::AllRecordParser</a></td><td class="indexvalue">Convenience parser that creates a <a class="el" href="classBarry_1_1MultiRecordParser.html" title="Container parser class that accepts multiple Parser objects (often RecordParser&lt;&gt;...">MultiRecordParser</a> with all known record parsers added </td></tr>
  32   <tr><td class="indexkey"><a class="el" href="classBarry_1_1AllRecordStore.html">Barry::AllRecordStore</a></td><td class="indexvalue">Base class with overloaded functor behaviour for all available record classes </td></tr>
  33   <tr><td class="indexkey"><a class="el" href="classBarry_1_1BackupError.html">Barry::BackupError</a></td><td class="indexvalue">Thrown by the Backup parser class when there is a problem with the low level file operation </td></tr>
  34   <tr><td class="indexkey"><a class="el" href="classBarry_1_1BadData.html">Barry::BadData</a></td><td class="indexvalue">Thrown by record classes if their data is invalid and cannot be uploaded to the Blackberry </td></tr>
  35   <tr><td class="indexkey"><a class="el" href="classBarry_1_1BadPackedFormat.html">Barry::BadPackedFormat</a></td><td class="indexvalue">Thrown by record classes that don't recognize a given packed format code </td></tr>
  36   <tr><td class="indexkey"><a class="el" href="classBarry_1_1BadPacket.html">Barry::BadPacket</a></td><td class="indexvalue">Thrown by the socket class if a packet command's response indicates an error </td></tr>
  37   <tr><td class="indexkey"><a class="el" href="classBarry_1_1BadPassword.html">Barry::BadPassword</a></td><td class="indexvalue">A bad or unknown password when talking to the device </td></tr>
  38   <tr><td class="indexkey"><a class="el" href="classBarry_1_1BadSize.html">Barry::BadSize</a></td><td class="indexvalue">Unexpected packet size, or not enough data </td></tr>
  39   <tr><td class="indexkey"><a class="el" href="classBarry_1_1BoostBuilder.html">Barry::BoostBuilder</a></td><td class="indexvalue">This <a class="el" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a> class reads a boost serialization stream, and converts them into <a class="el" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> records </td></tr>
  40   <tr><td class="indexkey"><a class="el" href="classBarry_1_1BoostParser.html">Barry::BoostParser</a></td><td class="indexvalue">This <a class="el" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> turns incoming records (which can be of any record type included in ALL_KNOWN_PARSER_TYPES) into a Boost Serialization stream on the given iostream </td></tr>
  41   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Builder.html">Barry::Builder</a></td><td class="indexvalue">Base class for the builder functor hierarchy </td></tr>
  42   <tr><td class="indexkey"><a class="el" href="classBarry_1_1CodFileBuilder.html">Barry::CodFileBuilder</a></td><td class="indexvalue">Used to assemble multiple .cod files into a single packed .cod file using the pkzip file format </td></tr>
  43   <tr><td class="indexkey"><a class="el" href="classBarry_1_1ConfigFileError.html">Barry::ConfigFileError</a></td><td class="indexvalue">Thrown by the ConfigFile class when encountering a serious system error while loading the global config file for a given PIN </td></tr>
  44   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Contact.html">Barry::Contact</a></td><td class="indexvalue">Represents a single record in the Address Book Blackberry database </td></tr>
  45   <tr><td class="indexkey"><a class="el" href="classBarry_1_1ContactLdif.html">Barry::ContactLdif</a></td><td class="indexvalue">Class for generating LDIF output based on a <a class="el" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> record object </td></tr>
  46   <tr><td class="indexkey"><a class="el" href="structBarry_1_1ContactLdif_1_1NameToFunc.html">Barry::ContactLdif::NameToFunc</a></td><td class="indexvalue">Used to create a List of supported <a class="el" href="namespaceBarry.html" title="Project namespace, containing all related functions and classes.">Barry</a> field names, including calculated names, such as full postal address </td></tr>
  47   <tr><td class="indexkey"><a class="el" href="classBarry_1_1ContentStore.html">Barry::ContentStore</a></td><td class="indexvalue">Represents a single record in the Content Store Blackberry database </td></tr>
  48   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Controller.html">Barry::Controller</a></td><td class="indexvalue">The main interface class </td></tr>
  49   <tr><td class="indexkey"><a class="el" href="classBarry_1_1ConvertError.html">Barry::ConvertError</a></td><td class="indexvalue">Thrown by the vformat related barrysync library classes </td></tr>
  50   <tr><td class="indexkey"><a class="el" href="classBarry_1_1DataHandle.html">Barry::DataHandle</a></td><td class="indexvalue">Std::auto_ptr like class that handles pointers to Data, but instead of freeing them completely, the Data objects are turned to the SocketRoutingQueue from whence they came </td></tr>
  51   <tr><td class="indexkey"><a class="el" href="classBarry_1_1DataQueue.html">Barry::DataQueue</a></td><td class="indexvalue">This class provides a thread aware fifo queue for Data objects, providing memory management for all Data object pointers it contains </td></tr>
  52   <tr><td class="indexkey"><a class="el" href="classBarry_1_1DBData.html">Barry::DBData</a></td><td class="indexvalue">Database record data class </td></tr>
  53   <tr><td class="indexkey"><a class="el" href="classBarry_1_1DBDataBuilder.html">Barry::DBDataBuilder</a></td><td class="indexvalue">Wrapper class around a <a class="el" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> object, to make it easy to pass a <a class="el" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> object into a function or API that requires a builder </td></tr>
  54   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Mode_1_1DBLoader.html">Barry::Mode::DBLoader</a></td><td class="indexvalue">Database Loader operation class </td></tr>
  55   <tr><td class="indexkey"><a class="el" href="classBarry_1_1DBPacket.html">Barry::DBPacket</a></td><td class="indexvalue">Provides an API for building and analyzing raw DB protocol packets </td></tr>
  56   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Mode_1_1Desktop.html">Barry::Mode::Desktop</a></td><td class="indexvalue">The main interface class to the device databases </td></tr>
  57   <tr><td class="indexkey"><a class="el" href="classBarry_1_1DeviceBuilder.html">Barry::DeviceBuilder</a></td><td class="indexvalue">Takes a list of database dbId's and behaves like a <a class="el" href="classBarry_1_1Builder.html" title="Base class for the builder functor hierarchy.">Builder</a>, trying to avoid copies where possible on the device loading end </td></tr>
  58   <tr><td class="indexkey"><a class="el" href="classBarry_1_1DeviceParser.html">Barry::DeviceParser</a></td><td class="indexvalue">A parser class that "parses" raw data into a device </td></tr>
  59   <tr><td class="indexkey"><a class="el" href="classBarry_1_1DumpStore.html">Barry::DumpStore&lt; RecordT &gt;</a></td><td class="indexvalue">A Storage class for RecordParser&lt;&gt; that dumps the parsed record data to the given stream </td></tr>
  60   <tr><td class="indexkey"><a class="el" href="classBarry_1_1ErrnoError.html">Barry::ErrnoError</a></td><td class="indexvalue">System error that provides an errno error code </td></tr>
  61   <tr><td class="indexkey"><a class="el" href="classBarry_1_1JDWP_1_1Error.html">Barry::JDWP::Error</a></td><td class="indexvalue">Thrown on low level JDWP errors </td></tr>
  62   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Error.html">Barry::Error</a></td><td class="indexvalue">The base class for any future derived exceptions </td></tr>
  63   <tr><td class="indexkey"><a class="el" href="classUsb_1_1Error.html">Usb::Error</a></td><td class="indexvalue">Thrown on low level USB errors </td></tr>
  64   <tr><td class="indexkey"><a class="el" href="classBarry_1_1HexDumpParser.html">Barry::HexDumpParser</a></td><td class="indexvalue">Dumps raw hex of the given <a class="el" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> to the given stream </td></tr>
  65   <tr><td class="indexkey"><a class="el" href="classBarry_1_1IConverter.html">Barry::IConverter</a></td><td class="indexvalue">Main charset conversion class, primarily focused on converting between the Blackberry charset and an application-specified one </td></tr>
  66   <tr><td class="indexkey"><a class="el" href="classBarry_1_1IConvHandle.html">Barry::IConvHandle</a></td><td class="indexvalue">Wrapper class for a two-way iconv_t handle pair </td></tr>
  67   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Mode_1_1JavaLoader.html">Barry::Mode::JavaLoader</a></td><td class="indexvalue">The main interface class to the java program loader protocol </td></tr>
  68   <tr><td class="indexkey"><a class="el" href="classBarry_1_1JLPacket.html">Barry::JLPacket</a></td><td class="indexvalue">Provides an API for building and analyzing raw Javaloader protocol packets </td></tr>
  69   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Mode_1_1JVMDebug.html">Barry::Mode::JVMDebug</a></td><td class="indexvalue">The main interface class to the java program debugger protocol </td></tr>
  70   <tr><td class="indexkey"><a class="el" href="classBarry_1_1JVMPacket.html">Barry::JVMPacket</a></td><td class="indexvalue">Provides an API for building and analyzing raw JavaDebug protocol packets </td></tr>
  71   <tr><td class="indexkey"><a class="el" href="classBarry_1_1LdifStore.html">Barry::LdifStore</a></td><td class="indexvalue">Storage class suitable for use in a RecordParser&lt;&gt; or RecordBuilder&lt;&gt; </td></tr>
  72   <tr><td class="indexkey"><a class="el" href="classBarry_1_1LogLock.html">Barry::LogLock</a></td><td class="indexvalue">RAII locking class used to protect the logStream passed into <a class="el" href="namespaceBarry.html#2e28bd59aebe0bece5a46f02ef7dbd3d" title="Barry library initializer.">Barry::Init()</a> (<a class="el" href="common_8h.html" title="General header for the Barry library.">common.h</a>) </td></tr>
  73   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Mode_1_1Mode.html">Barry::Mode::Mode</a></td><td class="indexvalue">Base class for simple mode classes </td></tr>
  74   <tr><td class="indexkey"><a class="el" href="classBarry_1_1MultiRecordParser.html">Barry::MultiRecordParser</a></td><td class="indexvalue">Container parser class that accepts multiple <a class="el" href="classBarry_1_1Parser.html" title="Base class for the parser hierarchy.">Parser</a> objects (often RecordParser&lt;&gt; objects but they don't have to be) and automatically routes incoming records to the appropriate parser </td></tr>
  75   <tr><td class="indexkey"><a class="el" href="classBarry_1_1NullParser.html">Barry::NullParser</a></td><td class="indexvalue">If in debug mode, this class can be used as a null parser </td></tr>
  76   <tr><td class="indexkey"><a class="el" href="classBarry_1_1NullStore.html">Barry::NullStore&lt; RecordT &gt;</a></td><td class="indexvalue">A Storage class for RecordParser&lt;&gt; that does nothing, for the cases where you only want to dump parsed record data to a stream </td></tr>
  77   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Parser.html">Barry::Parser</a></td><td class="indexvalue">Base class for the parser hierarchy </td></tr>
  78   <tr><td class="indexkey"><a class="el" href="classBarry_1_1PinNotFound.html">Barry::PinNotFound</a></td><td class="indexvalue">Thrown by the Connector class when unable to find the requested Pin If the attached pin is not Valid(), then unable to autodetect device </td></tr>
  79   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Pipe.html">Barry::Pipe</a></td><td class="indexvalue">Reads data from a builder and feeds it into a parser </td></tr>
  80   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Mode_1_1RawChannel.html">Barry::Mode::RawChannel</a></td><td class="indexvalue">The main class for creating a raw channel session </td></tr>
  81   <tr><td class="indexkey"><a class="el" href="classBarry_1_1RecordBuilder.html">Barry::RecordBuilder&lt; RecordT, StorageT &gt;</a></td><td class="indexvalue">Template class for easy creation of specific protocol packet builder objects </td></tr>
  82   <tr><td class="indexkey"><a class="el" href="classBarry_1_1RecordFetch.html">Barry::RecordFetch&lt; RecordT &gt;</a></td><td class="indexvalue">Generic record fetch class, to help with using records without builder classes </td></tr>
  83   <tr><td class="indexkey"><a class="el" href="classBarry_1_1RecordParser.html">Barry::RecordParser&lt; RecordT, StorageT &gt;</a></td><td class="indexvalue">Template class for easy creation of specific parser objects </td></tr>
  84   <tr><td class="indexkey"><a class="el" href="classBarry_1_1RecordParserBase.html">Barry::RecordParserBase</a></td><td class="indexvalue">Abstract base class for the following <a class="el" href="classBarry_1_1RecordParser.html" title="Template class for easy creation of specific parser objects.">RecordParser</a> template, that exposes some information on the specifics that the record parser can handle </td></tr>
  85   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Restore.html">Barry::Restore</a></td><td class="indexvalue"><a class="el" href="namespaceBarry.html" title="Project namespace, containing all related functions and classes.">Barry</a> Backup <a class="el" href="classBarry_1_1Restore.html" title="Barry Backup Restore builder class.">Restore</a> builder class </td></tr>
  86   <tr><td class="indexkey"><a class="el" href="classBarry_1_1RestoreError.html">Barry::RestoreError</a></td><td class="indexvalue">Thrown by the <a class="el" href="classBarry_1_1Restore.html" title="Barry Backup Restore builder class.">Restore</a> builder class when there is a problem with the low level file operation </td></tr>
  87   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Socket.html">Barry::Socket</a></td><td class="indexvalue">Encapsulates a "logical socket" in the Blackberry USB protocol </td></tr>
  88   <tr><td class="indexkey"><a class="el" href="classBarry_1_1TeeParser.html">Barry::TeeParser</a></td><td class="indexvalue">Sends incoming <a class="el" href="classBarry_1_1DBData.html" title="Database record data class.">DBData</a> objects to all the parsers in its list </td></tr>
  89   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Sync_1_1TzWrapper.html">Barry::Sync::TzWrapper</a></td><td class="indexvalue">Wrapper class for the TZ environment variable </td></tr>
  90   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Sync_1_1vAttr.html">Barry::Sync::vAttr</a></td><td class="indexvalue">Class for reading a b_VFormatAttribute </td></tr>
  91   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Sync_1_1vBase.html">Barry::Sync::vBase</a></td><td class="indexvalue">Base class containing vformat helper API </td></tr>
  92   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Sync_1_1vCalendar.html">Barry::Sync::vCalendar</a></td><td class="indexvalue">Class for converting between RFC 2445 iCalendar data format, and the Barry::Calendar class </td></tr>
  93   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Sync_1_1vCard.html">Barry::Sync::vCard</a></td><td class="indexvalue">Class for converting between RFC 2425/2426 <a class="el" href="classBarry_1_1Sync_1_1vCard.html" title="Class for converting between RFC 2425/2426 vCard data format, and the Barry::Contact...">vCard</a> data format, and the <a class="el" href="classBarry_1_1Contact.html" title="Represents a single record in the Address Book Blackberry database.">Barry::Contact</a> class </td></tr>
  94   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Sync_1_1vJournal.html">Barry::Sync::vJournal</a></td><td class="indexvalue">Class for converting between RFC 2445 iCalendar data format, and the Barry::Memo class </td></tr>
  95   <tr><td class="indexkey"><a class="el" href="classBarry_1_1vLateSmartPtr.html">Barry::vLateSmartPtr&lt; T, FreeFuncPtrT &gt;</a></td><td class="indexvalue">Variation of the above smart pointer that allows the user to assign a free function after construction, in the case of dlopen()'d frees </td></tr>
  96   <tr><td class="indexkey"><a class="el" href="classBarry_1_1vSmartPtr.html">Barry::vSmartPtr&lt; T, FT, FreeFunc &gt;</a></td><td class="indexvalue">A special smart pointer for variables that have their own special 'free' functions </td></tr>
  97   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Sync_1_1vTimeConverter.html">Barry::Sync::vTimeConverter</a></td><td class="indexvalue">A virtual base class that the plugins may override, to do time related conversions </td></tr>
  98   <tr><td class="indexkey"><a class="el" href="classBarry_1_1Sync_1_1vTodo.html">Barry::Sync::vTodo</a></td><td class="indexvalue">Class for converting between RFC 2445 iCalendar data format, and the Barry::Task class </td></tr>
  99   <tr><td class="indexkey"><a class="el" href="classBarry_1_1ZeroPacket.html">Barry::ZeroPacket</a></td><td class="indexvalue">Provides an API for building and analyzing socket-0 protocol packets </td></tr>
 100 </table>
 101 </div>
 102 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:14:33 2011 for Barry by&nbsp;
 103 <a href="http://www.doxygen.org/index.html">
 104 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 105 </body>
 106 </html>