Messenger.h

Go to the documentation of this file.

//
//------------------------------------------------------------------------
//
// File   : Messenger.h
// Author : Patrick McCormick (pat@acl.lanl.gov)
// 
// $Date: 2003/08/01 22:10:47 $
// $Revision: 1.4 $
//
// This class handles the overall messaging with active message support
// (known as callbacks in this case).  This class works well in situations
// where there are master-slave situations in which the slaves wait to 
// receive a message from a master as to what task to perform.  The client
// code should use a series of calls to AddCallback() to install handlers 
// (callbacks) for messages of interest. 
// 
// TODO: All the methods in this code are extremely short -- perhaps we 
//       should consider making everything inline?  Will it really make
//       that much difference. 
//
//------------------------------------------------------------------------
//
#ifndef KOKO_MESSENGER_H_
#define KOKO_MESSENGER_H_

#include "koko.h"

#include "CallbackMap.h"
#include "KokoBuffer.h"

class Communicator;

class Messenger 
{
  public:

    Messenger(Communicator *comm, unsigned int rbufsize);
    ~Messenger(void);

    ///========================================================================
    /// Callback installation. 
    inline bool AddCallback(KokoTag tag, 
                               void (*funcp)(KokoBuffer &databuf))
    {
      Function *func = new Function(funcp);
      return(_cbmap.Add(tag, func));
    };

    template <class Type>
    bool AddCallback(KokoTag tag, Type &obj, 
                        void (Type::* meth)(KokoBuffer &databuf))
    {
      Method<Type> *methp = new Method<Type>(&obj, meth);
      return(_cbmap.Add(tag, methp));
    };
         
    template <class Type>
    bool AddCallback(KokoTag tag, Type *obj, 
                        void (Type::* meth)(KokoBuffer &databuf))
    {
      Method<Type> *methp = new Method<Type>(obj, meth);
      return (_cbmap.Add(tag, methp));
    };

    // Callback removal.
    inline bool RemoveCallback(KokoTag id)
    {
      return _cbmap.Remove(id);
    };

    ///=======================================================================
    /// Internal message buffer management.
    inline unsigned int BufferSize(void)
    { return _kbuf.TotalSize(); };

    inline void ResizeBuffer(unsigned int new_size)
    { _kbuf.Resize(new_size); };


    ///=======================================================================
    /// Message handling...

    void WaitForMessage(void);

    void WaitForBroadcast(void);

  private:
    Communicator     *_com;    // The communicator object for all our messages.
    CallbackMap       _cbmap;  // The callback map -- maps KokoTag into the 
                               //   actual callback.
    KokoBuffer        _kbuf;   // The message buffer.  
};

#endif

---

Send questions, comments, and bug reports to: