Platform/Aperios1.3.2/SharedSender.h

Go to the documentation of this file.

/**
 * @file Platform/Aperios1.3.2/SharedSender.h
 * This file contains a sender for sound data.
 */
#ifndef __SHAREDSENDER_H__
#define __SHAREDSENDER_H__

#ifndef __ProcessFramework_h__
#error Never include this file directly. Include ProcessFramework.h instead.
#endif

#include "Platform/ProcessFramework.h"

/**
 * This class implements a sender for sound data.
 */
template<class T> class SharedSender : public SenderBase<T>
{
  private:
    RCRegion* package; /**< The shared memory. */

  protected:
    /**
    * No preparation.
    */
    void preparePackage() {}

    /**
     * The functions sets a package for a receiver.
     * @param receiver The receive the package will be sent to.
     */
    void setPackage(const ObserverID& receiver)
    {
      if(package->NumberOfReference() == 1)
        VERIFY(SetData(receiver,package) == oSUCCESS);
    }

    /**
     * The function does not free the package.
     * It is only freed in the destructor.
     */
    void freePackage() {}

  public:
    /**
     * The constructor.
     * @param process The process this sender is associated with.
     * @param senderName The Aperios connection name of the sender without the process name.
     * @param blocking Decides whether this sender blocks the execution of the next frame
     *                 until all connected receivers have requested a new package.
     */
    SharedSender(PlatformProcess* process,const char* senderName,bool blocking)
    : SenderBase<T>(process,senderName,blocking)
    {
      package = new RCRegion(sizeof(T));
      getShared() = T();
    }

    /**
     * Destructor.
     */
    ~SharedSender()
    {
      package->RemoveReference();
    }

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

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

/**
 * The macro declares a shared sender.
 * 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_SENDER(type) \
  SharedSender<type> the##type##Sender

#endif

---