Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

CBan Class Reference

Holds a CBAN item. More...

Inheritance diagram for CBan:

[legend]Collaboration diagram for CBan:

[legend]List of all members.

Public Member Functions
	CBan (InspIRCd *Instance, time_t s_time, long d, const char *src, const char *re, const char *ch)
	~CBan ()
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	matchtext

---

Detailed Description

Holds a CBAN item.

Definition at line 21 of file m_cban.cpp.

---

Constructor & Destructor Documentation

CBan::CBan (  InspIRCd *  Instance, time_t  s_time, long  d, const char *  src, const char *  re, const char *  ch )  [inline]

Definition at line 26 of file m_cban.cpp. References matchtext.

CBan::~CBan (   )  [inline]

Definition at line 31 of file m_cban.cpp.

---

Member Function Documentation

const char* CBan::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 53 of file m_cban.cpp. References matchtext.

void CBan::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 48 of file m_cban.cpp. References XLine::duration, XLine::ServerInstance, InspIRCd::SNO, XLine::source, and SnomaskManager::WriteToSnoMask().

bool CBan::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 41 of file m_cban.cpp. References matchtext.

bool CBan::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 36 of file m_cban.cpp.

---

Member Data Documentation

irc::string CBan::matchtext

Definition at line 24 of file m_cban.cpp. Referenced by CBan(), Displayable(), and Matches().

---

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

• m_cban.cpp