CullItem Class Reference

The CullItem class holds a user and their quitmessage, and is used internally by the CullList class to compile a list of users which are to be culled when a long operation (such as a netsplit) has completed. More...

#include <cull_list.h>

Collaboration diagram for CullItem:

[legend]List of all members.

Public Member Functions
	CullItem (userrec *u, std::string r)
	Constrcutor.
userrec *	GetUser ()
	Returns a pointer to the user.
std::string	GetReason ()
	Returns the user's quit reason.
Private Attributes
userrec *	user
	Holds a pointer to the user, must be valid and can be a local or remote user.
std::string	reason
	Holds the quit reason to use for this user.

---

Detailed Description

The CullItem class holds a user and their quitmessage, and is used internally by the CullList class to compile a list of users which are to be culled when a long operation (such as a netsplit) has completed.

Definition at line 36 of file cull_list.h.

---

Constructor & Destructor Documentation

CullItem::CullItem (  userrec *  u, std::string  r )

Constrcutor. Initializes the CullItem with a user pointer and their quit reason Parameters: u  The user to add r  The quit reason of the added user

---

Member Function Documentation

std::string CullItem::GetReason (   )

Returns the user's quit reason.

userrec* CullItem::GetUser (   )

Returns a pointer to the user.

---

Member Data Documentation

std::string CullItem::reason [private]

Holds the quit reason to use for this user. Definition at line 45 of file cull_list.h.

userrec* CullItem::user [private]

Holds a pointer to the user, must be valid and can be a local or remote user. Definition at line 42 of file cull_list.h.

---

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

• cull_list.h

---