File: muroar_close.3

package info (click to toggle)
muroar 0.1.8-2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 256 kB
  • sloc: ansic: 873; sh: 236; makefile: 134
file content (35 lines) | stat: -rw-r--r-- 848 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
.\" muroar_beep.3

.TH "muroar_close" "3" "April 2012" "muRoar" "muRoar Programmer's Manual"

.SH NAME
muroar_close \- Disconnect stream from RoarAudio sound server

.SH SYNOPSIS

#include <muroar.h>

int muroar_close(muroar_t fh);

.SH "DESCRIPTION"

This function disconnects a data connection (stream) from the sound server in a clean way.
The socket is closed by this function. No additional \fBclose\fR(2) is needed.

Open control connections which are not created by \fBmuroar_stream\fR(3) must not be closed
using this function. They must be closed using \fBmuroar_quit\fR(3).

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

.SH HISTORY

This function first appeared in muRoar version 0.1beta0.

.SH "SEE ALSO"
\fBmuroar_connect\fR(3),
\fBmuroar_stream\fR(3),
\fBmuroar_quit\fR(3),
\fBRoarAudio\fR(7).

.\" ll