Consumer.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright Saab AB, 2006-2013 (http://safirsdkcore.com)
*
* Created by: Joel Ottosson / stjoot
*
*******************************************************************************
*
* This file is part of Safir SDK Core.
*
* Safir SDK Core is free software: you can redistribute it and/or modify
* it under the terms of version 3 of the GNU General Public License as
* published by the Free Software Foundation.
*
* Safir SDK Core 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Safir SDK Core.  If not, see <http://www.gnu.org/licenses/>.
*
******************************************************************************/
 
#ifndef _SAFIR_DOB_CONSUMER_H
#define _SAFIR_DOB_CONSUMER_H
 
#include <Safir/Dob/ConsumerBase.h>
#include <Safir/Dob/Defs.h>
#include <Safir/Dob/DoseCppExportDefs.h>
#include <Safir/Dob/Entity.h>
#include <Safir/Dob/EntityProxy.h>
#include <Safir/Dob/EntityRequestProxy.h>
#include <Safir/Dob/Message.h>
#include <Safir/Dob/MessageProxy.h>
#include <Safir/Dob/Response.h>
#include <Safir/Dob/ResponseProxy.h>
#include <Safir/Dob/ResponseSender.h>
#include <Safir/Dob/Service.h>
#include <Safir/Dob/ServiceRequestProxy.h>
#include <Safir/Dob/Typesystem/Defs.h>
#include <Safir/Dob/Typesystem/EntityId.h>
#include <Safir/Dob/Typesystem/HandlerId.h>
 
namespace Safir
{
namespace Dob
{
 
    class DOSE_CPP_API StopHandler:
        public virtual Internal::ConsumerBase
    {
    public:
        virtual ~StopHandler() {}
 
        virtual void OnStopOrder() = 0;
 
    private:
        StopHandler * ToStopHandler() override {return this;}
    };
 
    class DOSE_CPP_API Dispatcher:
        public virtual Internal::ConsumerBase
    {
    public:
        virtual ~Dispatcher() {}
 
        virtual void OnDoDispatch() = 0;
 
    private:
        Dispatcher * ToDispatcher() override {return this;}
    };
 
    class DOSE_CPP_API EntityHandler
        : public virtual RevokedRegistrationBase,
          public virtual EntityRequestBase
    {
 
    private:
        EntityHandler * ToEntityHandler() override {return this;}
    };
 
    class DOSE_CPP_API EntityHandlerInjection
        : public virtual RevokedRegistrationBase,
          public virtual EntityInjectionBase
    {
 
    private:
        EntityHandlerInjection * ToEntityHandlerInjection() override {return this;}
    };
 
    class DOSE_CPP_API EntityHandlerPending
        : public virtual CompletedRegistrationBase,
          public virtual EntityInjectionBase
    {
 
    private:
        EntityHandlerPending * ToEntityHandlerPending() override {return this;}
    };
 
    class DOSE_CPP_API ServiceHandler
        : public virtual RevokedRegistrationBase,
          public virtual ServiceRequestBase
    {
 
    private:
        ServiceHandler * ToServiceHandler() override {return this;}
    };
 
    class DOSE_CPP_API ServiceHandlerPending
        : public virtual CompletedRegistrationBase,
          public virtual ServiceRequestBase
    {
 
    private:
        ServiceHandlerPending * ToServiceHandlerPending() override {return this;}
    };
 
    class DOSE_CPP_API Requestor:
        public virtual Internal::ConsumerBase
    {
    public:
        virtual ~Requestor() {}
 
        virtual void OnResponse(const Safir::Dob::ResponseProxy responseProxy) = 0;
 
        virtual void OnNotRequestOverflow() = 0;
 
    private:
        Requestor * ToRequestor() override {return this;}
    };
 
    class DOSE_CPP_API MessageSender:
        public virtual Internal::ConsumerBase
    {
    public:
        virtual ~MessageSender() {}
 
        virtual void OnNotMessageOverflow() = 0;
 
    private:
        MessageSender * ToMessageSender() override {return this;}
    };
 
    class DOSE_CPP_API RegistrationSubscriber:
        public virtual Internal::ConsumerBase
    {
    public:
        virtual ~RegistrationSubscriber() {}
 
        virtual void OnRegistered(const Safir::Dob::Typesystem::TypeId      typeId,
                                  const Safir::Dob::Typesystem::HandlerId&  handlerId) = 0;
 
        virtual void OnUnregistered(const Safir::Dob::Typesystem::TypeId      typeId,
                                    const Safir::Dob::Typesystem::HandlerId&  handlerId) = 0;
 
    private:
        RegistrationSubscriber * ToRegistrationSubscriber() override {return this;}
    };
 
    class DOSE_CPP_API MessageSubscriber:
        public virtual Internal::ConsumerBase
    {
    public:
        virtual ~MessageSubscriber() {}
 
        virtual void OnMessage(const Safir::Dob::MessageProxy messageProxy) = 0;
 
    private:
        MessageSubscriber * ToMessageSubscriber() override {return this;}
    };
 
    class DOSE_CPP_API EntitySubscriber:
        public virtual Internal::ConsumerBase
    {
    public:
        virtual ~EntitySubscriber() {}
 
        virtual void OnNewEntity(const Safir::Dob::EntityProxy entityProxy) = 0;
 
        virtual void OnUpdatedEntity(const Safir::Dob::EntityProxy entityProxy) = 0;
 
        virtual void OnDeletedEntity(const Safir::Dob::EntityProxy entityProxy,
                                     const bool                    deprecated) = 0;
 
    private:
        EntitySubscriber * ToEntitySubscriber() override {return this;}
    };
 
}
}
 
 
#endif