<!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: m_raw_channel.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>m_raw_channel.h</h1><a href="m__raw__channel_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 m_raw_channel.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Mode class for a raw channel</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"> Portions Copyright (C) 2010 RealVNC Ltd.</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00011"></a>00011 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00012"></a>00012 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00013"></a>00013 <span class="comment"> (at your option) any later version.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00016"></a>00016 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00017"></a>00017 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00018"></a>00018 <span class="comment"></span>
<a name="l00019"></a>00019 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00020"></a>00020 <span class="comment"> root directory of this project for more details.</span>
<a name="l00021"></a>00021 <span class="comment">*/</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef __BARRY_M_RAW_CHANNEL_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_M_RAW_CHANNEL_H__</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="m__mode__base_8h.html" title="Base for mode classes.">m_mode_base.h</a>"</span>
<a name="l00028"></a>00028 <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="l00029"></a>00029 <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="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#include <string></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <pthread.h></span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">namespace </span>Barry {
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="keyword">class </span>semaphore;
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="keyword">namespace </span>Mode {
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="comment">// Forward declaration of internal classes</span>
<a name="l00041"></a>00041 <span class="keyword">class </span>RawChannelSocketHandler;
<a name="l00042"></a>00042 <span class="keyword">class </span>RawChannelZeroSocketHandler;
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="comment">// Callback from the raw channel.</span>
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="keyword">class </span>BXEXPORT RawChannelDataCallback
<a name="l00047"></a>00047 {
<a name="l00048"></a>00048 <span class="keyword">public</span>:
<a name="l00049"></a>00049 <span class="keyword">virtual</span> ~RawChannelDataCallback() {}
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="comment">// Called when data has been received on the channel</span>
<a name="l00052"></a>00052 <span class="keyword">virtual</span> <span class="keywordtype">void</span> DataReceived(Data &data) = 0;
<a name="l00053"></a>00053 <span class="comment">// Called when the channel has an error</span>
<a name="l00054"></a>00054 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ChannelError(std::string msg) = 0;
<a name="l00055"></a>00055 <span class="comment">// Called when the channel has been asked to close by the other side</span>
<a name="l00056"></a>00056 <span class="keyword">virtual</span> <span class="keywordtype">void</span> ChannelClose() = 0;
<a name="l00057"></a>00057 };
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="comment">//</span>
<a name="l00060"></a>00060 <span class="comment">// Raw channel class</span>
<a name="l00061"></a>00061 <span class="comment">//</span><span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment">/// The main class for creating a raw channel session.</span>
<a name="l00063"></a>00063 <span class="comment">///</span>
<a name="l00064"></a>00064 <span class="comment">/// To use this class, use the following steps:</span>
<a name="l00065"></a>00065 <span class="comment">///</span>
<a name="l00066"></a>00066 <span class="comment">/// - Implement RawChannelDataCallback</span>
<a name="l00067"></a>00067 <span class="comment">/// - Create a Controller object (see Controller class for more details)</span>
<a name="l00068"></a>00068 <span class="comment">/// - Create this Mode::RawChannel object, passing in the Controller</span>
<a name="l00069"></a>00069 <span class="comment">/// object during construction</span>
<a name="l00070"></a>00070 <span class="comment">/// - Call Open() to open the channel and finish constructing.</span>
<a name="l00071"></a>00071 <span class="comment">/// - Call GetData() to fetch data</span>
<a name="l00072"></a>00072 <span class="comment">/// - Call SendData() to send data</span>
<a name="l00073"></a>00073 <span class="comment">///</span>
<a name="l00074"></a><a class="code" href="classBarry_1_1Mode_1_1RawChannel.html">00074</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Mode_1_1RawChannel.html" title="The main class for creating a raw channel session.">RawChannel</a> : <span class="keyword">public</span> <a class="code" href="classBarry_1_1Mode_1_1Mode.html" title="Base class for simple mode classes.">Mode</a>
<a name="l00075"></a>00075 {
<a name="l00076"></a>00076 <span class="keyword">friend</span> <span class="keyword">class </span>RawChannelSocketHandler;
<a name="l00077"></a>00077 <span class="keyword">friend</span> <span class="keyword">class </span>RawChannelZeroSocketHandler;
<a name="l00078"></a>00078
<a name="l00079"></a>00079 <span class="comment">// Mutex for signalling between read and write threads</span>
<a name="l00080"></a>00080 pthread_mutex_t m_mutex;
<a name="l00081"></a>00081 <span class="keywordtype">bool</span> m_mutex_valid;
<a name="l00082"></a>00082 <span class="comment">// Condvar for signalling between read and write threads</span>
<a name="l00083"></a>00083 pthread_cond_t m_cv;
<a name="l00084"></a>00084 <span class="keywordtype">bool</span> m_cv_valid;
<a name="l00085"></a>00085
<a name="l00086"></a>00086 semaphore *m_semaphore;
<a name="l00087"></a>00087 RawChannelDataCallback *m_callback;
<a name="l00088"></a>00088 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *m_send_buffer;
<a name="l00089"></a>00089 <span class="keywordtype">bool</span> m_zero_registered;
<a name="l00090"></a>00090 std::string *m_pending_error;
<a name="l00091"></a>00091
<a name="l00092"></a>00092 Data m_receive_data;
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="keyword">protected</span>:
<a name="l00095"></a>00095 <span class="keywordtype">void</span> CheckQueueAvailable();
<a name="l00096"></a>00096 <span class="keywordtype">void</span> InitBuffer();
<a name="l00097"></a>00097 <span class="keywordtype">void</span> InitSemaphore();
<a name="l00098"></a>00098 <span class="keywordtype">void</span> SetPendingError(<span class="keyword">const</span> <span class="keywordtype">char</span> *msg);
<a name="l00099"></a>00099 <span class="keywordtype">void</span> UnregisterZeroSocketInterest();
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <span class="comment">// Used to validate a packet is a valid channel data packet</span>
<a name="l00102"></a>00102 <span class="keywordtype">void</span> ValidateDataPacket(Data &data);
<a name="l00103"></a>00103
<a name="l00104"></a>00104 <span class="comment">// Not intended for use by users of this class.</span>
<a name="l00105"></a>00105 <span class="comment">// Used for handling zero-socket packets.</span>
<a name="l00106"></a>00106 <span class="keywordtype">void</span> HandleReceivedZeroPacket(Data &data);
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="comment">// Not intended for use by users of this class.</span>
<a name="l00109"></a>00109 <span class="comment">// Instead data received will come in via the</span>
<a name="l00110"></a>00110 <span class="comment">// RawChannelDataCallback::DataReceived callback</span>
<a name="l00111"></a>00111 <span class="comment">// or using Receive().</span>
<a name="l00112"></a>00112 <span class="keywordtype">void</span> HandleReceivedData(Data &data);
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="comment">// Not intended for use by users of this class.</span>
<a name="l00115"></a>00115 <span class="keywordtype">void</span> HandleError(<a class="code" href="classBarry_1_1Error.html" title="The base class for any future derived exceptions.">Barry::Error</a> &data);
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="comment">// Not intended for use by users of this class.</span>
<a name="l00118"></a>00118 <span class="comment">// This method is called by the internals of</span>
<a name="l00119"></a>00119 <span class="comment">// Barry when setting up a connection.</span>
<a name="l00120"></a>00120 <span class="keywordtype">void</span> OnOpen();
<a name="l00121"></a>00121 <span class="keyword">public</span>:
<a name="l00122"></a>00122 <span class="comment">// Creates a raw channel in non-callback mode.</span>
<a name="l00123"></a>00123 <span class="comment">// This requires all data to be sent and received</span>
<a name="l00124"></a>00124 <span class="comment">// via calls to Send and Receive.</span>
<a name="l00125"></a>00125 <span class="comment">// As there are no notifications of data being</span>
<a name="l00126"></a>00126 <span class="comment">// available to send or receive, this is only recommended</span>
<a name="l00127"></a>00127 <span class="comment">// for use with synchronous protocols over the channel.</span>
<a name="l00128"></a>00128 <span class="comment">//</span>
<a name="l00129"></a>00129 <span class="comment">// Will throw a Barry::Error if the provided controller</span>
<a name="l00130"></a>00130 <span class="comment">// doesn't have a routing queue set.</span>
<a name="l00131"></a>00131 <a class="code" href="classBarry_1_1Mode_1_1RawChannel.html" title="The main class for creating a raw channel session.">RawChannel</a>(<a class="code" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> &con);
<a name="l00132"></a>00132
<a name="l00133"></a>00133 <span class="comment">// Creates a raw channel in callback mode.</span>
<a name="l00134"></a>00134 <span class="comment">// This requires all data to be sent via calls to Send, but</span>
<a name="l00135"></a>00135 <span class="comment">// the Receive method must never be called.</span>
<a name="l00136"></a>00136 <span class="comment">// Instead the DataReceive</span>
<a name="l00137"></a>00137 <span class="comment">//</span>
<a name="l00138"></a>00138 <span class="comment">// Will throw a Barry::Error if the provided controller</span>
<a name="l00139"></a>00139 <span class="comment">// doesn't have a routing queue set.</span>
<a name="l00140"></a>00140 <a class="code" href="classBarry_1_1Mode_1_1RawChannel.html" title="The main class for creating a raw channel session.">RawChannel</a>(<a class="code" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> &con, RawChannelDataCallback &callback);
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="keyword">virtual</span> ~<a class="code" href="classBarry_1_1Mode_1_1RawChannel.html" title="The main class for creating a raw channel session.">RawChannel</a>();
<a name="l00143"></a>00143 <span class="comment"></span>
<a name="l00144"></a>00144 <span class="comment"> //////////////////////////////////</span>
<a name="l00145"></a>00145 <span class="comment"></span> <span class="comment">// Raw channel mode specific methods</span>
<a name="l00146"></a>00146
<a name="l00147"></a>00147 <span class="comment">// Send some data on the raw channel.</span>
<a name="l00148"></a>00148 <span class="comment">// Will throw a Barry::Error if data is longer than</span>
<a name="l00149"></a>00149 <span class="comment">// MaximumPacketContentsSize or a Usb::Error if there</span>
<a name="l00150"></a>00150 <span class="comment">// is an underlying USB error.</span>
<a name="l00151"></a>00151 <span class="comment">//</span>
<a name="l00152"></a>00152 <span class="comment">// If using a raw channel in callback mode then care must be</span>
<a name="l00153"></a>00153 <span class="comment">// taken to ensure another thread is running during any calls</span>
<a name="l00154"></a>00154 <span class="comment">// to Send. See the comment in the constructor of RawChannel</span>
<a name="l00155"></a>00155 <span class="comment">// for further information.</span>
<a name="l00156"></a>00156 <span class="keywordtype">void</span> Send(Data &data, <span class="keywordtype">int</span> timeout = -1);
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="comment">// Receive some data on the raw channel.</span>
<a name="l00159"></a>00159 <span class="comment">// Will throw a Barry::Error if a disconnect occurs</span>
<a name="l00160"></a>00160 <span class="comment">// or a Usb::Error if there is an underlying USB error</span>
<a name="l00161"></a>00161 <span class="comment">// or a Usb::Timeout if the receive times out.</span>
<a name="l00162"></a>00162 <span class="comment">//</span>
<a name="l00163"></a>00163 <span class="comment">// Only valid to call this if the raw channel was created in non-callback</span>
<a name="l00164"></a>00164 <span class="comment">// mode. If this is called when the raw channel was created with a</span>
<a name="l00165"></a>00165 <span class="comment">// callback then a std::logic_error will be thrown.</span>
<a name="l00166"></a>00166 <span class="keywordtype">void</span> Receive(Data &data, <span class="keywordtype">int</span> timeout = -1);
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="comment">// Returns the maximum quantity of data which</span>
<a name="l00169"></a>00169 <span class="comment">// can be sent</span>
<a name="l00170"></a>00170 <span class="keywordtype">size_t</span> MaximumSendSize();
<a name="l00171"></a>00171 };
<a name="l00172"></a>00172
<a name="l00173"></a>00173 }} <span class="comment">// namespace Barry::Mode</span>
<a name="l00174"></a>00174
<a name="l00175"></a>00175 <span class="preprocessor">#endif</span>
<a name="l00176"></a>00176 <span class="preprocessor"></span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:50:15 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>
