<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Barry: barry.h Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_3e14c0bb4416cf979afc3165665fc916.html">src</a>
</div>
</div>
<div class="contents">
<h1>barry.h</h1><a href="barry_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file barry.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Main header file for applications</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2005-2011, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00019"></a>00019 <span class="comment"> root directory of this project for more details.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef __BARRY_BARRY_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_BARRY_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00025"></a>00025 <span class="comment">/**</span>
<a name="l00026"></a>00026 <span class="comment"></span>
<a name="l00027"></a>00027 <span class="comment"> \mainpage Barry Reference Manual</span>
<a name="l00028"></a>00028 <span class="comment"></span>
<a name="l00029"></a>00029 <span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment"> \section getting_started Getting Started</span>
<a name="l00031"></a>00031 <span class="comment"></span>
<a name="l00032"></a>00032 <span class="comment"> Welcome to the Barry reference manual. This entire manual was</span>
<a name="l00033"></a>00033 <span class="comment"> generated via Doxygen from comments in the code. You can view</span>
<a name="l00034"></a>00034 <span class="comment"> the code here as well, in the Files section.</span>
<a name="l00035"></a>00035 <span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment"> The best place to get started at the moment is to examine the</span>
<a name="l00037"></a>00037 <span class="comment"> source code to the Barry command line tool: btool.cc</span>
<a name="l00038"></a>00038 <span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment"></span>
<a name="l00040"></a>00040 <span class="comment"> \section classes Major Classes</span>
<a name="l00041"></a>00041 <span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment"> To get started with the API, see the Barry::Controller class.</span>
<a name="l00043"></a>00043 <span class="comment"></span>
<a name="l00044"></a>00044 <span class="comment">*/</span>
<a name="l00045"></a>00045
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="comment">// This lists all the headers that the application needs.</span>
<a name="l00048"></a>00048 <span class="comment">// Only these headers get installed.</span>
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="preprocessor">#include "<a class="code" href="data_8h.html" title="Class to deal with pre-saved data files.">data.h</a>"</span>
<a name="l00051"></a>00051 <span class="preprocessor">#include "<a class="code" href="usbwrap_8h.html" title="USB API wrapper.">usbwrap.h</a>"</span> <span class="comment">// to be moved to libusb someday</span>
<a name="l00052"></a>00052 <span class="preprocessor">#include "<a class="code" href="common_8h.html" title="General header for the Barry library.">common.h</a>"</span> <span class="comment">// Init()</span>
<a name="l00053"></a>00053 <span class="preprocessor">#include "<a class="code" href="error_8h.html" title="Common exception classes for the Barry library.">error.h</a>"</span> <span class="comment">// exceptions</span>
<a name="l00054"></a>00054 <span class="preprocessor">#include "<a class="code" href="configfile_8h.html" title="Barry configuraion class, for one device PIN.">configfile.h</a>"</span>
<a name="l00055"></a>00055 <span class="preprocessor">#include "<a class="code" href="probe_8h.html" title="USB Blackberry detection routines.">probe.h</a>"</span> <span class="comment">// device prober class</span>
<a name="l00056"></a>00056 <span class="preprocessor">#include "<a class="code" href="dataqueue_8h.html" title="FIFO queue of Data objects.">dataqueue.h</a>"</span>
<a name="l00057"></a>00057 <span class="preprocessor">#include "<a class="code" href="socket_8h.html" title="Class wrapper to encapsulate the Blackberry USB logical socket.">socket.h</a>"</span>
<a name="l00058"></a>00058 <span class="preprocessor">#include "<a class="code" href="router_8h.html" title="Support classes for the pluggable socket routing system.">router.h</a>"</span>
<a name="l00059"></a>00059 <span class="preprocessor">#include "<a class="code" href="protocol_8h.html" title="USB Blackberry bulk protocol API constants.">protocol.h</a>"</span> <span class="comment">// application-safe header</span>
<a name="l00060"></a>00060 <span class="preprocessor">#include "<a class="code" href="parser_8h.html" title="Virtual parser wrapper.">parser.h</a>"</span>
<a name="l00061"></a>00061 <span class="preprocessor">#include "<a class="code" href="builder_8h.html" title="Virtual protocol packet builder wrapper.">builder.h</a>"</span>
<a name="l00062"></a>00062 <span class="preprocessor">#include "<a class="code" href="ldif_8h.html" title="Routines for reading and writing LDAP LDIF data.">ldif.h</a>"</span>
<a name="l00063"></a>00063 <span class="preprocessor">#include "<a class="code" href="ldifio_8h.html" title="Storage, parser, and builder classes for ldif operations.">ldifio.h</a>"</span>
<a name="l00064"></a>00064 <span class="preprocessor">#include "<a class="code" href="controller_8h.html" title="High level BlackBerry API class.">controller.h</a>"</span>
<a name="l00065"></a>00065 <span class="preprocessor">#include "<a class="code" href="m__desktop_8h.html" title="Mode class for the Desktop mode.">m_desktop.h</a>"</span>
<a name="l00066"></a>00066 <span class="preprocessor">#include "<a class="code" href="m__ipmodem_8h.html" title="Mode class for GPRS modem mode (using endpoints on modern devices).">m_ipmodem.h</a>"</span>
<a name="l00067"></a>00067 <span class="preprocessor">#include "<a class="code" href="m__serial_8h.html" title="Mode class for serial / GPRS modem mode.">m_serial.h</a>"</span>
<a name="l00068"></a>00068 <span class="preprocessor">#include "<a class="code" href="m__javaloader_8h.html" title="Mode class for the JavaLoader mode.">m_javaloader.h</a>"</span>
<a name="l00069"></a>00069 <span class="preprocessor">#include "<a class="code" href="m__raw__channel_8h.html" title="Mode class for a raw channel.">m_raw_channel.h</a>"</span>
<a name="l00070"></a>00070 <span class="preprocessor">#include "<a class="code" href="m__jvmdebug_8h.html" title="Mode class for the JVMDebug mode.">m_jvmdebug.h</a>"</span>
<a name="l00071"></a>00071 <span class="preprocessor">#include "<a class="code" href="version_8h.html" title="Provide access to library version information.">version.h</a>"</span>
<a name="l00072"></a>00072 <span class="preprocessor">#include "<a class="code" href="log_8h.html" title="General header for the Barry library.">log.h</a>"</span>
<a name="l00073"></a>00073 <span class="preprocessor">#include "sha1.h"</span>
<a name="l00074"></a>00074 <span class="preprocessor">#include "<a class="code" href="iconv_8h.html" title="iconv wrapper class, and pluggable interface for records">iconv.h</a>"</span>
<a name="l00075"></a>00075 <span class="preprocessor">#include "<a class="code" href="bmp_8h.html" title="BMP conversion routines.">bmp.h</a>"</span>
<a name="l00076"></a>00076 <span class="preprocessor">#include "<a class="code" href="cod_8h.html" title="COD file API.">cod.h</a>"</span>
<a name="l00077"></a>00077 <span class="preprocessor">#include "<a class="code" href="record_8h.html" title="Blackberry database record classes.">record.h</a>"</span>
<a name="l00078"></a>00078 <span class="preprocessor">#include "<a class="code" href="threadwrap_8h.html" title="RAII Wrapper for a single thread.">threadwrap.h</a>"</span>
<a name="l00079"></a>00079 <span class="preprocessor">#include "vsmartptr.h"</span>
<a name="l00080"></a>00080 <span class="preprocessor">#include "<a class="code" href="pipe_8h.html" title="Connector class to join parsers and builders together.">pipe.h</a>"</span>
<a name="l00081"></a>00081 <span class="preprocessor">#include "connector.h"</span>
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="comment">// Include the JDW Debug Parser classes</span>
<a name="l00084"></a>00084 <span class="preprocessor">#include "<a class="code" href="dp__codinfo_8h.html" title="Debug file parsing.">dp_codinfo.h</a>"</span>
<a name="l00085"></a>00085
<a name="l00086"></a>00086 <span class="comment">// Include the JDWP Server classes</span>
<a name="l00087"></a>00087 <span class="preprocessor">#include "<a class="code" href="j__manager_8h.html" title="Application management classes.">j_manager.h</a>"</span>
<a name="l00088"></a>00088 <span class="preprocessor">#include "<a class="code" href="j__server_8h.html" title="Java Debug server classes.">j_server.h</a>"</span>
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="comment">// Include the template helpers after the record classes</span>
<a name="l00091"></a>00091 <span class="preprocessor">#include "<a class="code" href="m__desktoptmpl_8h.html" title="Ease of use templates for the Desktop mode class.">m_desktoptmpl.h</a>"</span>
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="preprocessor">#ifdef __BARRY_BOOST_MODE__</span>
<a name="l00094"></a>00094 <span class="preprocessor"></span><span class="comment">// Boost serialization seems to be picky about header order, do them all here</span>
<a name="l00095"></a>00095 <span class="preprocessor">#include <iomanip></span>
<a name="l00096"></a>00096 <span class="preprocessor">#include <iostream></span>
<a name="l00097"></a>00097 <span class="preprocessor">#include <fstream></span>
<a name="l00098"></a>00098 <span class="preprocessor">#include <vector></span>
<a name="l00099"></a>00099 <span class="preprocessor">#include <string></span>
<a name="l00100"></a>00100 <span class="preprocessor">#include <boost/archive/text_iarchive.hpp></span>
<a name="l00101"></a>00101 <span class="preprocessor">#include <boost/archive/text_oarchive.hpp></span>
<a name="l00102"></a>00102 <span class="preprocessor">#include <boost/archive/archive_exception.hpp></span>
<a name="l00103"></a>00103 <span class="preprocessor">#include "<a class="code" href="s11n-boost_8h.html" title="Non-intrusive versions of serialization functions for the record classes.">s11n-boost.h</a>"</span>
<a name="l00104"></a>00104 <span class="preprocessor">#endif</span>
<a name="l00105"></a>00105 <span class="preprocessor"></span>
<a name="l00106"></a>00106 <span class="preprocessor">#endif</span>
<a name="l00107"></a>00107 <span class="preprocessor"></span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:50:14 2011 for Barry by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
