autodoc.git
/
traditional_manual
/
chapter_9.html
version
»
Context lines:
10
20
40
80
file
none
3
autodoc.git/traditional_manual/chapter_9.html:3981:
<dd class='body--doc'><p>Used in <code>File.setsockopt()</code> to set Type Of Service</p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Constant</span> <span class='homogen--name'><b>NOTE_ATTRIB</b></span> </dt> <dd><p><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Stdio.<code class='constant'>NOTE_ATTRIB</code></code></p></dd>
-
</dl>
+
-
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>Used with <code>Stdio.File()->set_fs_event_callback()</code> to monitor
+
for attribute changes on a file.</p>
+
</dd>
+
<dt class='head--doc'>Note</dt>
+
<dd class='body--doc'><p>Available on systems that use kqueue.</p>
+
</dd></dl>
-
+
<hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Constant</span> <span class='homogen--name'><b>NOTE_DELETE</b></span> </dt> <dd><p><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Stdio.<code class='constant'>NOTE_DELETE</code></code></p></dd>
-
</dl>
+
-
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>Used with <code>Stdio.File()->set_fs_event_callback()</code> to monitor
+
for deletion of a file.</p>
+
</dd>
+
<dt class='head--doc'>Note</dt>
+
<dd class='body--doc'><p>Available on systems that use kqueue.</p>
+
</dd></dl>
-
+
<hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Constant</span> <span class='homogen--name'><b>NOTE_EXTEND</b></span> </dt> <dd><p><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Stdio.<code class='constant'>NOTE_EXTEND</code></code></p></dd>
-
</dl>
+
-
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>Used with <code>Stdio.File()->set_fs_event_callback()</code> to monitor
+
for extension events on a file.</p>
+
</dd>
+
<dt class='head--doc'>Note</dt>
+
<dd class='body--doc'><p>Available on systems that use kqueue.</p>
+
</dd></dl>
-
+
<hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Constant</span> <span class='homogen--name'><b>NOTE_LINK</b></span> </dt> <dd><p><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Stdio.<code class='constant'>NOTE_LINK</code></code></p></dd>
-
</dl>
+
-
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>Used with <code>Stdio.File()->set_fs_event_callback()</code> to monitor
+
for changes to a file's link count.</p>
+
</dd>
+
<dt class='head--doc'>Note</dt>
+
<dd class='body--doc'><p>Available on systems that use kqueue.</p>
+
</dd></dl>
-
+
<hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Constant</span> <span class='homogen--name'><b>NOTE_RENAME</b></span> </dt> <dd><p><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Stdio.<code class='constant'>NOTE_RENAME</code></code></p></dd>
-
</dl>
+
-
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>Used with <code>Stdio.File()->set_fs_event_callback()</code> to monitor
+
for move or rename events on a file.</p>
+
</dd>
+
<dt class='head--doc'>Note</dt>
+
<dd class='body--doc'><p>Available on systems that use kqueue.</p>
+
</dd></dl>
-
+
<hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Constant</span> <span class='homogen--name'><b>NOTE_REVOKE</b></span> </dt> <dd><p><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Stdio.<code class='constant'>NOTE_REVOKE</code></code></p></dd>
-
</dl>
+
-
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>Used with <code>Stdio.File()->set_fs_event_callback()</code> to monitor
+
for access revokation (unmount, etc).</p>
+
</dd>
+
<dt class='head--doc'>Note</dt>
+
<dd class='body--doc'><p>Available on systems that use kqueue.</p>
+
</dd></dl>
-
+
<hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Constant</span> <span class='homogen--name'><b>NOTE_WRITE</b></span> </dt> <dd><p><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Stdio.<code class='constant'>NOTE_WRITE</code></code></p></dd>
-
</dl>
+
-
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>Used with <code>Stdio.File()->set_fs_event_callback()</code> to monitor
+
for writes to a file.</p>
+
</dd>
+
<dt class='head--doc'>Note</dt>
+
<dd class='body--doc'><p>Available on systems that use kqueue.</p>
+
</dd></dl>
-
+
<hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Constant</span> <span class='homogen--name'><b>PROP_BIDIRECTIONAL</b></span> </dt> <dd><p><code><code class='datatype'>constant</code> <code class='datatype'>int</code> Stdio.<code class='constant'>PROP_BIDIRECTIONAL</code></code></p></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'><p>The file is bi-directional.</p> </dd>
autodoc.git/traditional_manual/chapter_9.html:8017:
indicate the error.</p> </dd> <dt class='head--doc'>See also</dt> <dd class='body--doc'><p><code>tell()</code></p> </dd></dl> <hr /> <dl class='group--doc'> <dt class='head--type'><span class='homogen--type'>Method</span>
+
<span class='homogen--name'><b>seek</b></span>
+
</dt>
+
<dd><p><code><code class='modifier'>variant</code> <code class='deprecated'>__deprecated__</code> <code class='datatype'>int</code> <b><span class='method'>seek</span>(</b><code class='datatype'>int</code> <code class='argument'>unit</code>, <code class='datatype'>int</code> <code class='argument'>mult</code><b>)</b></code><br>
+
<code><code class='modifier'>variant</code> <code class='deprecated'>__deprecated__</code> <code class='datatype'>int</code> <b><span class='method'>seek</span>(</b><code class='datatype'>int</code> <code class='argument'>unit</code>, <code class='datatype'>int</code> <code class='argument'>mult</code>, <code class='datatype'>int</code> <code class='argument'>add</code><b>)</b></code></p></dd>
+
+
<dt class='head--doc'>Description</dt>
+
<dd class='body--doc'><p>Seek to a specified offset in a file.</p>
+
<p> If <code>mult</code> or <code>add</code> are specified, <code>pos</code> is calculated as
+
<code class='expr'><code>pos</code> = <code>unit</code>*<code>mult</code> + <code>add</code></code>.</p>
+
<p> If <code>pos</code> is negative then it is relative to the end of the file,
+
otherwise it's an absolute offset from the start of the file.</p>
+
</dd>
+
<dt class='head--doc'>Returns</dt>
+
<dd class='body--doc'><p>Returns the new offset, or <code class='expr'>-1</code> on failure.</p>
+
</dd>
+
<dt class='head--doc'>Note</dt>
+
<dd class='body--doc'><p>The arguments <code>mult</code> and <code>add</code> are considered obsolete, and
+
should not be used.</p>
+
</dd>
+
<dt class='head--doc'>See also</dt>
+
<dd class='body--doc'><p><code>tell()</code></p>
+
</dd></dl>
+
+
+
<hr />
+
<dl class='group--doc'>
+
<dt class='head--type'><span class='homogen--type'>Method</span>
<span class='homogen--name'><b>send_fd</b></span> </dt> <dd><p><code><code class='datatype'>void</code> <b><span class='method'>send_fd</span>(</b><code class='object unresolved'>Stdio.Fd</code> <code class='argument'>fd</code><b>)</b></code></p></dd> <dt class='head--doc'>Description</dt> <dd class='body--doc'><p>Queues an open file descriptor for sending to the other end of a stream.</p> </dd> <dt class='head--doc'>Note</dt> <dd class='body--doc'><p>The actual sending is performed at the next successful call to <code>write()</code>, this is due to limitations in the system calls.