The InspIRCd Project
Home | Developers | Wiki | Forums | Bug Tracker | SVN | Download
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

QLine Class Reference

QLine class. More...

#include <xline.h>

Inheritance diagram for QLine:

Inheritance graph
[legend]
Collaboration diagram for QLine:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 QLine (InspIRCd *Instance, time_t s_time, long d, const char *src, const char *re, const char *nickname)
 Create a G-Line.
 ~QLine ()
 Destructor.
virtual bool Matches (User *u)
 Returns true whether or not the given user is covered by this line.
virtual bool Matches (const std::string &str)
 Returns true whether or not the given string is covered by this line.
virtual void Apply (User *u)
 Apply a line against a user.
virtual void DisplayExpiry ()
 Called when the expiry message is to be displayed for the line.
virtual const char * Displayable ()
 Returns the displayable form of the pattern for this xline, e.g.

Public Attributes

char * nick
 Nickname mask.

Detailed Description

QLine class.

Definition at line 340 of file xline.h.


Constructor & Destructor Documentation

QLine::QLine InspIRCd Instance,
time_t  s_time,
long  d,
const char *  src,
const char *  re,
const char *  nickname
[inline]
 

Create a G-Line.

Parameters:
s_time The set time
d The duration of the xline
src The sender of the xline
re The reason of the xline
nickname Nickname to match

Definition at line 350 of file xline.h.

QLine::~QLine  )  [inline]
 

Destructor.

Definition at line 357 of file xline.h.


Member Function Documentation

void QLine::Apply User u  )  [virtual]
 

Apply a line against a user.

The mechanics of what occurs when the line is applied are specific to the derived class.

Parameters:
u The user to apply against

Reimplemented from XLine.

Definition at line 550 of file xline.cpp.

References User::ForceNickChange(), and User::uuid.

const char * QLine::Displayable  )  [virtual]
 

Returns the displayable form of the pattern for this xline, e.g.

'*' or '*baz*'. This must always return the full pattern in a form which can be used to construct an entire derived xline, even if it is stored differently internally (e.g. GLine stores the ident and host parts seperately but will still return ident for its Displayable() method)

Implements XLine.

Definition at line 644 of file xline.cpp.

References nick.

void QLine::DisplayExpiry  )  [virtual]
 

Called when the expiry message is to be displayed for the line.

Usually a line in the form 'expiring Xline blah, set by...' see the DisplayExpiry methods of GLine, ELine etc.

Implements XLine.

Definition at line 604 of file xline.cpp.

References XLine::ServerInstance, InspIRCd::SNO, and SnomaskManager::WriteToSnoMask().

bool QLine::Matches const std::string str  )  [virtual]
 

Returns true whether or not the given string is covered by this line.

Parameters:
str The string to match against. The details of what must be in this string and the mechanics of the match are defined by the derived class.
Returns:
True if there is a match

Implements XLine.

Definition at line 565 of file xline.cpp.

References InspIRCd::Match().

bool QLine::Matches User u  )  [virtual]
 

Returns true whether or not the given user is covered by this line.

Parameters:
u The user to match against. The mechanics of the match are defined by the derived class.
Returns:
True if there is a match.

Implements XLine.

Definition at line 542 of file xline.cpp.

References InspIRCd::Match(), and User::nick.


Member Data Documentation

char* QLine::nick
 

Nickname mask.

Definition at line 374 of file xline.h.

Referenced by Displayable().


The documentation for this class was generated from the following files: