<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>DTN Reference Implementation: SerialConvergenceLayer.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="main.html"><span>Main Page</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>
</ul>
</div>
<h1>SerialConvergenceLayer.h</h1><a href="SerialConvergenceLayer_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"> * Copyright 2004-2006 Intel Corporation</span>
<a name="l00003"></a>00003 <span class="comment"> * </span>
<a name="l00004"></a>00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span>
<a name="l00005"></a>00005 <span class="comment"> * you may not use this file except in compliance with the License.</span>
<a name="l00006"></a>00006 <span class="comment"> * You may obtain a copy of the License at</span>
<a name="l00007"></a>00007 <span class="comment"> * </span>
<a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<a name="l00009"></a>00009 <span class="comment"> * </span>
<a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span>
<a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span>
<a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span>
<a name="l00015"></a>00015 <span class="comment"> */</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _SERIAL_CONVERGENCE_LAYER_H_</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _SERIAL_CONVERGENCE_LAYER_H_</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <oasys/io/TTY.h></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <oasys/serialize/Serialize.h></span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="StreamConvergenceLayer_8h.html">StreamConvergenceLayer.h</a>"</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="keyword">namespace </span>dtn {
<a name="l00026"></a>00026
<a name="l00030"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer.html">00030</a> <span class="keyword">class </span><a class="code" href="classdtn_1_1SerialConvergenceLayer.html" title="The Serial Convergence Layer.">SerialConvergenceLayer</a> : <span class="keyword">public</span> <a class="code" href="classdtn_1_1StreamConvergenceLayer.html" title="Another shared-implementation convergence layer class for use with reliable, in-order...">StreamConvergenceLayer</a> {
<a name="l00031"></a>00031 <span class="keyword">public</span>:
<a name="l00035"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer.html#9ca5cfc6044fa55480a78bbb287a19c6">00035</a> <span class="keyword">static</span> <span class="keyword">const</span> u_int8_t <a class="code" href="classdtn_1_1SerialConvergenceLayer.html#9ca5cfc6044fa55480a78bbb287a19c6" title="Current version of the protocol.">SERIALCL_VERSION</a> = 0x01;
<a name="l00036"></a>00036
<a name="l00040"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer.html#45eb9e45649902e4463a348069bdbd0d">00040</a> <span class="keyword">static</span> <span class="keyword">const</span> u_char <a class="code" href="classdtn_1_1SerialConvergenceLayer.html#45eb9e45649902e4463a348069bdbd0d" title="Byte sent on the wire to synchronize the two ends.">SYNC</a> = <span class="charliteral">'.'</span>;
<a name="l00041"></a>00041
<a name="l00045"></a>00045 <a class="code" href="classdtn_1_1SerialConvergenceLayer.html#d2618503a0d71fe913d4b29bf44be0e9" title="Constructor.">SerialConvergenceLayer</a>();
<a name="l00046"></a>00046
<a name="l00050"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html">00050</a> <span class="keyword">class </span><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html" title="Tunable link parameter structure.">SerialLinkParams</a> : <span class="keyword">public</span> StreamLinkParams {
<a name="l00051"></a>00051 <span class="keyword">public</span>:
<a name="l00052"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html#fe69e3ed2e9c300dc0bb288a086a6db2">00052</a> <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html#fe69e3ed2e9c300dc0bb288a086a6db2" title="Log a hexdump of all traffic.">hexdump_</a>;
<a name="l00053"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html#a13a0ed5a9902323fb8b45a02f7faf2f">00053</a> std::string <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html#a13a0ed5a9902323fb8b45a02f7faf2f" title="String to initialize the tty.">initstr_</a>;
<a name="l00054"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html#6ab76314a1f014d348024a92b1f4e306">00054</a> u_int <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html#6ab76314a1f014d348024a92b1f4e306" title="Input speed on the tty.">ispeed_</a>;
<a name="l00055"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html#be65ee824aa26646c0bd7e3660aa652d">00055</a> u_int <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html#be65ee824aa26646c0bd7e3660aa652d" title="Output speed on the tty.">ospeed_</a>;
<a name="l00056"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html#c3a514f4e196d48d5d7c8e70a9c43953">00056</a> u_int <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html#c3a514f4e196d48d5d7c8e70a9c43953" title="Interval to send initial sync bits.">sync_interval_</a>;
<a name="l00057"></a>00057
<a name="l00058"></a>00058 <span class="keyword">protected</span>:
<a name="l00059"></a>00059 <span class="comment">// See comment in LinkParams for why this is protected</span>
<a name="l00060"></a>00060 <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html#4ec0188d932c0d24f608172c1a72d907">SerialLinkParams</a>(<span class="keywordtype">bool</span> init_defaults);
<a name="l00061"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html#b03792e30345f5c67d3eb9ea8b0b589b">00061</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classdtn_1_1SerialConvergenceLayer.html" title="The Serial Convergence Layer.">SerialConvergenceLayer</a>;
<a name="l00062"></a>00062 };
<a name="l00063"></a>00063
<a name="l00067"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer.html#01da52844843829a18dd7d255117e597">00067</a> <span class="keyword">static</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html" title="Tunable link parameter structure.">SerialLinkParams</a> <a class="code" href="classdtn_1_1SerialConvergenceLayer.html#01da52844843829a18dd7d255117e597" title="Default link parameters.">default_link_params_</a>;
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keyword">protected</span>:
<a name="l00071"></a>00071 <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer.html#ec245a904942d54ef0a9bed6d14b82d2" title="Virtual from ConvergenceLayer.">set_link_defaults</a>(<span class="keywordtype">int</span> argc, <span class="keyword">const</span> <span class="keywordtype">char</span>* argv[],
<a name="l00072"></a>00072 <span class="keyword">const</span> <span class="keywordtype">char</span>** invalidp);
<a name="l00073"></a>00073 <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer.html#e794014bbd22de08dde5c2d7b6d3ebf2" title="Virtual from ConvergenceLayer.">dump_link</a>(<span class="keyword">const</span> <a class="code" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e" title="Typedef for a reference on a link.">LinkRef</a>& link, oasys::StringBuffer* <a class="code" href="num2sdnv_8c.html#a81cdcc7ff6987bc85c073253e32715f">buf</a>);
<a name="l00075"></a>00075
<a name="l00077"></a>00077 <span class="keyword">virtual</span> <a class="code" href="classdtn_1_1ConnectionConvergenceLayer_1_1LinkParams.html" title="Tunable parameter structure stored in each Link&#39;s CLInfo slot.">LinkParams</a>* <a class="code" href="classdtn_1_1SerialConvergenceLayer.html#577e34fb15238b91dbf015ce1e1b32c4" title="Virtual from ConnectionConvergenceLayer.">new_link_params</a>();
<a name="l00078"></a>00078 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer.html#4229e8c830a1f83a22e257eba769e23c" title="Virtual from ConnectionConvergenceLayer.">parse_link_params</a>(<a class="code" href="classdtn_1_1ConnectionConvergenceLayer_1_1LinkParams.html" title="Tunable parameter structure stored in each Link&#39;s CLInfo slot.">LinkParams</a>* params,
<a name="l00079"></a>00079 <span class="keywordtype">int</span> argc, <span class="keyword">const</span> <span class="keywordtype">char</span>** argv,
<a name="l00080"></a>00080 <span class="keyword">const</span> <span class="keywordtype">char</span>** invalidp);
<a name="l00081"></a>00081 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer.html#a304f26f6b759df0c70ee81322a2eaea" title="Virtual from ConnectionConvergenceLayer.">parse_nexthop</a>(<span class="keyword">const</span> <a class="code" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e" title="Typedef for a reference on a link.">LinkRef</a>& link, <a class="code" href="classdtn_1_1ConnectionConvergenceLayer_1_1LinkParams.html" title="Tunable parameter structure stored in each Link&#39;s CLInfo slot.">LinkParams</a>* params);
<a name="l00082"></a>00082 <span class="keyword">virtual</span> <a class="code" href="classdtn_1_1CLConnection.html" title="Helper class (and thread) that manages an established connection with a peer daemon...">CLConnection</a>* <a class="code" href="classdtn_1_1SerialConvergenceLayer.html#0584f928831b0dfa967c54ab6b4122f0" title="Virtual from ConnectionConvergenceLayer.">new_connection</a>(<span class="keyword">const</span> <a class="code" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e" title="Typedef for a reference on a link.">LinkRef</a>& link,
<a name="l00083"></a>00083 <a class="code" href="classdtn_1_1ConnectionConvergenceLayer_1_1LinkParams.html" title="Tunable parameter structure stored in each Link&#39;s CLInfo slot.">LinkParams</a>* params);
<a name="l00085"></a>00085
<a name="l00095"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html">00095</a> <span class="keyword">class </span><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html" title="Helper class (and thread) that manages an established connection with a peer daemon...">Connection</a> : <span class="keyword">public</span> <a class="code" href="classdtn_1_1StreamConvergenceLayer.html" title="Another shared-implementation convergence layer class for use with reliable, in-order...">StreamConvergenceLayer</a>::<a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html" title="Helper class (and thread) that manages an established connection with a peer daemon...">Connection</a> {
<a name="l00096"></a>00096 <span class="keyword">public</span>:
<a name="l00100"></a>00100 <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#ef928067b795e3cf88e0bf944d1f4149" title="Constructor for a connection.">Connection</a>(<a class="code" href="classdtn_1_1SerialConvergenceLayer.html" title="The Serial Convergence Layer.">SerialConvergenceLayer</a>* cl,
<a name="l00101"></a>00101 <span class="keyword">const</span> <a class="code" href="namespacedtn.html#6efb37e503f8062c537b022eb755b94e" title="Typedef for a reference on a link.">LinkRef</a>& link,
<a name="l00102"></a>00102 <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html" title="Tunable link parameter structure.">SerialLinkParams</a>* params);
<a name="l00103"></a>00103
<a name="l00107"></a>00107 <span class="keyword">virtual</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#392f6887b6eaacbb23d9456bb7453052" title="Destructor.">~Connection</a>();
<a name="l00108"></a>00108
<a name="l00112"></a>00112 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#f02c6a9b14ca87e06b3297ea049af026" title="Virtual from SerializableObject.">serialize</a>(oasys::SerializeAction *a);
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="keyword">protected</span>:
<a name="l00115"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#b03792e30345f5c67d3eb9ea8b0b589b">00115</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classdtn_1_1SerialConvergenceLayer.html" title="The Serial Convergence Layer.">SerialConvergenceLayer</a>;
<a name="l00116"></a>00116
<a name="l00118"></a>00118 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#3c4fc2d1b74868c887338c498e2d184c" title="Virtual from CLConnection.">connect</a>();
<a name="l00119"></a>00119 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#228e483590dc76db4a551525b1b620a6" title="Virtual from CLConnection.">disconnect</a>();
<a name="l00120"></a>00120 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#a191aba82d5c64d68d88c771a81638e7" title="Virtual from CLConnection.">initialize_pollfds</a>();
<a name="l00121"></a>00121 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#d32478fdf89dd2e2c49c5f03b413f362" title="Virtual from CLConnection.">handle_poll_timeout</a>();
<a name="l00122"></a>00122 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#11878a33b225f840baea59197510de8d" title="Virtual from CLConnection.">handle_poll_activity</a>();
<a name="l00124"></a>00124
<a name="l00126"></a>00126 <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#9caf23d6af360bfaf243c34bc01735a2" title="virtual from StreamConvergenceLayer::Connection">send_data</a>();
<a name="l00128"></a>00128
<a name="l00130"></a>00130 <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#4be998fb11620cb8462e730312e8381c" title="Hook for handle_poll_activity to receive data.">recv_data</a>();
<a name="l00131"></a>00131
<a name="l00133"></a>00133 <span class="keywordtype">void</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#6c9d7a63f3587d09e5d5b5bd1613c152" title="Send a sync byte.">send_sync</a>();
<a name="l00134"></a>00134
<a name="l00139"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#015dc248e8cefe1bd823a5db17c02094">00139</a> <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html" title="Tunable link parameter structure.">SerialLinkParams</a>* <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#015dc248e8cefe1bd823a5db17c02094" title="Utility function to downcast the params_ pointer that&#39;s stored in the CLConnection...">serial_lparams</a>()
<a name="l00140"></a>00140 {
<a name="l00141"></a>00141 <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html" title="Tunable link parameter structure.">SerialLinkParams</a>* ret = <span class="keyword">dynamic_cast<</span><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1SerialLinkParams.html" title="Tunable link parameter structure.">SerialLinkParams</a>*<span class="keyword">></span>(<a class="code" href="classdtn_1_1CLConnection.html#e3408a135a49d68ab36fd8de5805b1fe" title="Pointer to Link parameters, or to defaults until Link is bound.">params_</a>);
<a name="l00142"></a>00142 <a class="code" href="SDNV_8cc.html#ca68c0d4ac8df0838e209fb5300f7be3">ASSERT</a>(ret != NULL);
<a name="l00143"></a>00143 <span class="keywordflow">return</span> ret;
<a name="l00144"></a>00144 }
<a name="l00145"></a>00145
<a name="l00146"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#520831b6dbb4ffc0ede37fbd8645a840">00146</a> oasys::TTY* <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#520831b6dbb4ffc0ede37fbd8645a840" title="The tty.">tty_</a>;
<a name="l00147"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#89f6f22debab0af32cb2a3601ce86b3b">00147</a> <span class="keyword">struct </span>pollfd* <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#89f6f22debab0af32cb2a3601ce86b3b" title="Poll structure for the tty.">tty_pollfd_</a>;
<a name="l00148"></a><a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#96f9cb81ef18a7a7d9c9959c6d6548c7">00148</a> <span class="keywordtype">bool</span> <a class="code" href="classdtn_1_1SerialConvergenceLayer_1_1Connection.html#96f9cb81ef18a7a7d9c9959c6d6548c7" title="Whether the SYNC has completed.">synced_</a>;
<a name="l00149"></a>00149 };
<a name="l00150"></a>00150 };
<a name="l00151"></a>00151
<a name="l00152"></a>00152 } <span class="comment">// namespace dtn</span>
<a name="l00153"></a>00153
<a name="l00154"></a>00154 <span class="preprocessor">#endif </span><span class="comment">/* _SERIAL_CONVERGENCE_LAYER_H_ */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jul 21 14:09:46 2008 for DTN Reference Implementation 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>
