mipcomponent.h

Go to the documentation of this file.

/*
    
  This file is a part of EMIPLIB, the EDM Media over IP Library.
  
  Copyright (C) 2006-2011  Hasselt University - Expertise Centre for
                      Digital Media (EDM) (http://www.edm.uhasselt.be)

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  
  USA

*/

#ifndef MIPCOMPONENT_H

#define MIPCOMPONENT_H

#include "mipconfig.h"
#include "miperrorbase.h"
#include "miptypes.h"
#include <jthread/jmutex.h>
#include <string>

class MIPComponentChain;
class MIPMessage;
class MIPFeedback;

class EMIPLIB_IMPORTEXPORT MIPComponent : public MIPErrorBase
{
protected:
        MIPComponent(const std::string &componentName);
public:
        virtual ~MIPComponent();

        virtual void lock()                                                                             { m_componentMutex.Lock(); }

        virtual void unlock()                                                                           { m_componentMutex.Unlock(); }

        virtual bool push(const MIPComponentChain &chain, int64_t iteration, MIPMessage *pMsg) = 0;

        virtual bool pull(const MIPComponentChain &chain, int64_t iteration, MIPMessage **pMsg) = 0;

        virtual bool processFeedback(const MIPComponentChain &chain, int64_t feedbackChainID, MIPFeedback *feedback)                    
                                                                                                        { return true; }
        std::string getComponentName() const                                                            { return m_componentName; }

        // TODO: is it necessary to explain this in the documentation? Most likely only useful in the
        //       MIPComponentAlias component
        virtual const MIPComponent *getComponentPointer() const                                         { return this; }
private:
        jthread::JMutex m_componentMutex;
        std::string m_componentName;
};

#endif // MIPCOMPONENT_H