CEL

Public API Reference

iMessageReceiver Struct Reference

Implement this interface if you are interested in receiving messages. More...

#include <physicallayer/messaging.h>

Inheritance diagram for iMessageReceiver:

List of all members.

Public Member Functions

virtual bool ReceiveMessage (csStringID msg_id, iMessageSender *sender, celData &ret, iCelParameterBlock *params)=0
 Receive a message for a specific message id.


Detailed Description

Implement this interface if you are interested in receiving messages.

Definition at line 109 of file messaging.h.


Member Function Documentation

virtual bool iMessageReceiver::ReceiveMessage ( csStringID  msg_id,
iMessageSender sender,
celData ret,
iCelParameterBlock params 
) [pure virtual]

Receive a message for a specific message id.

Parameters:
msg_id this is the message ID representing the message.
sender is an optional sender. If the sender doesn't want to be identified this field can be 0.
ret gives the possibility to return information to the sender of this message.
params contains the parameters for this message.
Returns:
false if this message was not handled or recognized by this receiver. Otherwise true.


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

Generated for CEL: Crystal Entity Layer 1.4.0 by doxygen 1.5.8