Line | |
---|
1 | .\" roar_simple_play.3: |
---|
2 | |
---|
3 | .TH "roar_connectionref" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" |
---|
4 | |
---|
5 | .SH NAME |
---|
6 | roar_connectionref, roar_connectionunref \- change reference counter for RoarAudio connections |
---|
7 | |
---|
8 | .SH SYNOPSIS |
---|
9 | |
---|
10 | #include <roaraudio.h> |
---|
11 | |
---|
12 | int roar_connectionref(struct roar_connection * con); |
---|
13 | |
---|
14 | int roar_connectionunref(struct roar_connection * con); |
---|
15 | |
---|
16 | #define roar_disconnect(x) roar_connectionunref((x)) |
---|
17 | |
---|
18 | .SH "DESCRIPTION" |
---|
19 | Those functions change the reference counter for connection objects |
---|
20 | previously opend via \fBroar_connect\fR(3), \fBroar_connect_fh\fR(3) or \fBroar_simple_connect\fR(3). |
---|
21 | If the reference counter hints zero the connection is closed and the object is destroyed. |
---|
22 | .PP |
---|
23 | The \fBroar_disconnect\fR(3) macro is provided to be source compatible (recompile needed) |
---|
24 | with RoarAudio 0.4 or older. |
---|
25 | |
---|
26 | .SH "PARAMETERS" |
---|
27 | .TP |
---|
28 | \fBcon\fR |
---|
29 | The connection to be altered. |
---|
30 | |
---|
31 | .SH "RETURN VALUE" |
---|
32 | On success these calls return 0. On error, \-1 is returned. |
---|
33 | |
---|
34 | .SH "EXAMPLES" |
---|
35 | FIXME |
---|
36 | |
---|
37 | .SH "SEE ALSO" |
---|
38 | \fBroar_simple_connect\fR(3), |
---|
39 | \fBlibroar\fR(7), |
---|
40 | \fBRoarAudio\fR(7). |
---|
41 | |
---|
42 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.