physicallayer/messaging.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2008 by Jorrit Tyberghein
  
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
  
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
  
    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/

#ifndef __CEL_PL_MESSAGING
#define __CEL_PL_MESSAGING

#include "cstypes.h"
#include "csutil/scf.h"
#include "csutil/set.h"
#include "csutil/scfarray.h"
#include "iutil/strset.h"
#include "physicallayer/datatype.h"

struct iCelParameterBlock;
struct iMessageDispatcher;
struct iMessageReceiver;
struct iMessageReceiverFilter;
struct iMessageSender;

struct iMessageChannel : public virtual iBase
{
  SCF_INTERFACE (iMessageChannel, 0, 0, 1);

  virtual csRef<iMessageDispatcher> CreateMessageDispatcher (
      iMessageSender* sender, const char* msg_id,
      iMessageReceiverFilter* receiver_filter = 0) = 0;

  virtual void RemoveMessageDispatcher (iMessageDispatcher* msgdest) = 0; 

  virtual void Subscribe (iMessageReceiver* receiver, const char* mask) = 0;

  virtual void Unsubscribe (iMessageReceiver* receiver,
    const char* mask = 0) = 0;

  virtual bool SendMessage (const char* msgid,
      iMessageSender* sender, iCelParameterBlock* params,
      iCelDataArray* ret = 0) = 0;
};

struct iMessageReceiver : public virtual iBase
{
  SCF_INTERFACE (iMessageReceiver, 0, 0, 1);

  virtual bool ReceiveMessage (csStringID msg_id, iMessageSender* sender,
      celData& ret, iCelParameterBlock* params) = 0;
};

struct iMessageSender : public virtual iBase
{
  SCF_INTERFACE (iMessageSender, 0, 0, 1);

  virtual void MessageDispatcherRemoved (
      iMessageDispatcher* dispatcher) = 0;
};

struct iMessageReceiverFilter : public virtual iBase
{
  SCF_INTERFACE (iMessageReceiverFilter, 0, 0, 1);

  virtual bool IsValidReceiver (iMessageReceiver* receiver) = 0;
};

struct iMessageDispatcher : public virtual iBase
{
  SCF_INTERFACE (iMessageDispatcher, 0, 0, 1);

  virtual bool SendMessage (iCelParameterBlock* params,
      iCelDataArray* ret = 0) = 0;
};


#endif // __CEL_PL_MESSAGING