doc/www/doxygen/html/m__serial_8cc-source.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: m_serial.cc Source File</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><a href="classes.html"><span>Classes</span></a></li>
  15       <li class="current"><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="navpath"><a class="el" href="dir_edc0f428e3eefcfdce9c25befd901c57.html">src</a>
  20   </div>
  21 </div>
  22 <div class="contents">
  23 <h1>m_serial.cc</h1><a href="m__serial_8cc.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
  24 <a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file       m_serial.cc</span>
  25 <a name="l00003"></a>00003 <span class="comment"></span><span class="comment">///             Mode class for serial / GPRS modem mode</span>
  26 <a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
  27 <a name="l00005"></a>00005 <span class="comment"></span>
  28 <a name="l00006"></a>00006 <span class="comment">/*</span>
  29 <a name="l00007"></a>00007 <span class="comment">    Copyright (C) 2008-2011, Net Direct Inc. (http://www.netdirect.ca/)</span>
  30 <a name="l00008"></a>00008 <span class="comment"></span>
  31 <a name="l00009"></a>00009 <span class="comment">    This program is free software; you can redistribute it and/or modify</span>
  32 <a name="l00010"></a>00010 <span class="comment">    it under the terms of the GNU General Public License as published by</span>
  33 <a name="l00011"></a>00011 <span class="comment">    the Free Software Foundation; either version 2 of the License, or</span>
  34 <a name="l00012"></a>00012 <span class="comment">    (at your option) any later version.</span>
  35 <a name="l00013"></a>00013 <span class="comment"></span>
  36 <a name="l00014"></a>00014 <span class="comment">    This program is distributed in the hope that it will be useful,</span>
  37 <a name="l00015"></a>00015 <span class="comment">    but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
  38 <a name="l00016"></a>00016 <span class="comment">    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
  39 <a name="l00017"></a>00017 <span class="comment"></span>
  40 <a name="l00018"></a>00018 <span class="comment">    See the GNU General Public License in the COPYING file at the</span>
  41 <a name="l00019"></a>00019 <span class="comment">    root directory of this project for more details.</span>
  42 <a name="l00020"></a>00020 <span class="comment">*/</span>
  43 <a name="l00021"></a>00021
  44 <a name="l00022"></a>00022 <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>
  45 <a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="controller_8h.html" title="High level BlackBerry API class.">controller.h</a>"</span>
  46 <a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="protostructs_8h.html" title="USB Blackberry bulk protocol API.">protostructs.h</a>"</span>
  47 <a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="endian_8h.html" title="Endian conversion macros.">endian.h</a>"</span>
  48 <a name="l00026"></a>00026 <span class="preprocessor">#include "debug.h"</span>
  49 <a name="l00027"></a>00027 <span class="preprocessor">#include &lt;stdexcept&gt;</span>
  50 <a name="l00028"></a>00028
  51 <a name="l00029"></a>00029 <span class="keyword">namespace </span>Barry { <span class="keyword">namespace </span>Mode {
  52 <a name="l00030"></a>00030 <span class="comment"></span>
  53 <a name="l00031"></a>00031 <span class="comment">//////////////////////////////////////////////////////////////////////////////</span>
  54 <a name="l00032"></a>00032 <span class="comment"></span><span class="comment">// Mode::Serial class</span>
  55 <a name="l00033"></a>00033
  56 <a name="l00034"></a>00034 Serial::Serial( Controller &amp;con,
  57 <a name="l00035"></a>00035                 DeviceDataCallback callback,
  58 <a name="l00036"></a>00036                 <span class="keywordtype">void</span> *callback_context)
  59 <a name="l00037"></a>00037         : m_con(con)
  60 <a name="l00038"></a>00038         , m_ModeSocket(0)
  61 <a name="l00039"></a>00039         , m_CtrlSocket(0)
  62 <a name="l00040"></a>00040         , m_callback(callback)
  63 <a name="l00041"></a>00041         , m_callback_context(callback_context)
  64 <a name="l00042"></a>00042 {
  65 <a name="l00043"></a>00043         <span class="keywordflow">if</span>( !m_con.HasQueue() )
  66 <a name="l00044"></a>00044                 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"A SocketRoutingQueue is required in the Controller class when using Mode::Serial."</span>);
  67 <a name="l00045"></a>00045 }
  68 <a name="l00046"></a>00046
  69 <a name="l00047"></a>00047 Serial::~Serial()
  70 <a name="l00048"></a>00048 {
  71 <a name="l00049"></a>00049 }
  72 <a name="l00050"></a>00050
  73 <a name="l00051"></a>00051 <span class="comment"></span>
  74 <a name="l00052"></a>00052 <span class="comment">//////////////////////////////////////////////////////////////////////////////</span>
  75 <a name="l00053"></a>00053 <span class="comment"></span><span class="comment">// protected API / static functions</span>
  76 <a name="l00054"></a>00054
  77 <a name="l00055"></a>00055 <span class="keywordtype">void</span> Serial::DataCallback(Serial &amp;ser, Data *data)
  78 <a name="l00056"></a>00056 {
  79 <a name="l00057"></a>00057         ddout(<span class="stringliteral">"Serial::DataCallback called"</span>);
  80 <a name="l00058"></a>00058
  81 <a name="l00059"></a>00059         <span class="keywordflow">if</span>( data-&gt;GetSize() &lt;= 4 )
  82 <a name="l00060"></a>00060                 <span class="keywordflow">return</span>; <span class="comment">// nothing to do</span>
  83 <a name="l00061"></a>00061
  84 <a name="l00062"></a>00062         <span class="comment">// call callback if available</span>
  85 <a name="l00063"></a>00063         <span class="keywordflow">if</span>( ser.m_callback ) {
  86 <a name="l00064"></a>00064                 (*ser.m_callback)(ser.m_callback_context,
  87 <a name="l00065"></a>00065                         data-&gt;GetData() + 4,
  88 <a name="l00066"></a>00066                         data-&gt;GetSize() - 4);
  89 <a name="l00067"></a>00067         }
  90 <a name="l00068"></a>00068 <span class="comment">//      else {</span>
  91 <a name="l00069"></a>00069 <span class="comment">//              // append data to readCache</span>
  92 <a name="l00070"></a>00070 <span class="comment">//              FIXME;</span>
  93 <a name="l00071"></a>00071 <span class="comment">//      }</span>
  94 <a name="l00072"></a>00072 }
  95 <a name="l00073"></a>00073
  96 <a name="l00074"></a>00074 <span class="keywordtype">void</span> Serial::CtrlCallback(Serial &amp;ser, Data *data)
  97 <a name="l00075"></a>00075 {
  98 <a name="l00076"></a>00076         <span class="comment">// just dump to stdout, and do nothing</span>
  99 <a name="l00077"></a>00077         ddout(<span class="stringliteral">"CtrlCallback received:\n"</span> &lt;&lt; *data);
 100 <a name="l00078"></a>00078 }
 101 <a name="l00079"></a>00079 <span class="comment"></span>
 102 <a name="l00080"></a>00080 <span class="comment">//////////////////////////////////////////////////////////////////////////////</span>
 103 <a name="l00081"></a>00081 <span class="comment"></span><span class="comment">// public API</span>
 104 <a name="l00082"></a>00082
 105 <a name="l00083"></a>00083 <span class="keywordtype">void</span> Serial::Open(<span class="keyword">const</span> <span class="keywordtype">char</span> *password)
 106 <a name="l00084"></a>00084 {
 107 <a name="l00085"></a>00085         <span class="keywordflow">if</span>( m_ModeSocket ) {
 108 <a name="l00086"></a>00086                 m_data-&gt;Close();
 109 <a name="l00087"></a>00087                 m_data.reset();
 110 <a name="l00088"></a>00088                 m_ModeSocket = 0;
 111 <a name="l00089"></a>00089         }
 112 <a name="l00090"></a>00090
 113 <a name="l00091"></a>00091         <span class="keywordflow">if</span>( m_CtrlSocket ) {
 114 <a name="l00092"></a>00092                 m_ctrl-&gt;Close();
 115 <a name="l00093"></a>00093                 m_ctrl.reset();
 116 <a name="l00094"></a>00094                 m_CtrlSocket = 0;
 117 <a name="l00095"></a>00095         }
 118 <a name="l00096"></a>00096
 119 <a name="l00097"></a>00097         m_ModeSocket = m_con.SelectMode(Controller::UsbSerData);
 120 <a name="l00098"></a>00098         m_data = m_con.m_zero.Open(m_ModeSocket, password);
 121 <a name="l00099"></a>00099
 122 <a name="l00100"></a>00100         m_CtrlSocket = m_con.SelectMode(Controller::UsbSerCtrl);
 123 <a name="l00101"></a>00101         m_ctrl = m_con.m_zero.Open(m_CtrlSocket, password);
 124 <a name="l00102"></a>00102
 125 <a name="l00103"></a>00103         <span class="comment">// register callback for incoming data, for speed</span>
 126 <a name="l00104"></a>00104         SocketRoutingQueue::SocketDataHandlerPtr data_callback
 127 <a name="l00105"></a>00105                 (<span class="keyword">new</span> SocketRoutingQueue::SimpleSocketDataHandler&lt;Serial&gt;(*<span class="keyword">this</span>, DataCallback));
 128 <a name="l00106"></a>00106         m_data-&gt;RegisterInterest(data_callback);
 129 <a name="l00107"></a>00107         SocketRoutingQueue::SocketDataHandlerPtr ctrl_callback
 130 <a name="l00108"></a>00108                 (<span class="keyword">new</span> SocketRoutingQueue::SimpleSocketDataHandler&lt;Serial&gt;(*<span class="keyword">this</span>, CtrlCallback));
 131 <a name="l00109"></a>00109         m_ctrl-&gt;RegisterInterest(ctrl_callback);
 132 <a name="l00110"></a>00110
 133 <a name="l00111"></a>00111         <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> start[] =
 134 <a name="l00112"></a>00112                 { 0, 0, 0x0a, 0, 0x01, 0x01, 0xc2, 0x00, 0x40, 0x00 };
 135 <a name="l00113"></a>00113         Data block(start, <span class="keyword">sizeof</span>(start));
 136 <a name="l00114"></a>00114         m_ctrl-&gt;Send(block);
 137 <a name="l00115"></a>00115 }
 138 <a name="l00116"></a>00116
 139 <a name="l00117"></a>00117 <span class="keywordtype">void</span> Serial::Close()
 140 <a name="l00118"></a>00118 {
 141 <a name="l00119"></a>00119         ddout(<span class="stringliteral">"Serial:: Closing connection."</span>);
 142 <a name="l00120"></a>00120 }
 143 <a name="l00121"></a>00121
 144 <a name="l00122"></a>00122 <span class="comment">/*</span>
 145 <a name="l00123"></a>00123 <span class="comment">// FIXME - if this behaviour is truly common between modes, create</span>
 146 <a name="l00124"></a>00124 <span class="comment">// a common base class for this.</span>
 147 <a name="l00125"></a>00125 <span class="comment">void Serial::RetryPassword(const char *password)</span>
 148 <a name="l00126"></a>00126 <span class="comment">{</span>
 149 <a name="l00127"></a>00127 <span class="comment">        if( m_data.get() || m_ctrl.get() )</span>
 150 <a name="l00128"></a>00128 <span class="comment">                throw std::logic_error("Socket already open in Serial::RetryPassword");</span>
 151 <a name="l00129"></a>00129 <span class="comment"></span>
 152 <a name="l00130"></a>00130 <span class="comment">        m_data = m_con.m_zero.OpenDBSocket(m_ModeSocket, password);</span>
 153 <a name="l00131"></a>00131 <span class="comment">        m_ctrl = m_con.m_zero.OpenDBSocket(m_CtrlSocket, password);</span>
 154 <a name="l00132"></a>00132 <span class="comment"></span>
 155 <a name="l00133"></a>00133 <span class="comment">        // register callback for incoming data, for speed</span>
 156 <a name="l00134"></a>00134 <span class="comment">        m_data-&gt;RegisterInterest(DataCallback, this);</span>
 157 <a name="l00135"></a>00135 <span class="comment">}</span>
 158 <a name="l00136"></a>00136 <span class="comment">*/</span>
 159 <a name="l00137"></a>00137
 160 <a name="l00138"></a>00138 <span class="comment">/*</span>
 161 <a name="l00139"></a>00139 <span class="comment">// can be called from separate thread</span>
 162 <a name="l00140"></a>00140 <span class="comment">void Serial::SerialRead(Data &amp;data, int timeout)</span>
 163 <a name="l00141"></a>00141 <span class="comment">{</span>
 164 <a name="l00142"></a>00142 <span class="comment">        m_socket.Receive(data, timeout);</span>
 165 <a name="l00143"></a>00143 <span class="comment">}</span>
 166 <a name="l00144"></a>00144 <span class="comment">*/</span>
 167 <a name="l00145"></a>00145
 168 <a name="l00146"></a>00146 <span class="keywordtype">void</span> Serial::Write(<span class="keyword">const</span> Data &amp;data, <span class="keywordtype">int</span> timeout)
 169 <a name="l00147"></a>00147 {
 170 <a name="l00148"></a>00148         <span class="keywordflow">if</span>( data.GetSize() &lt;= 0 )
 171 <a name="l00149"></a>00149                 <span class="keywordflow">return</span>; <span class="comment">// nothing to do</span>
 172 <a name="l00150"></a>00150
 173 <a name="l00151"></a>00151         <span class="keywordflow">if</span>( !m_data.get() )
 174 <a name="l00152"></a>00152                 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"Must call Open() before Write() in Mode::Serial"</span>);
 175 <a name="l00153"></a>00153
 176 <a name="l00154"></a>00154         <span class="comment">// filter data for PPP, and prepend 4 bytes</span>
 177 <a name="l00155"></a>00155         Data &amp;filtered = m_filter.Write(data, 4);
 178 <a name="l00156"></a>00156
 179 <a name="l00157"></a>00157         <span class="comment">// setup header (only size needed, as socket will be set by socket class)</span>
 180 <a name="l00158"></a>00158         <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf = filtered.GetBuffer();
 181 <a name="l00159"></a>00159         MAKE_PACKETPTR_BUF(spack, buf);
 182 <a name="l00160"></a>00160         spack-&gt;size = htobs(filtered.GetSize());
 183 <a name="l00161"></a>00161
 184 <a name="l00162"></a>00162         <span class="comment">// send via appropriate socket</span>
 185 <a name="l00163"></a>00163         m_data-&gt;Send(filtered, timeout);
 186 <a name="l00164"></a>00164 }
 187 <a name="l00165"></a>00165
 188 <a name="l00166"></a>00166 }} <span class="comment">// namespace Barry::Mode</span>
 189 <a name="l00167"></a>00167
 190 </pre></div></div>
 191 <hr size="1"><address style="text-align: right;"><small>Generated on Thu Feb 10 16:13:58 2011 for Barry by&nbsp;
 192 <a href="http://www.doxygen.org/index.html">
 193 <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
 194 </body>
 195 </html>