<!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: serialsource.h 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.5.8 -->
<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>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<h1>serialsource.h</h1><a href="serialsource_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 2005-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 SERIALSOURCE_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define SERIALSOURCE_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a><a class="code" href="serialsource_8h.html#07866e01fe89a6df45c0888da2865713">00020</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structserial__source.html">serial_source</a> *<a class="code" href="structserial__source.html">serial_source</a>;
<a name="l00021"></a>00021
<a name="l00022"></a>00022
<a name="l00023"></a><a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b640">00023</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00024"></a><a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b6407b84f7820f720f231d4d46b347b07c03">00024</a> <a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b6407b84f7820f720f231d4d46b347b07c03">msg_unknown_packet_type</a>, <span class="comment">/* packet of unknown type received */</span>
<a name="l00025"></a><a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b640e07631bc83a246a96163fe87767f61e5">00025</a> <a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b640e07631bc83a246a96163fe87767f61e5">msg_ack_timeout</a>, <span class="comment">/* ack not received within timeout */</span>
<a name="l00026"></a><a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b640b901edba7e44ef5b3a94da2354ca7f39">00026</a> <a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b640b901edba7e44ef5b3a94da2354ca7f39">msg_sync</a>, <span class="comment">/* sync achieved */</span>
<a name="l00027"></a><a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b640059f9acc718f1249381695305c6318d6">00027</a> <a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b640059f9acc718f1249381695305c6318d6">msg_too_long</a>, <span class="comment">/* greater than MTU (256 bytes) */</span>
<a name="l00028"></a><a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b6402ae7360e7fa9dec3d9e566d9baf03170">00028</a> <a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b6402ae7360e7fa9dec3d9e566d9baf03170">msg_too_short</a>, <span class="comment">/* less than 4 bytes */</span>
<a name="l00029"></a><a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b6407cf8a46ffe9feae3d810dc97122ca118">00029</a> <a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b6407cf8a46ffe9feae3d810dc97122ca118">msg_bad_sync</a>, <span class="comment">/* unexpected sync byte received */</span>
<a name="l00030"></a><a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b640dd5436d5122a3164349104347834e117">00030</a> <a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b640dd5436d5122a3164349104347834e117">msg_bad_crc</a>, <span class="comment">/* received packet has bad crc */</span>
<a name="l00031"></a><a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b6400aef5624e43b2ca76b450011d2c7bd6b">00031</a> <a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b6400aef5624e43b2ca76b450011d2c7bd6b">msg_closed</a>, <span class="comment">/* serial port closed itself */</span>
<a name="l00032"></a><a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b64043799e5977806a4559729141f049150c">00032</a> <a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b64043799e5977806a4559729141f049150c">msg_no_memory</a>, <span class="comment">/* malloc failed */</span>
<a name="l00033"></a><a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b640e997903e7fd3c99317e9641835d74422">00033</a> <a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b640e997903e7fd3c99317e9641835d74422">msg_unix_error</a> <span class="comment">/* check errno for details */</span>
<a name="l00034"></a>00034 } <a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b640">serial_source_msg</a>;
<a name="l00035"></a>00035
<a name="l00036"></a>00036 serial_source <a class="code" href="serialsource_8c.html#1f56b3ed3ca860efcd58d5c212b17066">open_serial_source</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *device, <span class="keywordtype">int</span> baud_rate,
<a name="l00037"></a>00037 <span class="keywordtype">int</span> <a class="code" href="structserial__source.html#d6e9b9bcdf86bed01710561c076f6fed">non_blocking</a>,
<a name="l00038"></a>00038 <span class="keywordtype">void</span> (*<a class="code" href="serialsource_8c.html#dce261c6a0421cc69b6a6ff86f5be7dd">message</a>)(<a class="code" href="serialsource_8h.html#606dc90f6ac5ac49f0296e9b7111b640">serial_source_msg</a> problem));
<a name="l00039"></a>00039 <span class="comment">/* Effects: opens serial port device at specified baud_rate. If non_blocking</span>
<a name="l00040"></a>00040 <span class="comment"> is true, read_serial_packet calls will be non-blocking (writes are</span>
<a name="l00041"></a>00041 <span class="comment"> always blocking, for now at least)</span>
<a name="l00042"></a>00042 <span class="comment"> If non-null, message will be called to signal various problems during</span>
<a name="l00043"></a>00043 <span class="comment"> execution.</span>
<a name="l00044"></a>00044 <span class="comment"> Returns: descriptor for serial forwarder at host:port, or</span>
<a name="l00045"></a>00045 <span class="comment"> NULL for failure</span>
<a name="l00046"></a>00046 <span class="comment"> */</span>
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keywordtype">int</span> <a class="code" href="serialsource_8c.html#3af9a5741985286f184a3c75f2d4da0f">serial_source_fd</a>(serial_source <a class="code" href="dtnmoteproxy_8c.html#e1ade0f5a1b32f6c8be72f31a99e2a18">src</a>);
<a name="l00049"></a>00049 <span class="comment">/* Returns: the file descriptor used by serial source src (useful when</span>
<a name="l00050"></a>00050 <span class="comment"> non-blocking reads were requested)</span>
<a name="l00051"></a>00051 <span class="comment">*/</span>
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="keywordtype">int</span> <a class="code" href="serialsource_8c.html#1e56d589bd8f636209b2b9704f3ab6e9">serial_source_empty</a>(serial_source <a class="code" href="dtnmoteproxy_8c.html#e1ade0f5a1b32f6c8be72f31a99e2a18">src</a>);
<a name="l00054"></a>00054 <span class="comment">/* Returns: true if serial source does not contain any pending data, i.e.,</span>
<a name="l00055"></a>00055 <span class="comment"> if the result is true and there is no data available on the source's</span>
<a name="l00056"></a>00056 <span class="comment"> file descriptor, then read_serial_packet will:</span>
<a name="l00057"></a>00057 <span class="comment"> - return NULL if the source is non-blocking</span>
<a name="l00058"></a>00058 <span class="comment"> - block if it is blocking</span>
<a name="l00059"></a>00059 <span class="comment"></span>
<a name="l00060"></a>00060 <span class="comment"> (Note: the presence of this calls allows the serial_source to do some</span>
<a name="l00061"></a>00061 <span class="comment"> internal buffering)</span>
<a name="l00062"></a>00062 <span class="comment">*/</span>
<a name="l00063"></a>00063
<a name="l00064"></a>00064 <span class="keywordtype">int</span> <a class="code" href="serialsource_8c.html#4bd86ad93ca5b213f3031ce800eca733">close_serial_source</a>(serial_source <a class="code" href="dtnmoteproxy_8c.html#e1ade0f5a1b32f6c8be72f31a99e2a18">src</a>);
<a name="l00065"></a>00065 <span class="comment">/* Effects: closes serial source src</span>
<a name="l00066"></a>00066 <span class="comment"> Returns: 0 if successful, -1 if some problem occured (but source is</span>
<a name="l00067"></a>00067 <span class="comment"> considered closed anyway)</span>
<a name="l00068"></a>00068 <span class="comment"> */</span>
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="keywordtype">void</span> *<a class="code" href="serialsource_8c.html#ecafeccd1e584af0ad57764d1b05c962">read_serial_packet</a>(serial_source <a class="code" href="dtnmoteproxy_8c.html#e1ade0f5a1b32f6c8be72f31a99e2a18">src</a>, <span class="keywordtype">int</span> *<a class="code" href="num2sdnv_8c.html#fed088663f8704004425cdae2120b9b3">len</a>);
<a name="l00071"></a>00071 <span class="comment">/* Effects: Read the serial source src. If a packet is available, return it.</span>
<a name="l00072"></a>00072 <span class="comment"> If in blocking mode and no packet is available, wait for one.</span>
<a name="l00073"></a>00073 <span class="comment"> Returns: the packet read (in newly allocated memory), with *len is</span>
<a name="l00074"></a>00074 <span class="comment"> set to the packet length, or NULL if no packet is yet available and</span>
<a name="l00075"></a>00075 <span class="comment"> the serial source is in non-blocking mode</span>
<a name="l00076"></a>00076 <span class="comment">*/</span>
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="keywordtype">int</span> <a class="code" href="serialsource_8c.html#eebe330155e6cd027ac65ee6ed73c2db">write_serial_packet</a>(serial_source <a class="code" href="dtnmoteproxy_8c.html#e1ade0f5a1b32f6c8be72f31a99e2a18">src</a>, <span class="keyword">const</span> <span class="keywordtype">void</span> *<a class="code" href="structserial__source.html#158912e48a804a855221eb8a3f0c2d3d">packet</a>, <span class="keywordtype">int</span> <a class="code" href="num2sdnv_8c.html#fed088663f8704004425cdae2120b9b3">len</a>);
<a name="l00079"></a>00079 <span class="comment">/* Effects: writes len byte packet to serial source src</span>
<a name="l00080"></a>00080 <span class="comment"> Returns: 0 if packet successfully written, 1 if successfully written</span>
<a name="l00081"></a>00081 <span class="comment"> but not acknowledged, -1 otherwise</span>
<a name="l00082"></a>00082 <span class="comment">*/</span>
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Jan 30 09:26:58 2009 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.8 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
29c369053a983cc5d8c880dc6e0a2237
>
files
>
2001
