docs/man/man3/socket.h.3

   1 .TH "socket.h" 3 "15 Dec 2005" "Version 1.0Betareleases" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 socket.h \-
   6 .SH SYNOPSIS
   7 .br
   8 .PP
   9 \fC#include <sys/types.h>\fP
  10 .br
  11 \fC#include <sys/socket.h>\fP
  12 .br
  13 \fC#include <netinet/in.h>\fP
  14 .br
  15 \fC#include <sstream>\fP
  16 .br
  17 \fC#include <string>\fP
  18 .br
  19
  20 .SS "Classes"
  21
  22 .in +1c
  23 .ti -1c
  24 .RI "class \fBInspSocket\fP"
  25 .br
  26 .RI "\fIInspSocket is an extendable socket class which modules can use for TCP socket support. \fP"
  27 .in -1c
  28 .SS "Enumerations"
  29
  30 .in +1c
  31 .ti -1c
  32 .RI "enum \fBInspSocketState\fP { \fBI_DISCONNECTED\fP, \fBI_CONNECTING\fP, \fBI_CONNECTED\fP, \fBI_LISTENING\fP, \fBI_ERROR\fP }"
  33 .br
  34 .RI "\fIStates which a socket may be in. \fP"
  35 .ti -1c
  36 .RI "enum \fBInspSocketError\fP { \fBI_ERR_TIMEOUT\fP, \fBI_ERR_SOCKET\fP, \fBI_ERR_CONNECT\fP, \fBI_ERR_BIND\fP }"
  37 .br
  38 .RI "\fIError types which a socket may exhibit. \fP"
  39 .in -1c
  40 .SH "Enumeration Type Documentation"
  41 .PP
  42 .SS "enum \fBInspSocketError\fP"
  43 .PP
  44 Error types which a socket may exhibit.
  45 .PP
  46 \fBEnumerator: \fP
  47 .in +1c
  48 .TP
  49 \fB\fII_ERR_TIMEOUT \fP\fP
  50 .TP
  51 \fB\fII_ERR_SOCKET \fP\fP
  52 .TP
  53 \fB\fII_ERR_CONNECT \fP\fP
  54 .TP
  55 \fB\fII_ERR_BIND \fP\fP
  56
  57 .PP
  58 Definition at line 34 of file socket.h.
  59 .PP
  60 .nf
  61 34 { I_ERR_TIMEOUT, I_ERR_SOCKET, I_ERR_CONNECT, I_ERR_BIND };
  62 .fi
  63 .PP
  64 .SS "enum \fBInspSocketState\fP"
  65 .PP
  66 States which a socket may be in.
  67 .PP
  68 \fBEnumerator: \fP
  69 .in +1c
  70 .TP
  71 \fB\fII_DISCONNECTED \fP\fP
  72 .TP
  73 \fB\fII_CONNECTING \fP\fP
  74 .TP
  75 \fB\fII_CONNECTED \fP\fP
  76 .TP
  77 \fB\fII_LISTENING \fP\fP
  78 .TP
  79 \fB\fII_ERROR \fP\fP
  80
  81 .PP
  82 Definition at line 29 of file socket.h.
  83 .PP
  84 .nf
  85 29 { I_DISCONNECTED, I_CONNECTING, I_CONNECTED, I_LISTENING, I_ERROR };
  86 .fi
  87 .PP
  88 .SH "Author"
  89 .PP
  90 Generated automatically by Doxygen for InspIRCd from the source code.