docs/man/man3/users.h.3

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