include/vrfExtObjects/radioMessageReceivedHandler.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2012 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

#include <vrfExtObjects/vrfExtObjectsDefines.h>
#include <vrfExtProtocol/ifRadioMessageReceived.h>
#include <vl/exerciseConn.h>
#include <vl/dataInter.h>
#include <vector>

typedef void (*DtRadioMessageReceivedHandlerCallback) (DtIfRadioMessageReceived msg, void* usr);

class DT_DLL_vrfExtObjects DtRadioMessageReceivedHandler
{
public:
   // Default constructor does not fully initialize itself. Must call initialize() to complete
   // the initialization process.
   DtRadioMessageReceivedHandler();

   // Default destructor does remove all callbacks upon destruction so there is no need to
   // explicitly remove a callback.
   virtual ~DtRadioMessageReceivedHandler();

   // Initializes the instance. Will do nothing if already initialized. Thus you can't
   // replace the exercise connection this is using. Auto-registers for this message type
   // once it is initialized. This message type being one of DtIfRadioMessageReceived.
   virtual void initialize(DtExerciseConn* exConn);

   // Adds a callback function to the list of callbacks. Your function and class are passed
   // in as the two arguments (respectively) and will get invoked when a message of this
   // specific type comes in on the network.
   virtual void addCallback(DtRadioMessageReceivedHandlerCallback cBackFunc, void* usr);

   // Removes a callback function from the list of callbacks. Your function and class 
   // that you passed in to add the callback can be used to remove it from the list.
   // An explicit removal is not required upon termination of the program as it will
   // clean itself up when this gets destroyed.
   virtual void removeCallback(DtRadioMessageReceivedHandlerCallback cBackFunc, void* usr);

   // Publishes a DtIfRadioMessageReceived message to the network. Since this class handles
   // receiving messages of this type, it also handles sending them. This makes it easy to
   // send and receive messages of this type.
   virtual bool publishRadioMessageReceivedMessage(DtIfRadioMessageReceived msg);

protected:
   // Callback function registered to receive data interactions on the network
   static void dataInteractionCallbackFunction(DtDataInteraction* interaction, void* usr);

   // Where the data interaction is processed
   virtual void processDataInteraction(DtDataInteraction* interaction);

   // Where the callback functions registered to this class are called.
   virtual void invokeCallbacks(DtIfRadioMessageReceived msg);

   DtExerciseConn* myExerciseConnection;
   std::vector<std::pair<void*, DtRadioMessageReceivedHandlerCallback> > myCallbacks;
};