source: roaraudio/doc/man3/roar_stream_connect_to.3 @ 4013:abd38c189de7

Last change on this file since 4013:abd38c189de7 was 4013:abd38c189de7, checked in by phi, 14 years ago

some manpage fixes

File size: 1.5 KB
Line 
1.\" roar_simple_play.3:
2
3.TH "roar_stream_connect_to" "3" "July 2008" "RoarAudio" "System Manager's Manual: RoarAuido"
4
5.SH NAME
6roar_stream_connect_to \- Connects a stream to some listening socket
7
8.SH SYNOPSIS
9
10#include <roaraudio.h>
11
12int roar_stream_connect_to(struct roar_connection * con, struct roar_stream * s, int type, char * host, int port);
13
14.SH "DESCRIPTION"
15This let the sound server connect to some remote end to get it's data for a stream.
16This is used internaly to open additional streams for \fBroar_simple_new_stream\fR(3).
17
18\fBNOTE:\fR
19This 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
25The connection to the server.
26
27.TP
28\fBs\fR
29The stream to connect.
30
31.TP
32\fBtype\fR, \fBhost\fR, \fBport\fR
33Where the stream should be connected to.
34For a description of all these parameters see \fBroar_socket_listen\fR(3).
35
36.SH "NOTES"
37This call will block untill the server process to connect to has accepted the connection.
38This makes this call unusable to connect back to us if we are not threaded. For a nonblocking call
39see \fBroar_stream_connect_to_ask\fR(3).
40
41.SH "RETURN VALUE"
42On success these calls return 0.  On error, \-1 is returned.
43
44.SH "EXAMPLES"
45FIXME
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.