Changeset 5296:b7fd2c45243e in roaraudio for doc

Timestamp:

11/25/11 02:27:12 (12 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

Updated connection object. (Closes: #188)

Location:

doc

Files:

• man3/roar_disconnect.3 (modified) (2 diffs)
• symlinks.src (modified) (1 diff)

doc/man3/roar_disconnect.3

@@ -1 +1 @@
 .\" roar_simple_play.3:
 
-.TH "roar_disconnect" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"
+.TH "roar_connectionref" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"
 
 .SH NAME
-roar_disconnect \- disconnect from RoarAudio's sound server
+roar_connectionref, roar_connectionunref \- change reference counter for RoarAudio connections
 
 .SH SYNOPSIS
@@ -10 +10 @@
 #include <roaraudio.h>
 
-int roar_disconnect(struct roar_connection * con);
+int roar_connectionref(struct roar_connection * con);
+
+int roar_connectionunref(struct roar_connection * con);
+
+#define roar_disconnect(x) roar_connectionunref((x))
 
 .SH "DESCRIPTION"
-Closes es connection previously opend via \fBBroar_simple_connect\fR(3) or \fBBroar_simple_connect2\fR(3).
-
+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 closed.
+The connection to be altered.
 
 .SH "RETURN VALUE"

doc/symlinks.src

@@ -29 +29 @@
 roar_vs_latency                 3       roar_vs_position        3
 roar_vs_latency2                3       roar_vs_position        3
+roar_connectionref              3       roar_disconnect         3
+roar_connectionunref            3       roar_disconnect         3