source: roaraudio/doc/man3/roar_socket_nonblock.3 @ 5050:ac5ec473f00c

Last change on this file since 5050:ac5ec473f00c was 5032:b2c8bbc7907f, checked in by phi, 13 years ago

some manpage correction

File size: 893 bytes
Line 
1.\" roar_simple_play.3:
2
3.TH "roar_socket_nonblock" "3" "May 2011" "RoarAudio" "System Manager's Manual: RoarAudio"
4
5.SH NAME
6roar_socket_nonblock \- Sets blocking state of a socket
7
8.SH SYNOPSIS
9
10#include <roaraudio.h>
11
12int roar_socket_nonblock(int fh, int state);
13
14.SH "DESCRIPTION"
15Sets the blocking mode of a given filehandle. For information on nonblocking IO see \fBopen\fR(2) an look for \fBO_NONBLOCK\fR.
16
17.SH "PARAMETERS"
18.TP
19\fBfh\fR
20The filehandle to set the new state on.
21
22.TP
23\fBstate\fR
24The new state. This may be \fBROAR_SOCKET_BLOCK\fR to sett blocking or \fBROAR_SOCKET_NONBLOCK\fR to set nonblocking mode.
25\fBROAR_SOCKET_NONBLOCK\fR is the same as setting \fBO_NONBLOCK\fR within \fBopen\fR(2).
26
27.SH "RETURN VALUE"
28On success these calls return 0.  On error, \-1 is returned.
29
30.SH "EXAMPLES"
31FIXME
32
33.SH "SEE ALSO"
34\fBopen\fR(2),
35\fBlibroar\fR(7),
36\fBRoarAudio\fR(7).
37
38.\" ll
Note: See TracBrowser for help on using the repository browser.