docs/man/users.h.3

   1 .TH "users.h" 3 "30 Apr 2004" "InspIRCd" \" -*- nroff -*-
   2 .ad l
   3 .nh
   4 .SH NAME
   5 users.h \-
   6 .SH SYNOPSIS
   7 .br
   8 .PP
   9 \fC#include 'inspircd_config.h'\fP
  10 .br
  11 \fC#include 'channels.h'\fP
  12 .br
  13 \fC#include 'connection.h'\fP
  14 .br
  15 \fC#include <string>\fP
  16 .br
  17
  18 .SS "Compounds"
  19
  20 .in +1c
  21 .ti -1c
  22 .RI "class \fBConnectClass\fP"
  23 .br
  24 .RI "\fIHolds information relevent to <connect allow> and <connect deny> tags in the config file.\fP"
  25 .ti -1c
  26 .RI "class \fBInvited\fP"
  27 .br
  28 .RI "\fIHolds a channel name to which a user has been invited.\fP"
  29 .ti -1c
  30 .RI "class \fBuserrec\fP"
  31 .br
  32 .RI "\fIHolds all information about a user This class stores all information about a user connected to the irc server.\fP"
  33 .in -1c
  34 .SS "Defines"
  35
  36 .in +1c
  37 .ti -1c
  38 .RI "#define \fBSTATUS_OP\fP   4"
  39 .br
  40 .ti -1c
  41 .RI "#define \fBSTATUS_HOP\fP   2"
  42 .br
  43 .ti -1c
  44 .RI "#define \fBSTATUS_VOICE\fP   1"
  45 .br
  46 .ti -1c
  47 .RI "#define \fBSTATUS_NORMAL\fP   0"
  48 .br
  49 .ti -1c
  50 .RI "#define \fBCC_ALLOW\fP   0"
  51 .br
  52 .ti -1c
  53 .RI "#define \fBCC_DENY\fP   1"
  54 .br
  55 .in -1c
  56 .SS "Typedefs"
  57
  58 .in +1c
  59 .ti -1c
  60 .RI "typedef std::vector< \fBInvited\fP > \fBInvitedList\fP"
  61 .br
  62 .RI "\fIHolds a complete list of all channels to which a user has been invited and has not yet joined.\fP"
  63 .ti -1c
  64 .RI "typedef std::vector< \fBConnectClass\fP > \fBClassVector\fP"
  65 .br
  66 .RI "\fIHolds a complete list of all allow and deny tags from the configuration file (connection classes).\fP"
  67 .in -1c
  68 .SH "Define Documentation"
  69 .PP
  70 .SS "#define CC_ALLOW   0"
  71 .PP
  72 Definition at line 20 of file users.h.
  73 .SS "#define CC_DENY   1"
  74 .PP
  75 Definition at line 21 of file users.h.
  76 .SS "#define STATUS_HOP   2"
  77 .PP
  78 Definition at line 16 of file users.h.
  79 .SS "#define STATUS_NORMAL   0"
  80 .PP
  81 Definition at line 18 of file users.h.
  82 .SS "#define STATUS_OP   4"
  83 .PP
  84 Definition at line 15 of file users.h.
  85 .SS "#define STATUS_VOICE   1"
  86 .PP
  87 Definition at line 17 of file users.h.
  88 .SH "Typedef Documentation"
  89 .PP
  90 .SS "typedef std::vector<\fBConnectClass\fP> ClassVector"
  91 .PP
  92 Holds a complete list of all allow and deny tags from the configuration file (connection classes).Definition at line 70 of file users.h.
  93 .SS "typedef std::vector<\fBInvited\fP> InvitedList"
  94 .PP
  95 Holds a complete list of all channels to which a user has been invited and has not yet joined.Definition at line 64 of file users.h.
  96 .SH "Author"
  97 .PP
  98 Generated automatically by Doxygen for InspIRCd from the source code.