Line | |
---|
1 | .\" roar_simple_play.3: |
---|
2 | |
---|
3 | .TH "roar_stream_connect_to" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio" |
---|
4 | |
---|
5 | .SH NAME |
---|
6 | roar_stream_connect_to \- Connects a stream to some listening socket |
---|
7 | |
---|
8 | .SH SYNOPSIS |
---|
9 | |
---|
10 | #include <roaraudio.h> |
---|
11 | |
---|
12 | int roar_stream_connect_to(struct roar_connection * con, struct roar_stream * s, int type, char * host, int port); |
---|
13 | |
---|
14 | .SH "DESCRIPTION" |
---|
15 | This let the sound server connect to some remote end to get it's data for a stream. |
---|
16 | This is used internaly to open additional streams for \fBroar_simple_new_stream\fR(3). |
---|
17 | |
---|
18 | \fBNOTE:\fR |
---|
19 | This is not an alternative version of \fBroar_stream_connect\fR(3). You still need to connect the stream to the server via |
---|
20 | \fBroar_stream_connect\fR(3) before you can use this call. |
---|
21 | |
---|
22 | .SH "PARAMETERS" |
---|
23 | .TP |
---|
24 | \fBcon\fR |
---|
25 | The connection to the server. |
---|
26 | |
---|
27 | .TP |
---|
28 | \fBs\fR |
---|
29 | The stream to connect. |
---|
30 | |
---|
31 | .TP |
---|
32 | \fBtype\fR, \fBhost\fR, \fBport\fR |
---|
33 | Where the stream should be connected to. |
---|
34 | For a description of all these parameters see \fBroar_socket_listen\fR(3). |
---|
35 | |
---|
36 | .SH "NOTES" |
---|
37 | This call will block untill the server process to connect to has accepted the connection. |
---|
38 | This makes this call unusable to connect back to us if we are not threaded. For a nonblocking call |
---|
39 | see \fBroar_stream_connect_to_ask\fR(3). |
---|
40 | |
---|
41 | .SH "RETURN VALUE" |
---|
42 | On success these calls return 0. On error, \-1 is returned. |
---|
43 | |
---|
44 | .SH "EXAMPLES" |
---|
45 | FIXME |
---|
46 | |
---|
47 | .SH "SEE ALSO" |
---|
48 | \fBroar_simple_new_stream\fR(3), |
---|
49 | \fBroar_stream_connect\fR(3), |
---|
50 | \fBroar_socket_listen\fR(3), |
---|
51 | \fBlibroar\fR(7), |
---|
52 | \fBRoarAudio\fR(7). |
---|
53 | |
---|
54 | .\" ll |
---|
Note: See
TracBrowser
for help on using the repository browser.