CDispatcher Class Reference

CDispatcher. More...

#include <Dispatcher.h>

List of all members.

Public Member Functions
	CDispatcher ()
	CDispatcher.
virtual	~CDispatcher ()
	~CDispatcher
void	SetDispatcherMode (DISPATCHER_MODE mode)
	SetDispatcherMode.
void	AddMailbox (CMailbox *pMailbox)
	AddMailbox.
void	RemoveMailbox (CMailbox *pMailbox)
	RemoveMailbox.
CAccCtrl *	GetNewCtrl ()
	GetNewCtrl.
int	GetCtrlList (CAccCtrl **&)
	GetNewCtrl.
void	Process ()
	Process.
Friends
class	CAccCtrl

---

Detailed Description

CDispatcher.

Description: Receives messages and dispatches them to the appropriate mailbox.

Limitations: NONE

---

Constructor & Destructor Documentation

CDispatcher::CDispatcher (   )

CDispatcher. Description: The CDispatcher class constructor Parameters: isMaster  should be true if this is the master Dispatcher for the game. Limitations: NONE

CDispatcher::~CDispatcher (   )  [virtual]

~CDispatcher Description: The CDispatcher class deconstructor Limitations: Does not delete the actual mailbox objects.

---

Member Function Documentation

void CDispatcher::AddMailbox (  CMailbox *  pMailbox  )

AddMailbox. Description: Adds a mailbox to the Dispatcher. Parameters: pMailbox  is a pointer to the mailbox object to add. These objects WILL NOT be deleted by this class. Returns: void Limitations: NONE

int CDispatcher::GetCtrlList (  CAccCtrl **&  pDest  )

GetNewCtrl. Description: Returns: void Limitations: NONE

CAccCtrl * CDispatcher::GetNewCtrl (   )

GetNewCtrl. Description: Returns: void Limitations: NONE

void CDispatcher::Process (   )

Process. Description: Reads messages out of all the mailbox and forwards them to the correct destination. This function will delete messages that come out of the mailboxes to be dispatched. It will copy messages before it puts them into mailboxes. Returns: void Limitations: NONE

void CDispatcher::RemoveMailbox (  CMailbox *  pMailbox  )

RemoveMailbox. Description: Removes a mailbox from the Dispatcher. Parameters: pMailbox  -- The mailbox is disconnect from the dispatcher. Returns: void Limitations: NONE

void CDispatcher::SetDispatcherMode (  DISPATCHER_MODE  mode  )

SetDispatcherMode. Description: This function sets the mode of the dispatcher. Possible values are defined in the DISPATCHER_MODE enumeration. Returns: mode - the new mode of the dispatcher. Limitations: None

---

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

• Client/Dispatcher.h
• Client/Dispatcher.cpp

---

Copyright (c) 2005 Matt Bruns, Pat Hammond, Kevin Markussen, Travis Service, Brain Shaver