<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Barry: m_serial.cc Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<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="annotated.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="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_65781e9408669bb8d7d9c025fdb5fe86.html">src</a>
</div>
</div>
<div class="contents">
<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>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file m_serial.cc</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Mode class for serial / GPRS modem mode</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) 2008-2010, 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">#include "<a class="code" href="m__serial_8h.html" title="Mode class for serial / GPRS modem mode.">m_serial.h</a>"</span>
<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>
<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>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="endian_8h.html" title="Endian conversion macros.">endian.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "debug.h"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <stdexcept></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keyword">namespace </span>Barry { <span class="keyword">namespace </span>Mode {
<a name="l00030"></a>00030 <span class="comment"></span>
<a name="l00031"></a>00031 <span class="comment">//////////////////////////////////////////////////////////////////////////////</span>
<a name="l00032"></a>00032 <span class="comment"></span><span class="comment">// Mode::Serial class</span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 Serial::Serial( Controller &con,
<a name="l00035"></a>00035 DeviceDataCallback callback,
<a name="l00036"></a>00036 <span class="keywordtype">void</span> *callback_context)
<a name="l00037"></a>00037 : m_con(con)
<a name="l00038"></a>00038 , m_ModeSocket(0)
<a name="l00039"></a>00039 , m_CtrlSocket(0)
<a name="l00040"></a>00040 , m_callback(callback)
<a name="l00041"></a>00041 , m_callback_context(callback_context)
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043 <span class="keywordflow">if</span>( !m_con.HasQueue() )
<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>);
<a name="l00045"></a>00045 }
<a name="l00046"></a>00046
<a name="l00047"></a>00047 Serial::~Serial()
<a name="l00048"></a>00048 {
<a name="l00049"></a>00049 }
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="comment"></span>
<a name="l00052"></a>00052 <span class="comment">//////////////////////////////////////////////////////////////////////////////</span>
<a name="l00053"></a>00053 <span class="comment"></span><span class="comment">// protected API / static functions</span>
<a name="l00054"></a>00054
<a name="l00055"></a>00055 <span class="keywordtype">void</span> Serial::DataCallback(<span class="keywordtype">void</span> *context, Data *data)
<a name="l00056"></a>00056 {
<a name="l00057"></a>00057 ddout(<span class="stringliteral">"Serial::DataCallback called"</span>);
<a name="l00058"></a>00058
<a name="l00059"></a>00059 Serial *ser = (Serial*) context;
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="keywordflow">if</span>( data->GetSize() <= 4 )
<a name="l00062"></a>00062 <span class="keywordflow">return</span>; <span class="comment">// nothing to do</span>
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="comment">// call callback if available</span>
<a name="l00065"></a>00065 <span class="keywordflow">if</span>( ser->m_callback ) {
<a name="l00066"></a>00066 (*ser->m_callback)(ser->m_callback_context,
<a name="l00067"></a>00067 data->GetData() + 4,
<a name="l00068"></a>00068 data->GetSize() - 4);
<a name="l00069"></a>00069 }
<a name="l00070"></a>00070 <span class="comment">// else {</span>
<a name="l00071"></a>00071 <span class="comment">// // append data to readCache</span>
<a name="l00072"></a>00072 <span class="comment">// FIXME;</span>
<a name="l00073"></a>00073 <span class="comment">// }</span>
<a name="l00074"></a>00074 }
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="keywordtype">void</span> Serial::CtrlCallback(<span class="keywordtype">void</span> *context, Data *data)
<a name="l00077"></a>00077 {
<a name="l00078"></a>00078 <span class="comment">// Serial *ser = (Serial*) context;</span>
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="comment">// just dump to stdout, and do nothing</span>
<a name="l00081"></a>00081 ddout(<span class="stringliteral">"CtrlCallback received:\n"</span> << *data);
<a name="l00082"></a>00082 }
<a name="l00083"></a>00083 <span class="comment"></span>
<a name="l00084"></a>00084 <span class="comment">//////////////////////////////////////////////////////////////////////////////</span>
<a name="l00085"></a>00085 <span class="comment"></span><span class="comment">// public API</span>
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="keywordtype">void</span> Serial::Open(<span class="keyword">const</span> <span class="keywordtype">char</span> *password)
<a name="l00088"></a>00088 {
<a name="l00089"></a>00089 <span class="keywordflow">if</span>( m_ModeSocket ) {
<a name="l00090"></a>00090 m_data->Close();
<a name="l00091"></a>00091 m_data.reset();
<a name="l00092"></a>00092 m_ModeSocket = 0;
<a name="l00093"></a>00093 }
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="keywordflow">if</span>( m_CtrlSocket ) {
<a name="l00096"></a>00096 m_ctrl->Close();
<a name="l00097"></a>00097 m_ctrl.reset();
<a name="l00098"></a>00098 m_CtrlSocket = 0;
<a name="l00099"></a>00099 }
<a name="l00100"></a>00100
<a name="l00101"></a>00101 m_ModeSocket = m_con.SelectMode(Controller::UsbSerData);
<a name="l00102"></a>00102 m_data = m_con.m_zero.Open(m_ModeSocket, password);
<a name="l00103"></a>00103
<a name="l00104"></a>00104 m_CtrlSocket = m_con.SelectMode(Controller::UsbSerCtrl);
<a name="l00105"></a>00105 m_ctrl = m_con.m_zero.Open(m_CtrlSocket, password);
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="comment">// register callback for incoming data, for speed</span>
<a name="l00108"></a>00108 m_data->RegisterInterest(DataCallback, <span class="keyword">this</span>);
<a name="l00109"></a>00109 m_ctrl->RegisterInterest(CtrlCallback, <span class="keyword">this</span>);
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> start[] =
<a name="l00112"></a>00112 { 0, 0, 0x0a, 0, 0x01, 0x01, 0xc2, 0x00, 0x40, 0x00 };
<a name="l00113"></a>00113 Data block(start, <span class="keyword">sizeof</span>(start));
<a name="l00114"></a>00114 m_ctrl->Send(block);
<a name="l00115"></a>00115 }
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="keywordtype">void</span> Serial::Close()
<a name="l00118"></a>00118 {
<a name="l00119"></a>00119 ddout(<span class="stringliteral">"Serial:: Closing connection."</span>);
<a name="l00120"></a>00120 }
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="comment">/*</span>
<a name="l00123"></a>00123 <span class="comment">// FIXME - if this behaviour is truly common between modes, create</span>
<a name="l00124"></a>00124 <span class="comment">// a common base class for this.</span>
<a name="l00125"></a>00125 <span class="comment">void Serial::RetryPassword(const char *password)</span>
<a name="l00126"></a>00126 <span class="comment">{</span>
<a name="l00127"></a>00127 <span class="comment"> if( m_data.get() || m_ctrl.get() )</span>
<a name="l00128"></a>00128 <span class="comment"> throw std::logic_error("Socket already open in Serial::RetryPassword");</span>
<a name="l00129"></a>00129 <span class="comment"></span>
<a name="l00130"></a>00130 <span class="comment"> m_data = m_con.m_zero.OpenDBSocket(m_ModeSocket, password);</span>
<a name="l00131"></a>00131 <span class="comment"> m_ctrl = m_con.m_zero.OpenDBSocket(m_CtrlSocket, password);</span>
<a name="l00132"></a>00132 <span class="comment"></span>
<a name="l00133"></a>00133 <span class="comment"> // register callback for incoming data, for speed</span>
<a name="l00134"></a>00134 <span class="comment"> m_data->RegisterInterest(DataCallback, this);</span>
<a name="l00135"></a>00135 <span class="comment">}</span>
<a name="l00136"></a>00136 <span class="comment">*/</span>
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="comment">/*</span>
<a name="l00139"></a>00139 <span class="comment">// can be called from separate thread</span>
<a name="l00140"></a>00140 <span class="comment">void Serial::SerialRead(Data &data, int timeout)</span>
<a name="l00141"></a>00141 <span class="comment">{</span>
<a name="l00142"></a>00142 <span class="comment"> m_socket.Receive(data, timeout);</span>
<a name="l00143"></a>00143 <span class="comment">}</span>
<a name="l00144"></a>00144 <span class="comment">*/</span>
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="keywordtype">void</span> Serial::Write(<span class="keyword">const</span> Data &data, <span class="keywordtype">int</span> timeout)
<a name="l00147"></a>00147 {
<a name="l00148"></a>00148 <span class="keywordflow">if</span>( data.GetSize() <= 0 )
<a name="l00149"></a>00149 <span class="keywordflow">return</span>; <span class="comment">// nothing to do</span>
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="keywordflow">if</span>( !m_data.get() )
<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>);
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="comment">// filter data for PPP, and prepend 4 bytes</span>
<a name="l00155"></a>00155 Data &filtered = m_filter.Write(data, 4);
<a name="l00156"></a>00156
<a name="l00157"></a>00157 <span class="comment">// setup header (only size needed, as socket will be set by socket class)</span>
<a name="l00158"></a>00158 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *buf = filtered.GetBuffer();
<a name="l00159"></a>00159 MAKE_PACKETPTR_BUF(spack, buf);
<a name="l00160"></a>00160 spack->size = htobs(filtered.GetSize());
<a name="l00161"></a>00161
<a name="l00162"></a>00162 <span class="comment">// send via appropriate socket</span>
<a name="l00163"></a>00163 m_data->Send(filtered, timeout);
<a name="l00164"></a>00164 }
<a name="l00165"></a>00165
<a name="l00166"></a>00166 }} <span class="comment">// namespace Barry::Mode</span>
<a name="l00167"></a>00167
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
