Sophie

Sophie

distrib > Mageia > 5 > x86_64 > media > core-release > by-pkgid > bd1d7acf4abd8e5b4772def1c4c77c48 > files > 58

libosmo-dsp-doc-0.3-1.mga5.noarch.rpm

<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>libosmodsp: .cfile helpers</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">libosmodsp
   &#160;<span id="projectnumber">UNKNOWN</span>
   </div>
   <div id="projectbrief">Osmocom DSP library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__cfile.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#files">Files</a> &#124;
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">.cfile helpers</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:cfile_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cfile_8h.html">cfile.h</a></td></tr>
<tr class="memdesc:cfile_8h"><td class="mdescLeft">&#160;</td><td class="mdescRight">Osmocom .cfile helpers header. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:cfile_8c"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="cfile_8c.html">cfile.c</a></td></tr>
<tr class="memdesc:cfile_8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Osmocom .cfile helpers implementation. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcfile.html">cfile</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure representing a currently mapped .cfile.  <a href="structcfile.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gacb0304d89096222df64f3f9a10f22167"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structcfile.html">cfile</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cfile.html#gacb0304d89096222df64f3f9a10f22167">cfile_load</a> (const char *filename)</td></tr>
<tr class="memdesc:gacb0304d89096222df64f3f9a10f22167"><td class="mdescLeft">&#160;</td><td class="mdescRight">.cfile loader: mmap() the data into memory (read-only)  <a href="#gacb0304d89096222df64f3f9a10f22167">More...</a><br /></td></tr>
<tr class="separator:gacb0304d89096222df64f3f9a10f22167"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7728a89f370281e5da16ff27d8657b3d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__cfile.html#ga7728a89f370281e5da16ff27d8657b3d">cfile_release</a> (struct <a class="el" href="structcfile.html">cfile</a> *cf)</td></tr>
<tr class="memdesc:ga7728a89f370281e5da16ff27d8657b3d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Release all resources associated with a mapped .cfile.  <a href="#ga7728a89f370281e5da16ff27d8657b3d">More...</a><br /></td></tr>
<tr class="separator:ga7728a89f370281e5da16ff27d8657b3d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gacb0304d89096222df64f3f9a10f22167"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structcfile.html">cfile</a> * cfile_load </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>filename</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>.cfile loader: mmap() the data into memory (read-only) </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">filename</td><td>Filename of the .cfile to map </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A structure desribing the mapped data </dd></dl>

<p>References <a class="el" href="structcfile.html#ad3d6965e1039aa1f648361b2f83b034a">_blen</a>, <a class="el" href="structcfile.html#aeeb1105659968baae5df24026bf1d281">data</a>, and <a class="el" href="structcfile.html#a2c856227c89a929b863da15951fcaef4">len</a>.</p>

</div>
</div>
<a class="anchor" id="ga7728a89f370281e5da16ff27d8657b3d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void cfile_release </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structcfile.html">cfile</a> *&#160;</td>
          <td class="paramname"><em>cf</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Release all resources associated with a mapped .cfile. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">cf</td><td>Structure describing the cfile to unmap </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="structcfile.html#ad3d6965e1039aa1f648361b2f83b034a">_blen</a>, and <a class="el" href="structcfile.html#aeeb1105659968baae5df24026bf1d281">data</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated on Fri Jan 16 2015 21:29:20 for libosmodsp by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
  </ul>
</div>
</body>
</html>