source: roaraudio/doc/man3/roar_connect.3 @ 5058:45211d6eeea9

.\" roar_simple_play.3:

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

.SH NAME
roar_connect, roar_connect2 \- connects to RoarAudio's sound server

.SH SYNOPSIS

#include <roaraudio.h>

int roar_connect(struct roar_connection * con, char * server);
int roar_connect2     (struct roar_connection * con, char * server, int flags, uint_least32_t timeout);

.SH "DESCRIPTION"
Connects to RoarAudio's sound server.
This calls just connects to the sound server without any authentication or identify.
Do not use this from end user applications. Use \fBroar_simple_connect\fR(3) or \fBroar_simple_connect2\fR(3).


.SH "PARAMETERS"
.TP
\fBcon\fR
The connection object to be filled with the data needed to talk to the server used by nearly all other calls.

.TP
\fBserver\fR
The server to connect to.

.TP
\fBflags\fR
Flags used to connect to the server. Currently only ROAR_ENUM_FLAG_NONE and ROAR_ENUM_FLAG_NONBLOCK are supported.
ROAR_ENUM_FLAG_NONBLOCK disables some of the server location features.

.TP
\fBtimeout\fR
Timeout for the connection. A value of zero means no timeout. Currently timeouts are not supported.

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

.SH "EXAMPLES"
See libroar/simple.c, \fBroar_simple_connect\fR(3).

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

.\" ll