166 lines
10 KiB
HTML
166 lines
10 KiB
HTML
|
<?xml version="1.0" encoding="utf-8" ?>
|
||
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<!-- This file is generated by Nim. -->
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||
|
|
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
|
|
|
||
|
|
<!-- Favicon -->
|
||
|
|
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
|
||
|
|
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
|
||
|
|
|
||
|
|
<!-- Google fonts -->
|
||
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
|
||
|
|
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
|
||
|
|
|
||
|
|
<!-- CSS -->
|
||
|
|
<title>chronos/sendfile</title>
|
||
|
|
<link rel="stylesheet" type="text/css" href="../nimdoc.out.css">
|
||
|
|
|
||
|
|
<script type="text/javascript" src="../dochack.js"></script>
|
||
|
|
|
||
|
|
<script type="text/javascript">
|
||
|
|
function main() {
|
||
|
|
var pragmaDots = document.getElementsByClassName("pragmadots");
|
||
|
|
for (var i = 0; i < pragmaDots.length; i++) {
|
||
|
|
pragmaDots[i].onclick = function(event) {
|
||
|
|
// Hide tease
|
||
|
|
event.target.parentNode.style.display = "none";
|
||
|
|
// Show actual
|
||
|
|
event.target.parentNode.nextElementSibling.style.display = "inline";
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
function switchTheme(e) {
|
||
|
|
if (e.target.checked) {
|
||
|
|
document.documentElement.setAttribute('data-theme', 'dark');
|
||
|
|
localStorage.setItem('theme', 'dark');
|
||
|
|
} else {
|
||
|
|
document.documentElement.setAttribute('data-theme', 'light');
|
||
|
|
localStorage.setItem('theme', 'light');
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
|
||
|
|
if (toggleSwitch !== null) {
|
||
|
|
toggleSwitch.addEventListener('change', switchTheme, false);
|
||
|
|
}
|
||
|
|
|
||
|
|
var currentTheme = localStorage.getItem('theme');
|
||
|
|
if (!currentTheme && window.matchMedia('(prefers-color-scheme: dark)').matches) {
|
||
|
|
currentTheme = 'dark';
|
||
|
|
}
|
||
|
|
if (currentTheme) {
|
||
|
|
document.documentElement.setAttribute('data-theme', currentTheme);
|
||
|
|
|
||
|
|
if (currentTheme === 'dark' && toggleSwitch !== null) {
|
||
|
|
toggleSwitch.checked = true;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
window.addEventListener('DOMContentLoaded', main);
|
||
|
|
</script>
|
||
|
|
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div class="document" id="documentId">
|
||
|
|
<div class="container">
|
||
|
|
<h1 class="title">chronos/sendfile</h1>
|
||
|
|
<div class="row">
|
||
|
|
<div class="three columns">
|
||
|
|
<div class="theme-switch-wrapper">
|
||
|
|
<label class="theme-switch" for="checkbox">
|
||
|
|
<input type="checkbox" id="checkbox" />
|
||
|
|
<div class="slider round"></div>
|
||
|
|
</label>
|
||
|
|
<em>Dark Mode</em>
|
||
|
|
</div>
|
||
|
|
<div id="global-links">
|
||
|
|
<ul class="simple">
|
||
|
|
<li>
|
||
|
|
<a href="../theindex.html">Index</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div id="searchInputDiv">
|
||
|
|
Search: <input type="text" id="searchInput"
|
||
|
|
onkeyup="search()" />
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
Group by:
|
||
|
|
<select onchange="groupBy(this.value)">
|
||
|
|
<option value="section">Section</option>
|
||
|
|
<option value="type">Type</option>
|
||
|
|
</select>
|
||
|
|
</div>
|
||
|
|
<ul class="simple simple-toc" id="toc-list">
|
||
|
|
<li>
|
||
|
|
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
|
||
|
|
<ul class="simple simple-toc-section">
|
||
|
|
<ul class="simple nested-toc-section">sendfile
|
||
|
|
<li><a class="reference" href="#sendfile%2Cint%2Cint%2Cint%2Cint"
|
||
|
|
title="sendfile(outfd, infd: int; offset: int; count: var int): int">sendfile(outfd, infd: int; offset: int; count: var int): int</a></li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<a
|
||
|
|
href="https://github.com/status-im/nim-chronos/tree/master/chronos/sendfile.nim#L1"
|
||
|
|
class="link-seesrc" target="_blank">Source</a>
|
||
|
|
<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/sendfile.nim#L1" class="link-seesrc" target="_blank" >Edit</a>
|
||
|
|
|
||
|
|
<div class="nine columns" id="content">
|
||
|
|
<div id="tocRoot"></div>
|
||
|
|
|
||
|
|
<p class="module-desc">This module provides cross-platform wrapper for <tt class="docutils literal"><span class="pre">sendfile()</span></tt> syscall.</p>
|
||
|
|
<div class="section" id="12">
|
||
|
|
<h1><a class="toc-backref" href="#12">Procs</a></h1>
|
||
|
|
<dl class="item">
|
||
|
|
<div id="sendfile,int,int,int,int">
|
||
|
|
<dt><pre><span class="Keyword">proc</span> <a href="#sendfile%2Cint%2Cint%2Cint%2Cint"><span class="Identifier">sendfile</span></a><span class="Other">(</span><span class="Identifier">outfd</span><span class="Other">,</span> <span class="Identifier">infd</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">offset</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">count</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
|
||
|
|
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
|
||
|
|
<dd>
|
||
|
|
|
||
|
|
<p>Copies data between file descriptor <tt class="docutils literal"><span class="pre">infd</span></tt> and <tt class="docutils literal"><span class="pre">outfd</span></tt>. Because this copying is done within the kernel, <tt class="docutils literal"><span class="pre">sendfile()</span></tt> is more efficient than the combination of <tt class="docutils literal"><span class="pre">read(2)</span></tt> and <tt class="docutils literal"><span class="pre">write(2)</span></tt>, which would require transferring data to and from user space.</p>
|
||
|
|
<p><tt class="docutils literal"><span class="pre">infd</span></tt> should be a file descriptor opened for reading and <tt class="docutils literal"><span class="pre">outfd</span></tt> should be a descriptor opened for writing.</p>
|
||
|
|
<p>The <tt class="docutils literal"><span class="pre">infd</span></tt> argument must correspond to a file which supports <tt class="docutils literal"><span class="pre">mmap(2)</span></tt>-like operations (i.e., it cannot be a socket).</p>
|
||
|
|
<p><tt class="docutils literal"><span class="pre">offset</span></tt> the file offset from which <tt class="docutils literal"><span class="pre">sendfile()</span></tt> will start reading data from <tt class="docutils literal"><span class="pre">infd</span></tt>.</p>
|
||
|
|
<p><tt class="docutils literal"><span class="pre">count</span></tt> is the number of bytes to copy between the file descriptors. On exit <tt class="docutils literal"><span class="pre">count</span></tt> will hold number of bytes actually transferred between file descriptors. May be >0 even in the case of error return, if some bytes were sent before the error occurred.</p>
|
||
|
|
<p>If the transfer was successful, the number of bytes written to <tt class="docutils literal"><span class="pre">outfd</span></tt> is stored in <tt class="docutils literal"><span class="pre">count</span></tt>, and <tt class="docutils literal"><span class="pre">0</span></tt> returned. Note that a successful call to <tt class="docutils literal"><span class="pre">sendfile()</span></tt> may write fewer bytes than requested; the caller should be prepared to retry the call if there were unsent bytes.</p>
|
||
|
|
<p>On error, <tt class="docutils literal"><span class="pre">-1</span></tt> is returned.</p>
|
||
|
|
|
||
|
|
<a
|
||
|
|
href="https://github.com/status-im/nim-chronos/tree/master/chronos/sendfile.nim#L15"
|
||
|
|
class="link-seesrc" target="_blank">Source</a>
|
||
|
|
<a href="https://github.com/status-im/nim-chronos/edit/devel/chronos/sendfile.nim#L15" class="link-seesrc" target="_blank" >Edit</a>
|
||
|
|
|
||
|
|
</dd>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</dl></div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="row">
|
||
|
|
<div class="twelve-columns footer">
|
||
|
|
<span class="nim-sprite"></span>
|
||
|
|
<br/>
|
||
|
|
<small style="color: var(--hint);">Made with Nim. Generated: 2024-11-28 08:22:46 UTC</small>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|