Platform/Aperios1.3.2/SharedReceiver.h

Go to the documentation of this file.

/**
 * @file Platform/Aperios1.3.2/SharedReceiver.h
 * This file contains a class for a receiver using shared memory.
 * @author Thomas Röfer
 */
#ifndef __SHAREDRECEIVER_H__
#define __SHAREDRECEIVER_H__

#include "Tools/Streams/InStreams.h"
#include "Platform/GTAssert.h"

/**
 * The class implements a receiver.
 * A receiver is an object that reads packages from an Aperios queue.
 */
template<class T> class SharedReceiver : public Receiver<T>
{
  protected:
    T* data;

    /**
     * The function is called when a new package arrived.
     * @param msg An Open-R message that contains the package.
     */    
    virtual void handleMessage(ONotifyMessage& msg)
    {
      ONotifyEvent event;
      event.SetIndex(eventId);
      NotifyHandler(msg,&event);
      data = (T*) event.RCData(0)->Base();
      setEventId(eventId);
    }

  public:
    /**
     * The constructor.
     * @param process The process this receiver is associated with.
     * @param receiverName The Aperios connection name of the receiver without the process name.
     * @param blocking Decides whether this receiver blocks the execution of the next frame
     *                 until it has received a package.
     */
    SharedReceiver(PlatformProcess* process,const char* receiverName,bool blocking)
    : Receiver<T>(process,receiverName,blocking),
      data(0)
    {
    }

    /**
     * The function returns a reference to the shared object.
     * @return A reference to the shared object.
     */
    T& getShared() {return *data;}

   /**
     * The function returns a constant reference to the shared object.
     * @return A constant reference to the shared object.
     */
    const T& getShared() const {return *data;}
};

/**
 * The macro declares a shared received.
 * It must be used inside a declaration of a process, after the macro DEBUGGING.
 * @param type The type of the package. The variable actually declared has
 *             a type compatible to "type" and is called "thetypeSender".
 */
#define SHARED_RECEIVER(type) \
  SharedReceiver<type> the##type##Receiver

#endif

---