Browse Source

the iob calls return int, not void

master
Felix von Leitner 10 years ago
parent
commit
cab6090eb7
  1. 2
      GNUmakefile
  2. 4
      io/iob_addbuf.3
  3. 5
      io/iob_addbuf_free.3
  4. 4
      io/iob_addfile.3
  5. 5
      io/iob_addfile_close.3

2
GNUmakefile

@ -72,7 +72,7 @@ TAI_OBJS=$(patsubst tai/%.c,%.o,$(wildcard tai/*.c))
TAIA_OBJS=$(patsubst taia/%.c,%.o,$(wildcard taia/*.c))
DNS_OBJS=$(patsubst dns/%.c,%.o,$(wildcard dns/*.c))
CASE_OBJS=$(patsubst case/%.c,%.o,$(wildcard case/*.c))
ARRAY_OBJS=$(patsubst array/%.c,%.o,$(wildcard array/*.c))
ARRAY_OBJS=$(patsubst array/%.c,%.o,$(wildcard array/array_*.c))
MULT_OBJS=$(patsubst mult/%.c,%.o,$(wildcard mult/*.c))
IO_OBJS=$(patsubst io/%.c,%.o,$(wildcard io/*.c))
CDB_OBJS=$(patsubst cdb/%.c,%.o,$(wildcard cdb/*.c))

4
io/iob_addbuf.3

@ -4,12 +4,14 @@ iob_addbuf \- add buffer to I/O batch
.SH SYNTAX
.B #include <iob.h>
void \fBiob_addbuf\fP(io_batch* b,const void* buf,uint64 n);
int \fBiob_addbuf\fP(io_batch* b,const void* buf,uint64 n);
.SH DESCRIPTION
iob_addbuf schedules \fIn\fR bytes starting at \fIbuf\fR to be written
with the I/O batch \fIb\fR.
Use \fBiob_addbuf_free\fR if you want the buffer to be deallocated
automatically by \fBiob_reset\fR.
.SH "RETURN VALUE"
Returns 1 on success, 0 on failure.
.SH "SEE ALSO"
iob_reset(3), iob_send(3), iob_addbuf_free(3), iob_adds(3), iob_addfile(3)

5
io/iob_addbuf_free.3

@ -4,11 +4,14 @@ iob_addbuf_free \- add buffer to I/O batch, with deallocation
.SH SYNTAX
.B #include <iob.h>
void \fBiob_addbuf_free\fP(io_batch* b,const void* buf,uint64 n);
int \fBiob_addbuf_free\fP(io_batch* b,const void* buf,uint64 n);
.SH DESCRIPTION
iob_addbuf_free schedules \fIn\fR bytes starting at \fIbuf\fR to be
written with the I/O batch \fIb\fR.
The buffer will automatically be deallocated by \fBiob_reset\fR.
.SH "RETURN VALUE"
Returns 1 if successful, 0 if not. In the failure case, the buffer was
deallocated.
.SH "SEE ALSO"
iob_reset(3), iob_send(3), iob_addbuf(3), iob_adds(3), iob_addfile(3)

4
io/iob_addfile.3

@ -4,7 +4,7 @@ iob_addfile \- add file region to I/O batch
.SH SYNTAX
.B #include <iob.h>
void \fBiob_addfile\fP(io_batch* b,int64 fd,uint64 off,uint64 n);
int \fBiob_addfile\fP(io_batch* b,int64 fd,uint64 off,uint64 n);
.SH DESCRIPTION
iob_addfile schedules \fIn\fR bytes from the file descriptor \fIfd\fR
starting at offset \fIoff\fR to be written with the I/O batch \fIb\fR.
@ -13,5 +13,7 @@ You may not close \fIfd\fR before iob_send indicates it is done.
Use \fBiob_addfile_close\fR if you want the file descriptor to be closed
automatically by \fBiob_reset\fR.
.SH "RETURN VALUE"
Returns 1 on success, 0 on failure.
.SH "SEE ALSO"
iob_reset(3), iob_send(3), iob_addbuf(3), iob_addfile_close(3)

5
io/iob_addfile_close.3

@ -4,7 +4,7 @@ iob_addfile_close \- add file region to I/O batch
.SH SYNTAX
.B #include <iob.h>
void \fBiob_addfile_close\fP(io_batch* b,int64 fd,uint64 off,uint64 n);
int \fBiob_addfile_close\fP(io_batch* b,int64 fd,uint64 off,uint64 n);
.SH DESCRIPTION
iob_addfile_close schedules \fIn\fR bytes from the file descriptor \fIfd\fR
starting at offset \fIoff\fR to be written with the I/O batch \fIb\fR.
@ -12,5 +12,8 @@ starting at offset \fIoff\fR to be written with the I/O batch \fIb\fR.
You may not close \fIfd\fR before iob_send indicates it is done.
\fBiob_reset\fR will call io_close(fd).
.SH "RETURN VALUE"
Returns 1 on success, 0 on failure. In the failure case, the file
descriptor has been closed.
.SH "SEE ALSO"
iob_reset(3), iob_send(3), iob_addbuf(3), iob_addfile(3)

Loading…
Cancel
Save