RequestEvent Class Reference

#include <RequestListener.h>

Inherits Event.

Inherited by IdPoolListenerFreeIndexRequestEvent, and IdPoolListenerVetoRequestEvent.

Collaboration diagram for RequestEvent:

[legend]

List of all members.

Public Member Functions
	RequestEvent (unsigned srcModuleId, unsigned dstModuleId, std::string eventName)
	RequestEvent ()
virtual	~RequestEvent ()
virtual void	encode (NetMessage *message)
virtual void	decode (NetMessage *message)
virtual void	execute ()
virtual void	setCompleteRequestId (unsigned requestId, unsigned userId)
virtual unsigned	generateResponse ()=0
Protected Member Functions
virtual Event *	createResponseEvent (unsigned response)
Protected Attributes
unsigned	requestId
unsigned	userIdRequest

---

Constructor & Destructor Documentation

RequestEvent::RequestEvent	(	unsigned	srcModuleId,
		unsigned	dstModuleId,
		std::string	eventName
	)

srcModuleId ... module which is raising the request dstModuleId ... module which handles the request (= calls execute on all other connected machines)

RequestEvent::RequestEvent

(

)

RequestEvent::~RequestEvent

(

)

[virtual]

---

Member Function Documentation

Event * RequestEvent::createResponseEvent

(

unsigned

response

)

[protected, virtual]

void RequestEvent::decode

(

NetMessage *

message

)

[virtual]

Reimplemented from Event.

Reimplemented in IdPoolListenerFreeIndexRequestEvent, and IdPoolListenerVetoRequestEvent.

void RequestEvent::encode

(

NetMessage *

message

)

[virtual]

Todo:

should Event::decode() and Event::encode() be protected?

describe Event::decode() and Event::encode()

Reimplemented from Event.

Reimplemented in IdPoolListenerFreeIndexRequestEvent, and IdPoolListenerVetoRequestEvent.

void RequestEvent::execute

(

)

[virtual]

Process the Event.

Todo:

write more precise description

Implements Event.

virtual unsigned RequestEvent::generateResponse

(

)

[pure virtual]

Implemented in IdPoolListenerFreeIndexRequestEvent, and IdPoolListenerVetoRequestEvent.

void RequestEvent::setCompleteRequestId	(	unsigned	requestId,
		unsigned	userId
	)			[virtual]

---

Member Data Documentation

unsigned RequestEvent::requestId [protected]

unsigned RequestEvent::userIdRequest [protected]

---

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

• src/inVRs/SystemCore/RequestListener.h
• src/inVRs/SystemCore/RequestListener.cpp