docs/html/io_8h_source.html

<!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.11"/>
<title>libBigWig: io.h Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">libBigWig
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">io.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="io_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#include &lt;curl/curl.h&gt;</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="keyword">extern</span> <span class="keywordtype">size_t</span> <a class="code" href="io_8h.html#a2f4038b5ef0a0e7dc45a20fc0bb83925">GLOBAL_DEFAULTBUFFERSIZE</a>;</div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="io_8h.html#a53551ff2ef7a2c1b938e94ef9592ab66">   14</a></span>&#160;<span class="keyword">enum</span> <a class="code" href="io_8h.html#a53551ff2ef7a2c1b938e94ef9592ab66">bigWigFile_type_enum</a> {</div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;    BWG_FILE = 0,</div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;    BWG_HTTP = 1,</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;    BWG_HTTPS = 2,</div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;    BWG_FTP = 3</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;};</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structURL__t.html">   24</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>{</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;    <span class="keyword">union </span>{</div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structURL__t.html#a01844303c9bf15b823504dbdf8eecdc5">   26</a></span>&#160;        CURL *<a class="code" href="structURL__t.html#a01844303c9bf15b823504dbdf8eecdc5">curl</a>; </div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structURL__t.html#ad580083f95d86b68829b520d0b453b08">   27</a></span>&#160;        FILE *<a class="code" href="structURL__t.html#ad580083f95d86b68829b520d0b453b08">fp</a>; </div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    } x; </div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="structURL__t.html#ad1d920711f91f388ce7115341b3907cf">   29</a></span>&#160;    <span class="keywordtype">void</span> *<a class="code" href="structURL__t.html#ad1d920711f91f388ce7115341b3907cf">memBuf</a>; </div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="structURL__t.html#a98edd5e13308f6fa6f4880c87430bca2">   30</a></span>&#160;    <span class="keywordtype">size_t</span> <a class="code" href="structURL__t.html#a98edd5e13308f6fa6f4880c87430bca2">filePos</a>; </div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="structURL__t.html#ad560759e3af5e982fd369a27ba5b1dbc">   31</a></span>&#160;    <span class="keywordtype">size_t</span> <a class="code" href="structURL__t.html#ad560759e3af5e982fd369a27ba5b1dbc">bufPos</a>; </div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="structURL__t.html#a4f68a10b5d2284fd756562ea7bd02abc">   32</a></span>&#160;    <span class="keywordtype">size_t</span> <a class="code" href="structURL__t.html#a4f68a10b5d2284fd756562ea7bd02abc">bufSize</a>; </div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structURL__t.html#a2d3601123cd3d99cc184461007572b9f">   33</a></span>&#160;    <span class="keywordtype">size_t</span> <a class="code" href="structURL__t.html#a2d3601123cd3d99cc184461007572b9f">bufLen</a>; </div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structURL__t.html#a431adb9c33b3d8d43575799f6fdcd497">   34</a></span>&#160;    <span class="keyword">enum</span> <a class="code" href="io_8h.html#a53551ff2ef7a2c1b938e94ef9592ab66">bigWigFile_type_enum</a> type; </div><div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structURL__t.html#a45fcd4a597a7dba67938d5aab253aebb">   35</a></span>&#160;    <span class="keywordtype">char</span> *<a class="code" href="structURL__t.html#a45fcd4a597a7dba67938d5aab253aebb">fname</a>; </div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;} <a class="code" href="structURL__t.html">URL_t</a>;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="keywordtype">size_t</span> <a class="code" href="io_8h.html#a8f6a5aa097c9af9925171dd43d688f26">urlRead</a>(<a class="code" href="structURL__t.html">URL_t</a> *URL, <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> bufSize);</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;CURLcode <a class="code" href="io_8h.html#a55a1fcb43f68a2b3c3a2b66a6459a0a8">urlSeek</a>(<a class="code" href="structURL__t.html">URL_t</a> *URL, <span class="keywordtype">size_t</span> pos);</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;<a class="code" href="structURL__t.html">URL_t</a> *<a class="code" href="io_8h.html#a8583139627ed0a732e6d9b4f80231c87">urlOpen</a>(<span class="keywordtype">char</span> *fname, CURLcode (*callBack)(CURL*), <span class="keyword">const</span> <span class="keywordtype">char</span>* mode);</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;<span class="keywordtype">void</span> <a class="code" href="io_8h.html#add8705cdab8e6f2193a50bf095f08470">urlClose</a>(<a class="code" href="structURL__t.html">URL_t</a> *URL);</div><div class="ttc" id="structURL__t_html"><div class="ttname"><a href="structURL__t.html">URL_t</a></div><div class="ttdoc">This structure holds the file pointers and buffers needed for raw access to local and remote files...</div><div class="ttdef"><b>Definition:</b> io.h:24</div></div>
<div class="ttc" id="structURL__t_html_ad580083f95d86b68829b520d0b453b08"><div class="ttname"><a href="structURL__t.html#ad580083f95d86b68829b520d0b453b08">URL_t::fp</a></div><div class="ttdeci">FILE * fp</div><div class="ttdef"><b>Definition:</b> io.h:27</div></div>
<div class="ttc" id="io_8h_html_add8705cdab8e6f2193a50bf095f08470"><div class="ttname"><a href="io_8h.html#add8705cdab8e6f2193a50bf095f08470">urlClose</a></div><div class="ttdeci">void urlClose(URL_t *URL)</div><div class="ttdoc">Close a local/remote file. </div><div class="ttdef"><b>Definition:</b> io.c:239</div></div>
<div class="ttc" id="structURL__t_html_ad560759e3af5e982fd369a27ba5b1dbc"><div class="ttname"><a href="structURL__t.html#ad560759e3af5e982fd369a27ba5b1dbc">URL_t::bufPos</a></div><div class="ttdeci">size_t bufPos</div><div class="ttdef"><b>Definition:</b> io.h:31</div></div>
<div class="ttc" id="structURL__t_html_a4f68a10b5d2284fd756562ea7bd02abc"><div class="ttname"><a href="structURL__t.html#a4f68a10b5d2284fd756562ea7bd02abc">URL_t::bufSize</a></div><div class="ttdeci">size_t bufSize</div><div class="ttdef"><b>Definition:</b> io.h:32</div></div>
<div class="ttc" id="structURL__t_html_a98edd5e13308f6fa6f4880c87430bca2"><div class="ttname"><a href="structURL__t.html#a98edd5e13308f6fa6f4880c87430bca2">URL_t::filePos</a></div><div class="ttdeci">size_t filePos</div><div class="ttdef"><b>Definition:</b> io.h:30</div></div>
<div class="ttc" id="structURL__t_html_a2d3601123cd3d99cc184461007572b9f"><div class="ttname"><a href="structURL__t.html#a2d3601123cd3d99cc184461007572b9f">URL_t::bufLen</a></div><div class="ttdeci">size_t bufLen</div><div class="ttdef"><b>Definition:</b> io.h:33</div></div>
<div class="ttc" id="io_8h_html_a55a1fcb43f68a2b3c3a2b66a6459a0a8"><div class="ttname"><a href="io_8h.html#a55a1fcb43f68a2b3c3a2b66a6459a0a8">urlSeek</a></div><div class="ttdeci">CURLcode urlSeek(URL_t *URL, size_t pos)</div><div class="ttdoc">Seeks to a given position in a local or remote file. </div><div class="ttdef"><b>Definition:</b> io.c:104</div></div>
<div class="ttc" id="structURL__t_html_a45fcd4a597a7dba67938d5aab253aebb"><div class="ttname"><a href="structURL__t.html#a45fcd4a597a7dba67938d5aab253aebb">URL_t::fname</a></div><div class="ttdeci">char * fname</div><div class="ttdef"><b>Definition:</b> io.h:35</div></div>
<div class="ttc" id="io_8h_html_a53551ff2ef7a2c1b938e94ef9592ab66"><div class="ttname"><a href="io_8h.html#a53551ff2ef7a2c1b938e94ef9592ab66">bigWigFile_type_enum</a></div><div class="ttdeci">bigWigFile_type_enum</div><div class="ttdef"><b>Definition:</b> io.h:14</div></div>
<div class="ttc" id="structURL__t_html_ad1d920711f91f388ce7115341b3907cf"><div class="ttname"><a href="structURL__t.html#ad1d920711f91f388ce7115341b3907cf">URL_t::memBuf</a></div><div class="ttdeci">void * memBuf</div><div class="ttdef"><b>Definition:</b> io.h:29</div></div>
<div class="ttc" id="io_8h_html_a2f4038b5ef0a0e7dc45a20fc0bb83925"><div class="ttname"><a href="io_8h.html#a2f4038b5ef0a0e7dc45a20fc0bb83925">GLOBAL_DEFAULTBUFFERSIZE</a></div><div class="ttdeci">size_t GLOBAL_DEFAULTBUFFERSIZE</div><div class="ttdef"><b>Definition:</b> io.c:9</div></div>
<div class="ttc" id="io_8h_html_a8583139627ed0a732e6d9b4f80231c87"><div class="ttname"><a href="io_8h.html#a8583139627ed0a732e6d9b4f80231c87">urlOpen</a></div><div class="ttdeci">URL_t * urlOpen(char *fname, CURLcode(*callBack)(CURL *), const char *mode)</div><div class="ttdoc">Open a local or remote file. </div><div class="ttdef"><b>Definition:</b> io.c:139</div></div>
<div class="ttc" id="structURL__t_html_a01844303c9bf15b823504dbdf8eecdc5"><div class="ttname"><a href="structURL__t.html#a01844303c9bf15b823504dbdf8eecdc5">URL_t::curl</a></div><div class="ttdeci">CURL * curl</div><div class="ttdef"><b>Definition:</b> io.h:26</div></div>
<div class="ttc" id="io_8h_html_a8f6a5aa097c9af9925171dd43d688f26"><div class="ttname"><a href="io_8h.html#a8f6a5aa097c9af9925171dd43d688f26">urlRead</a></div><div class="ttdeci">size_t urlRead(URL_t *URL, void *buf, size_t bufSize)</div><div class="ttdoc">Reads data into the given buffer. </div><div class="ttdef"><b>Definition:</b> io.c:77</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Nov 18 2016 22:54:37 for libBigWig by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>