more man pages.
This commit is contained in:
parent
1bcce7eed7
commit
c30e4855e2
13
socket/socket_connected.3
Normal file
13
socket/socket_connected.3
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
.TH socket_connected 3
|
||||||
|
.SH NAME
|
||||||
|
socket_connected \- is a connection established on a socket?
|
||||||
|
.SH SYNTAX
|
||||||
|
.B #include <socket.h>
|
||||||
|
|
||||||
|
int \fBsocket_connected\fP(int \fIs\fR);
|
||||||
|
.SH DESCRIPTION
|
||||||
|
socket_connected returns 1 if \fIs\fR is a socket and a
|
||||||
|
connection is established, 0 otherwise.
|
||||||
|
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
socket_remote4(3), socket_remote6(3)
|
19
socket/socket_getifidx.3
Normal file
19
socket/socket_getifidx.3
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
.TH socket_getifidx 3
|
||||||
|
.SH NAME
|
||||||
|
socket_getifidx \- get interface number
|
||||||
|
.SH SYNTAX
|
||||||
|
.B #include <socket.h>
|
||||||
|
|
||||||
|
int \fBsocket_getifidx\fP(const char* \fIifname\fR);
|
||||||
|
.SH DESCRIPTION
|
||||||
|
socket_getifidx returns the interface number for a symbolic network
|
||||||
|
interface name (like "eth0" on Linux, for example).
|
||||||
|
|
||||||
|
The interface number can be used as scope_id for IPv6 communications on
|
||||||
|
link-local addresses.
|
||||||
|
|
||||||
|
If something goes wrong, socket_getifidx returns -1, setting errno
|
||||||
|
appropriately.
|
||||||
|
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
socket_getifname(3), socket_connect6(3)
|
17
socket/socket_getifname.3
Normal file
17
socket/socket_getifname.3
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
.TH socket_getifname 3
|
||||||
|
.SH NAME
|
||||||
|
socket_getifname \- get interface name
|
||||||
|
.SH SYNTAX
|
||||||
|
.B #include <socket.h>
|
||||||
|
|
||||||
|
const char* \fBsocket_getifname\fP(uint32 \fIinterface\fR);
|
||||||
|
.SH DESCRIPTION
|
||||||
|
socket_getifname returns the symbolic interface name for a network
|
||||||
|
interface number. The returned char* is a static buffer in the libc.
|
||||||
|
If you query the named for more than one interface, you have to save the
|
||||||
|
name before calling \fBsocket_getifidx\fR again.
|
||||||
|
|
||||||
|
If something goes wrong, socket_getifname returns "[unknown]".
|
||||||
|
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
socket_getifidx(3), socket_connect6(3)
|
@ -8,12 +8,7 @@ int \fBsocket_mcjoin4\fP(int \fIs\fR,const char \fIgroupip\fR[4],const char \fIi
|
|||||||
.SH DESCRIPTION
|
.SH DESCRIPTION
|
||||||
socket_mcjoin4 joins the IPv4 multicast group \fIgroupip\fR on \fIinterface\fR.
|
socket_mcjoin4 joins the IPv4 multicast group \fIgroupip\fR on \fIinterface\fR.
|
||||||
|
|
||||||
TODO
|
If something goes wrong, socket_mcjoin4 returns -1, setting errno
|
||||||
|
|
||||||
socket \fIs\fR and writes the IP address to \fIip\fR and the port to
|
|
||||||
\fIport\fR.
|
|
||||||
|
|
||||||
If something goes wrong, socket_local4 returns -1, setting errno
|
|
||||||
appropriately.
|
appropriately.
|
||||||
.SH "SEE ALSO"
|
.SH "SEE ALSO"
|
||||||
socket_accept4(3), socket_remote4(3)
|
socket_mcleave4(3), socket_mcjoin6(3), socket_getifidx(3)
|
||||||
|
14
socket/socket_mcjoin6.3
Normal file
14
socket/socket_mcjoin6.3
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
.TH socket_mcjoin6 3
|
||||||
|
.SH NAME
|
||||||
|
socket_mcjoin6 \- join a multicast group
|
||||||
|
.SH SYNTAX
|
||||||
|
.B #include <socket.h>
|
||||||
|
|
||||||
|
int \fBsocket_mcjoin6\fP(int \fIs\fR,const char \fIgroupip\fR[16],uint32 \fIinterface\fR);
|
||||||
|
.SH DESCRIPTION
|
||||||
|
socket_mcjoin6 joins the IPv6 multicast group \fIgroupip\fR on \fIinterface\fR.
|
||||||
|
|
||||||
|
If something goes wrong, socket_mcjoin6 returns -1, setting errno
|
||||||
|
appropriately.
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
socket_mcleave6(3), socket_mcjoin4(3), socket_getifidx(3)
|
14
socket/socket_mcleave4.3
Normal file
14
socket/socket_mcleave4.3
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
.TH socket_mcleave4 3
|
||||||
|
.SH NAME
|
||||||
|
socket_mcleave4 \- leave a multicast group
|
||||||
|
.SH SYNTAX
|
||||||
|
.B #include <socket.h>
|
||||||
|
|
||||||
|
int \fBsocket_mcleave4\fP(int \fIs\fR, const char \fIgroupip\fR[4], const char \fIinterface\fR[4]);
|
||||||
|
.SH DESCRIPTION
|
||||||
|
socket_mcleave4 leaves the IPv4 multicast group \fIgroupip\fR on \fIinterface\fR.
|
||||||
|
|
||||||
|
If something goes wrong, socket_mcleave4 returns -1, setting errno
|
||||||
|
appropriately.
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
socket_mcjoin4(3), socket_mcleave6(3), socket_getifidx(3)
|
14
socket/socket_mcleave6.3
Normal file
14
socket/socket_mcleave6.3
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
.TH socket_mcleave6 3
|
||||||
|
.SH NAME
|
||||||
|
socket_mcleave6 \- leave a multicast group
|
||||||
|
.SH SYNTAX
|
||||||
|
.B #include <socket.h>
|
||||||
|
|
||||||
|
int \fBsocket_mcleave6\fP(int \fIs\fR, const char \fIgroupip\fR[16], uint32 \fIinterface\fR);
|
||||||
|
.SH DESCRIPTION
|
||||||
|
socket_mcleave6 leaves the IPv6 multicast group \fIgroupip\fR on \fIinterface\fR.
|
||||||
|
|
||||||
|
If something goes wrong, socket_mcleave6 returns -1, setting errno
|
||||||
|
appropriately.
|
||||||
|
.SH "SEE ALSO"
|
||||||
|
socket_mcjoin6(3), socket_mcleave4(3), socket_getifidx(3)
|
Loading…
x
Reference in New Issue
Block a user