Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

userrec Class Reference

Holds all information about a user This class stores all information about a user connected to the irc server. More...

#include <users.h>

Inheritance diagram for userrec:

connection classbase List of all members.

Public Methods

 userrec ()
virtual ~userrec ()
virtual char * GetFullHost ()
 Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.

virtual char * GetFullRealHost ()
 Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.

virtual bool IsInvited (char *channel)
 Returns true if a user is invited to a channel.

virtual void InviteTo (char *channel)
 Adds a channel to a users invite list (invites them to a channel).

virtual void RemoveInvite (char *channel)
 Removes a channel from a users invite list.


Public Attributes

char nick [NICKMAX]
 The users nickname.

char ident [64]
 The users ident reply.

char dhost [256]
 The host displayed to non-opers (used for cloaking etc).

char fullname [128]
 The users full name.

char modes [32]
 The user's mode string.

ucrec chans [MAXCHANS]
char server [256]
 The server the user is connected to.

char awaymsg [512]
 The user's away message.

char result [256]
 Stores the result of the last GetFullHost or GetRealHost call.


Private Attributes

InvitedList invites
 A list of channels the user has a pending invite to.

Detailed Description

Holds all information about a user This class stores all information about a user connected to the irc server.

Everything about a connection is stored here primarily, from the user's socket ID (file descriptor) through to the user's nickname and hostname. Use the Find method of the server class to locate a specific user by nickname.

Definition at line 84 of file users.h.

Constructor & Destructor Documentation

userrec::userrec (    ) 
 

Definition at line 26 of file users.cpp.

References connection::bytes_in, connection::bytes_out, ucrec::channel, chans, connection::cmds_in, connection::cmds_out, connection::fd, connection::haspassed, connection::idle_lastmsg, invites, connection::ip, connection::lastping, connection::nping, connection::port, connection::registered, and connection::signon. 

00027 {
00028         // the PROPER way to do it, AVOID bzero at *ALL* costs
00029         strcpy(nick,"");
00030         ip = 0;
00031         strcpy(ident,"");
00032         strcpy(host,"");
00033         strcpy(dhost,"");
00034         strcpy(fullname,"");
00035         strcpy(modes,"");
00036         strcpy(inbuf,"");
00037         strcpy(server,"");
00038         strcpy(awaymsg,"");
00039         fd = lastping = signon = idle_lastmsg = nping = registered = 0;
00040         port = bytes_in = bytes_out = cmds_in = cmds_out = 0;
00041         haspassed = false;
00042         strcpy(result,"");
00043         for (int i = 0; i < MAXCHANS; i++)
00044         {
00045                 chans[i].channel = NULL;
00046         }
00047         invites.clear();
00048 }

virtual userrec::~userrec (    )  [inline, virtual]
 

Definition at line 136 of file users.h. 

00136 {  }

Member Function Documentation

char * userrec::GetFullHost (    )  [virtual]
 

Returns the full displayed host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.

Definition at line 51 of file users.cpp.

References result. 

00052 {
00053         sprintf(result,"%s!%s@%s",nick,ident,dhost);
00054         return result;
00055 }

char * userrec::GetFullRealHost (    )  [virtual]
 

Returns the full real host of the user This member function returns the hostname of the user as seen by other users on the server, in nick!identhost form.

If any form of hostname cloaking is in operation, e.g. through a module, then this method will ignore it and return the true hostname.

Definition at line 58 of file users.cpp.

References result. 

00059 {
00060         sprintf(result,"%s!%s@%s",nick,ident,host);
00061         return result;
00062 }

void userrec::InviteTo (  char *    channel )  [virtual]
 

Adds a channel to a users invite list (invites them to a channel).

Definition at line 75 of file users.cpp.

References Invited::channel, and invites. 

00076 {
00077         Invited i;
00078         strcpy(i.channel,channel);
00079         invites.push_back(i);
00080 }

bool userrec::IsInvited (  char *    channel )  [virtual]
 

Returns true if a user is invited to a channel.

Definition at line 64 of file users.cpp.

References invites. 

00065 {
00066         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
00067         {
00068                 if (!strcasecmp(i->channel,channel))
00069                 {
00070                         return true;
00071                 }
00072         }
00073 }

void userrec::RemoveInvite (  char *    channel )  [virtual]
 

Removes a channel from a users invite list.

This member function is called on successfully joining an invite only channel to which the user has previously been invited, to clear the invitation.

Definition at line 82 of file users.cpp.

References invites. 

00083 {
00084         for (InvitedList::iterator i = invites.begin(); i != invites.end(); i++)
00085         {
00086                 if (!strcasecmp(i->channel,channel))
00087                 {
00088                         invites.erase(i);
00089                         return;
00090                 }
00091         }
00092 }

Member Data Documentation

char userrec::awaymsg[512]
 

The user's away message.

If this string is empty, the user is not marked as away.

Definition at line 127 of file users.h.

ucrec userrec::chans[MAXCHANS]
 

Definition at line 118 of file users.h.

Referenced by userrec().

char userrec::dhost[256]
 

The host displayed to non-opers (used for cloaking etc).

This usually matches the value of userrec::host.

Definition at line 106 of file users.h.

char userrec::fullname[128]
 

The users full name.

Definition at line 110 of file users.h.

char userrec::ident[64]
 

The users ident reply.

Definition at line 101 of file users.h.

InvitedList userrec::invites [private]
 

A list of channels the user has a pending invite to.

Definition at line 90 of file users.h.

Referenced by InviteTo(), IsInvited(), RemoveInvite(), and userrec().

char userrec::modes[32]
 

The user's mode string.

This may contain any of the following RFC characters: o, w, s, i Your module may define other mode characters as it sees fit.

Definition at line 116 of file users.h.

char userrec::nick[NICKMAX]
 

The users nickname.

An invalid nickname indicates an unregistered connection prior to the NICK command.

Definition at line 97 of file users.h.

char userrec::result[256]
 

Stores the result of the last GetFullHost or GetRealHost call.

You may use this to increase the speed of use of this class.

Definition at line 132 of file users.h.

Referenced by GetFullHost(), and GetFullRealHost().

char userrec::server[256]
 

The server the user is connected to.

Definition at line 122 of file users.h.

The documentation for this class was generated from the following files:
Generated on Sun Jan 26 23:45:50 2003 for InspIRCd by doxygen1.3-rc2