source: roaraudio/doc/man3/roar_disconnect.3 @ 6048:f37c7f362422

.\" roar_simple_play.3:

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

.SH NAME
roar_connectionref, roar_connectionunref \- change reference counter for RoarAudio connections

.SH SYNOPSIS

#include <roaraudio.h>

int roar_connectionref(struct roar_connection * con);

int roar_connectionunref(struct roar_connection * con);

#define roar_disconnect(x) roar_connectionunref((x))

.SH "DESCRIPTION"
Those functions change the reference counter for connection objects
previously opend via \fBroar_connect\fR(3), \fBroar_connect_fh\fR(3) or \fBroar_simple_connect\fR(3).
If the reference counter hints zero the connection is closed and the object is destroyed.
.PP
The \fBroar_disconnect\fR(3) macro is provided to be source compatible (recompile needed)
with RoarAudio 0.4 or older.

.SH "PARAMETERS"
.TP
\fBcon\fR
The connection to be altered.

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

.SH "EXAMPLES"
FIXME

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

.\" ll