summaryrefslogtreecommitdiff
path: root/doc/libstddjb/allreadwrite.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/libstddjb/allreadwrite.html')
-rw-r--r--doc/libstddjb/allreadwrite.html12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/libstddjb/allreadwrite.html b/doc/libstddjb/allreadwrite.html
index 8003431..9ad14de 100644
--- a/doc/libstddjb/allreadwrite.html
+++ b/doc/libstddjb/allreadwrite.html
@@ -44,7 +44,7 @@ use higher-level APIs such as <a href="buffer.html">buffer</a> and
<h2> Function types </h2>
<p>
-<code> typedef ssize_t iofunc_t (int fd, char *buf, size_t len) </code> <br />
+<code> typedef ssize_t io_func (int fd, char *buf, size_t len) </code> <br />
This is the simplified type of IO functions such as
<a href="https://www.opengroup.org/onlinepubs/9699919799/functions/read.html">read()</a>
and
@@ -52,7 +52,7 @@ and
</p>
<p>
-<code> typedef ssize_t iovfunc_t (int fd, struct iovec const *v, unsigned int vlen) </code> <br />
+<code> typedef ssize_t iov_func (int fd, struct iovec const *v, unsigned int vlen) </code> <br />
This is the simplified type of IO functions such as
<a href="https://www.opengroup.org/onlinepubs/9699919799/functions/readv.html">readv()</a>
and
@@ -64,7 +64,7 @@ elements instead of a single string.
<p>
-<code> typedef size_t alliofunc_t (int fd, char *buf, size_t len) </code> <br />
+<code> typedef size_t allio_func (int fd, char *buf, size_t len) </code> <br />
This is the type of an IO operation that expects <em>all</em> of its
<em>len</em> bytes to be sent or received, and that will loop around a
lower-level IO function until either <em>len</em> bytes have been
@@ -100,7 +100,7 @@ Returns the inverse of <code>sanitize_read</code>.
</p>
<p>
-<code> size_t allreadwrite (iofunc_t *f, int fd, char *s, size_t len) </code> <br />
+<code> size_t allreadwrite (io_func *f, int fd, char *s, size_t len) </code> <br />
*<em>f</em> must be a basic reading or writing function such as
<tt>fd_read</tt> or <tt>fd_write</tt>. <tt>allreadwrite()</tt> performs
*<em>f</em> on <em>fd</em>, <em>s</em> and <em>len</em> until <em>len</em>
@@ -112,7 +112,7 @@ set errno to EWOULDBLOCK or EAGAIN.
</p>
<p>
-<code> size_t allreadwritev (iovfunc_t *f, int fd, struct iovec const *v, unsigned int vlen) </code> <br />
+<code> size_t allreadwritev (iov_func *f, int fd, struct iovec const *v, unsigned int vlen) </code> <br />
Like <code> allreadwrite </code>
but the content to perform IO on is specified as a
<a href="siovec.html">scatter/gather array</a> of <em>vlen</em>
@@ -171,7 +171,7 @@ an error occurs.
<p>
<code> size_t allwrite (int fd, char const *s, size_t len) </code> <br />
-Equivalent to <code> allreadwrite((iofunc_t *)&amp;fd_write, fd, s, len) </code>:
+Equivalent to <code> allreadwrite((io_func *)&amp;fd_write, fd, s, len) </code>:
attempts to write <em>len</em> bytes from <em>s</em> to <em>fd</em>, looping
around <tt>fd_write()</tt> if necessary, until either <em>len</em> bytes are
written or an error occurs.