summaryrefslogtreecommitdiff
path: root/docs/man/man3/socket.h.3
blob: 788e52df6e5ffcc8eb8ff4c84b33945e9b761d29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
.TH "socket.h" 3 "15 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
.ad l
.nh
.SH NAME
socket.h \- 
.SH SYNOPSIS
.br
.PP
\fC#include <sys/types.h>\fP
.br
\fC#include <sys/socket.h>\fP
.br
\fC#include <netinet/in.h>\fP
.br
\fC#include <sstream>\fP
.br
\fC#include <string>\fP
.br

.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBInspSocket\fP"
.br
.RI "\fIInspSocket is an extendable socket class which modules can use for TCP socket support. \fP"
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBInspSocketState\fP { \fBI_DISCONNECTED\fP, \fBI_CONNECTING\fP, \fBI_CONNECTED\fP, \fBI_LISTENING\fP, \fBI_ERROR\fP }"
.br
.RI "\fIStates which a socket may be in. \fP"
.ti -1c
.RI "enum \fBInspSocketError\fP { \fBI_ERR_TIMEOUT\fP, \fBI_ERR_SOCKET\fP, \fBI_ERR_CONNECT\fP, \fBI_ERR_BIND\fP }"
.br
.RI "\fIError types which a socket may exhibit. \fP"
.in -1c
.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBInspSocketError\fP"
.PP
Error types which a socket may exhibit. 
.PP
\fBEnumerator: \fP
.in +1c
.TP
\fB\fII_ERR_TIMEOUT \fP\fP
.TP
\fB\fII_ERR_SOCKET \fP\fP
.TP
\fB\fII_ERR_CONNECT \fP\fP
.TP
\fB\fII_ERR_BIND \fP\fP

.PP
Definition at line 34 of file socket.h.
.PP
.nf
34 { I_ERR_TIMEOUT, I_ERR_SOCKET, I_ERR_CONNECT, I_ERR_BIND };
.fi
.PP
.SS "enum \fBInspSocketState\fP"
.PP
States which a socket may be in. 
.PP
\fBEnumerator: \fP
.in +1c
.TP
\fB\fII_DISCONNECTED \fP\fP
.TP
\fB\fII_CONNECTING \fP\fP
.TP
\fB\fII_CONNECTED \fP\fP
.TP
\fB\fII_LISTENING \fP\fP
.TP
\fB\fII_ERROR \fP\fP

.PP
Definition at line 29 of file socket.h.
.PP
.nf
29 { I_DISCONNECTED, I_CONNECTING, I_CONNECTED, I_LISTENING, I_ERROR };
.fi
.PP
.SH "Author"
.PP 
Generated automatically by Doxygen for InspIRCd from the source code.