source: roaraudio/doc/man3/roar_vs_iterate.3 @ 5057:9fdd843b0bbf

.TH "roar_vs_iterate" "3" "June 2011" "RoarAudio" "RoarAudio Programmer's Manual"

.SH NAME
roar_vs_iterate, roar_vs_run \- Iterate streams

.SH SYNOPSIS

#include <roaraudio.h>

int     roar_vs_iterate       (roar_vs_t * vss, int wait, int * error);

int     roar_vs_run           (roar_vs_t * vss, int * error);

.SH "DESCRIPTION"
\fBroar_vs_iterate()\fR sends a block of data from the local buffer to the server or reads data from the
server into the local buffer in blocking mode, or pushes or pulls data to or from server in file mode.

\fBroar_vs_run()\fR does the same as roar_vs_iterate() but loops until EOF or error.

.SH "PARAMETERS"
.TP
\fBvss\fR
The VS object to be used.

.TP
\fBwait\fR
If ROAR_VS_WAIT roar_vs_iterate() will block until data has been synced with the server.
If ROAR_VS_NOWAIT roar_vs_iterate() will not block if no data can be send to or read from the server.

.TP
\fBerror\fR
This is a pointer to a integer used to store the error value in case of error.
This can be NULL if not used but it is very recommended to use this error value to report
good error messages to the user.

.SH "RETURN VALUE"
On EOF these calls return 0. roar_vs_iterate() returns a positive value on non-EOF success.
On error, \-1 is returned.

.SH "EXAMPLES"
FIXME

.SH "SEE ALSO"
\fBroarvs\fR(7),
\fBlibroar\fR(7),
\fBRoarAudio\fR(7).

.\" ll