| Line | |
|---|
| 1 | .\" roar_simple_play.3: |
|---|
| 2 | |
|---|
| 3 | .TH "roar_exit" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido" |
|---|
| 4 | |
|---|
| 5 | .SH NAME |
|---|
| 6 | roar_exit \- let RoarAudio's sound server quit |
|---|
| 7 | |
|---|
| 8 | roar_terminate \- let RoarAudio's sound server quit as soon as all clients quit |
|---|
| 9 | |
|---|
| 10 | .SH SYNOPSIS |
|---|
| 11 | |
|---|
| 12 | #include <roaraudio.h> |
|---|
| 13 | |
|---|
| 14 | int roar_exit(struct roar_connection * con); |
|---|
| 15 | |
|---|
| 16 | int roar_terminate(struct roar_connection * con, int terminate); |
|---|
| 17 | |
|---|
| 18 | .SH "DESCRIPTION" |
|---|
| 19 | Ask the sound server to quit. |
|---|
| 20 | |
|---|
| 21 | roar_exit() let the server quit .... |
|---|
| 22 | |
|---|
| 23 | roar_terminate() will let the server quit as soon as all clients disconnects |
|---|
| 24 | and all input streams ended. The listening socket will be closed. This is useful |
|---|
| 25 | in case of restarting roard. |
|---|
| 26 | |
|---|
| 27 | |
|---|
| 28 | .SH "PARAMETERS" |
|---|
| 29 | .TP |
|---|
| 30 | \fBcon\fR |
|---|
| 31 | An open controll connection to the server. |
|---|
| 32 | |
|---|
| 33 | .TP |
|---|
| 34 | \fBterminate\fR |
|---|
| 35 | Wait for all clients to disconnect and all streams to EOF in case of 1. |
|---|
| 36 | In case of 0 roar_terminate() is equal to roar_exit(). |
|---|
| 37 | |
|---|
| 38 | .SH "RETURN VALUE" |
|---|
| 39 | On success these calls return 0. On error, \-1 is returned. |
|---|
| 40 | |
|---|
| 41 | .SH "NOTES" |
|---|
| 42 | Even when the call was successfull you have to use \fBroar_disconnect\fR(3) to disconnect from the server. |
|---|
| 43 | |
|---|
| 44 | .SH "EXAMPLES" |
|---|
| 45 | FIXME |
|---|
| 46 | |
|---|
| 47 | .SH "SEE ALSO" |
|---|
| 48 | \fBroar_disconnect\fR(3), |
|---|
| 49 | \fBlibroar\fR(7), |
|---|
| 50 | \fBRoarAudio\fR(7). |
|---|
| 51 | |
|---|
| 52 | .\" ll |
|---|
Note: See
TracBrowser
for help on using the repository browser.
