Line | |
---|
1 | .\" roar_simple_play.3: |
---|
2 | |
---|
3 | .TH "roar_exit" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" |
---|
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 without waiting for any clients. |
---|
22 | All streams and client connections will be closed cleanly. |
---|
23 | |
---|
24 | roar_terminate() will let the server quit as soon as all clients disconnects |
---|
25 | and all input streams ended. The listening socket will be closed. This is useful |
---|
26 | in case of restarting roard. |
---|
27 | |
---|
28 | |
---|
29 | .SH "PARAMETERS" |
---|
30 | .TP |
---|
31 | \fBcon\fR |
---|
32 | An open controll connection to the server. |
---|
33 | |
---|
34 | .TP |
---|
35 | \fBterminate\fR |
---|
36 | Wait for all clients to disconnect and all streams to EOF in case of 1. |
---|
37 | In case of 0 roar_terminate() is equal to roar_exit(). |
---|
38 | |
---|
39 | .SH "RETURN VALUE" |
---|
40 | On success these calls return 0. On error, \-1 is returned. |
---|
41 | |
---|
42 | .SH "NOTES" |
---|
43 | Even when the call was successfull you have to use \fBroar_disconnect\fR(3) to disconnect from the server. |
---|
44 | |
---|
45 | .SH "EXAMPLES" |
---|
46 | FIXME |
---|
47 | |
---|
48 | .SH "SEE ALSO" |
---|
49 | \fBroar_disconnect\fR(3), |
---|
50 | \fBlibroar\fR(7), |
---|
51 | \fBRoarAudio\fR(7). |
---|
52 | |
---|
53 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.