Line | |
---|
1 | .TH "roar_vs_iterate" "3" "June 2011" "RoarAudio" "RoarAudio Programmer's Manual" |
---|
2 | |
---|
3 | .SH NAME |
---|
4 | roar_vs_iterate, roar_vs_run \- Iterate streams |
---|
5 | |
---|
6 | .SH SYNOPSIS |
---|
7 | |
---|
8 | #include <roaraudio.h> |
---|
9 | |
---|
10 | int roar_vs_iterate (roar_vs_t * vss, int wait, int * error); |
---|
11 | |
---|
12 | int roar_vs_run (roar_vs_t * vss, int * error); |
---|
13 | |
---|
14 | .SH "DESCRIPTION" |
---|
15 | \fBroar_vs_iterate()\fR sends a block of data from the local buffer to the server or reads data from the |
---|
16 | server into the local buffer in blocking mode, or pushes or pulls data to or from server in file mode. |
---|
17 | |
---|
18 | \fBroar_vs_run()\fR does the same as roar_vs_iterate() but loops until EOF or error. |
---|
19 | |
---|
20 | .SH "PARAMETERS" |
---|
21 | .TP |
---|
22 | \fBvss\fR |
---|
23 | The VS object to be used. |
---|
24 | |
---|
25 | .TP |
---|
26 | \fBwait\fR |
---|
27 | If ROAR_VS_WAIT roar_vs_iterate() will block until data has been synced with the server. |
---|
28 | If ROAR_VS_NOWAIT roar_vs_iterate() will not block if no data can be send to or read from the server. |
---|
29 | |
---|
30 | .TP |
---|
31 | \fBerror\fR |
---|
32 | This is a pointer to a integer used to store the error value in case of error. |
---|
33 | This can be NULL if not used but it is very recommended to use this error value to report |
---|
34 | good error messages to the user. |
---|
35 | |
---|
36 | .SH "RETURN VALUE" |
---|
37 | On EOF these calls return 0. roar_vs_iterate() returns a positive value on non-EOF success. |
---|
38 | On error, \-1 is returned. |
---|
39 | |
---|
40 | .SH "EXAMPLES" |
---|
41 | FIXME |
---|
42 | |
---|
43 | .SH "SEE ALSO" |
---|
44 | \fBroarvs\fR(7), |
---|
45 | \fBlibroar\fR(7), |
---|
46 | \fBRoarAudio\fR(7). |
---|
47 | |
---|
48 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.