source: roaraudio/doc/man3/roar_exit.3 @ 5050:ac5ec473f00c

.\" roar_simple_play.3:

.TH "roar_exit" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"

.SH NAME
roar_exit \- let RoarAudio's sound server quit

roar_terminate \- let RoarAudio's sound server quit as soon as all clients quit

.SH SYNOPSIS

#include <roaraudio.h>

int roar_exit(struct roar_connection * con);

int roar_terminate(struct roar_connection * con, int terminate);

.SH "DESCRIPTION"
Ask the sound server to quit.

roar_exit() let the server quit without waiting for any clients.
All streams and client connections will be closed cleanly.

roar_terminate() will let the server quit as soon as all clients disconnects
and all input streams ended. The listening socket will be closed. This is useful
in case of restarting roard.


.SH "PARAMETERS"
.TP
\fBcon\fR
An open controll connection to the server.

.TP
\fBterminate\fR
Wait for all clients to disconnect and all streams to EOF in case of 1.
In case of 0 roar_terminate() is equal to roar_exit().

.SH "RETURN VALUE"
On success these calls return 0.  On error, \-1 is returned.

.SH "NOTES"
Even when the call was successfull you have to use \fBroar_disconnect\fR(3) to disconnect from the server.

.SH "EXAMPLES"
FIXME

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

.\" ll