CEL

Public API Reference

iMessageDispatcher Struct Reference

This is a message dispatcher. More...

#include <physicallayer/messaging.h>

Inheritance diagram for iMessageDispatcher:

List of all members.

Public Member Functions

virtual bool SendMessage (iCelParameterBlock *params, iCelDataArray *ret=0)=0
 Send a message for a specific message id.

Detailed Description

This is a message dispatcher.

If you want to send messages you create an instance of this interface through the message channel. Then you use that instance to send messages to all interested parties.

Definition at line 163 of file messaging.h.


Member Function Documentation

virtual bool iMessageDispatcher::SendMessage ( iCelParameterBlock params,
iCelDataArray *  ret = 0 
) [pure virtual]

Send a message for a specific message id.

Parameters:
params contains the parameters for this message.
ret if this is not 0 then it can be used to collect information from the receivers. If 0 then information from the receivers is simply ignored.
Returns:
false if this message was not handled or recognized by any message receiver. If it was handled by at least one receiver then this will return true.

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

Generated for CEL: Crystal Entity Layer 2.0 by doxygen 1.6.1