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

SVSHold Class Reference

Holds a SVSHold item. More...

Inheritance diagram for SVSHold:

Inheritance graph
[legend]
Collaboration diagram for SVSHold:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 SVSHold (InspIRCd *Instance, time_t s_time, long d, const char *src, const char *re, const char *nick)
 ~SVSHold ()
bool Matches (User *u)
 Returns true whether or not the given user is covered by this line.
bool Matches (const std::string &s)
 Returns true whether or not the given string is covered by this line.
void DisplayExpiry ()
 Called when the expiry message is to be displayed for the line.
const char * Displayable ()
 Returns the displayable form of the pattern for this xline, e.g.

Public Attributes

irc::string nickname

Detailed Description

Holds a SVSHold item.

Definition at line 21 of file m_svshold.cpp.


Constructor & Destructor Documentation

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

Definition at line 26 of file m_svshold.cpp.

References nickname.

SVSHold::~SVSHold  )  [inline]
 

Definition at line 31 of file m_svshold.cpp.


Member Function Documentation

const char* SVSHold::Displayable  )  [inline, 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 54 of file m_svshold.cpp.

References nickname.

void SVSHold::DisplayExpiry  )  [inline, 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 49 of file m_svshold.cpp.

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

bool SVSHold::Matches const std::string s  )  [inline, 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 42 of file m_svshold.cpp.

References nickname.

bool SVSHold::Matches User u  )  [inline, 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 35 of file m_svshold.cpp.

References User::nick, and nickname.


Member Data Documentation

irc::string SVSHold::nickname
 

Definition at line 24 of file m_svshold.cpp.

Referenced by Displayable(), Matches(), and SVSHold().


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