ConnectionBase.h

Go to the documentation of this file.

/******************************************************************************
*
* Copyright Saab AB, 2007-2013 (http://safir.sourceforge.net)
*
* Created by: Anders Widén / stawi
*
*******************************************************************************
*
* 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_CONNECTION_BASE_H
#define _SAFIR_DOB_CONNECTION_BASE_H

#include <Safir/Dob/Consumer.h>
#include <Safir/Dob/Defs.h>
#include <Safir/Dob/DoseCppExportDefs.h>
#include <Safir/Dob/Entity.h>
#include <Safir/Dob/EntityIterator.h>
#include <Safir/Dob/EntityProxy.h>
#include <Safir/Dob/Message.h>
#include <Safir/Dob/Response.h>
#include <Safir/Dob/Service.h>
#include <Safir/Dob/InstanceIdPolicy.h>
#include <Safir/Dob/Typesystem/ChannelId.h>
#include <Safir/Dob/Typesystem/Defs.h>
#include <Safir/Dob/Typesystem/EntityId.h>

namespace Safir
{
namespace Dob
{
    class DOSE_CPP_API ConnectionBase
    {
    public:

        ConnectionBase();

        virtual ~ConnectionBase();

        virtual bool IsOpen() const = 0;

        void RegisterEntityHandler(const Safir::Dob::Typesystem::TypeId     typeId,
                                   const Dob::Typesystem::HandlerId&        handlerId,
                                   const Dob::InstanceIdPolicy::Enumeration instanceIdPolicy,
                                   Dob::EntityHandler* const                entityHandler) const;

        void RegisterEntityHandlerInjection(const Safir::Dob::Typesystem::TypeId      typeId,
                                            const Dob::Typesystem::HandlerId&         handlerId,
                                            const Dob::InstanceIdPolicy::Enumeration  instanceIdPolicy,
                                            Dob::EntityHandlerInjection* const        entityHandlerInjection) const;
        void RegisterEntityHandlerPending(const Dob::Typesystem::TypeId             typeId,
                                          const Dob::Typesystem::HandlerId&         handlerId,
                                          const Dob::InstanceIdPolicy::Enumeration  instanceIdPolicy,
                                          Dob::EntityHandlerPending* const          entityHandlerPending) const;

        void RegisterServiceHandler(const Safir::Dob::Typesystem::TypeId      typeId,
                                    const Dob::Typesystem::HandlerId&         handlerId,
                                    Dob::ServiceHandler* const                serviceHandler) const;

        void RegisterServiceHandlerPending(const Dob::Typesystem::TypeId             typeId,
                                           const Dob::Typesystem::HandlerId&         handlerId,
                                           Dob::ServiceHandlerPending* const         serviceHandlerPending) const;
        void UnregisterHandler(const Dob::Typesystem::TypeId        typeId,
                               const Dob::Typesystem::HandlerId&    handlerId) const;

        void SubscribeMessage(const Dob::Typesystem::TypeId     typeId,
                              const Dob::Typesystem::ChannelId& channelId,
                              Dob::MessageSubscriber* const     messageSubscriber) const;

        void SubscribeMessage(const Dob::Typesystem::TypeId     typeId,
                              const Dob::Typesystem::ChannelId& channelId,
                              const bool                        includeSubclasses,
                              Dob::MessageSubscriber* const     messageSubscriber) const;

        void UnsubscribeMessage(const Dob::Typesystem::TypeId     typeId,
                                const Dob::Typesystem::ChannelId& channelId,
                                Dob::MessageSubscriber* const     messageSubscriber) const;

        void UnsubscribeMessage(const Dob::Typesystem::TypeId     typeId,
                                const Dob::Typesystem::ChannelId& channelId,
                                const bool                        includeSubclasses,
                                Dob::MessageSubscriber* const     messageSubscriber) const;


        void SubscribeEntity(const Dob::Typesystem::TypeId      typeId,
                             Dob::EntitySubscriber* const       entitySubscriber) const;

        void SubscribeEntity(const Dob::Typesystem::TypeId      typeId,
                             const bool                         includeUpdates,
                             const bool                         includeSubclasses,
                             const bool                         restartSubscription,
                             Dob::EntitySubscriber* const       entitySubscriber) const;

        void SubscribeEntity(const Dob::Typesystem::EntityId&    entityId,
                             const bool                          includeUpdates,
                             const bool                          restartSubscription,
                             Dob::EntitySubscriber* const        entitySubscriber) const;

        void UnsubscribeEntity(const Dob::Typesystem::TypeId        typeId,
                               Dob::EntitySubscriber* const         entitySubscriber) const;

        void UnsubscribeEntity(const Dob::Typesystem::TypeId        typeId,
                               const bool                           includeSubclasses,
                               Dob::EntitySubscriber* const         entitySubscriber) const;

        void UnsubscribeEntity(const Dob::Typesystem::EntityId& entityId,
                               Dob::EntitySubscriber* const     entitySubscriber) const;
        void SubscribeRegistration(const Dob::Typesystem::TypeId            typeId,
                                   const Dob::Typesystem::HandlerId&        handlerId,
                                   const bool                               includeSubclasses,
                                   const bool                               restartSubscription,
                                   Dob::RegistrationSubscriber* const       registrationSubscriber) const;

        void UnsubscribeRegistration(const Dob::Typesystem::TypeId      typeId,
                                     const Dob::Typesystem::HandlerId&  handlerId,
                                     const bool                         includeSubclasses,
                                     Dob::RegistrationSubscriber* const registrationSubscriber) const;
        void Send(const Dob::MessagePtr&            message,
                  const Dob::Typesystem::ChannelId& channelId,
                  Dob::MessageSender* const         messageSender) const;

        Dob::RequestId CreateRequest(const Dob::EntityPtr&               request,
                                     const Dob::Typesystem::HandlerId&   handlerId,
                                     Dob::Requestor* const               requestor) const;

        Dob::RequestId CreateRequest(const Dob::EntityPtr&              request,
                                     const Dob::Typesystem::InstanceId& instanceId,
                                     const Dob::Typesystem::HandlerId&  handlerId,
                                     Dob::Requestor* const              requestor) const;

        Dob::RequestId UpdateRequest(const Dob::EntityPtr&              request,
                                     const Dob::Typesystem::InstanceId& instanceId,
                                     Dob::Requestor* const              requestor) const;

        Dob::RequestId DeleteRequest(const Dob::Typesystem::EntityId& entityId,
                                     Dob::Requestor* const            requestor) const;

        Dob::RequestId ServiceRequest(const Dob::ServicePtr&                  request,
                                      const Dob::Typesystem::HandlerId&       handlerId,
                                      Dob::Requestor* const                   requestor) const;

        void SetChanges(const Dob::EntityPtr&              entity,
                        const Dob::Typesystem::InstanceId& instanceId,
                        const Dob::Typesystem::HandlerId&  handlerId) const;

        void SetAll(const Dob::EntityPtr&              entity,
                    const Dob::Typesystem::InstanceId& instanceId,
                    const Dob::Typesystem::HandlerId&  handlerId) const;

        void Delete(const Dob::Typesystem::EntityId&    entityId,
                    const Dob::Typesystem::HandlerId&   handlerId) const;

        void DeleteAllInstances(const Dob::Typesystem::TypeId       typeId,
                                const Dob::Typesystem::HandlerId&   handlerId) const;

        Dob::EntityIterator GetEntityIterator(const Dob::Typesystem::TypeId  typeId,
                                              const bool                     includeSubclasses) const;

        const Dob::EntityProxy Read(const Dob::Typesystem::EntityId & entityId) const;

        bool IsCreated(const Dob::Typesystem::EntityId & entityId) const;

        Dob::Typesystem::Int64 GetNumberOfInstances(const Dob::Typesystem::TypeId typeId,
                                                    const Dob::Typesystem::HandlerId& handlerId,
                                                    const bool includeSubclasses) const;

        Dob::InstanceIdPolicy::Enumeration GetInstanceIdPolicy(const Dob::Typesystem::TypeId typeId,
                                                               const Dob::Typesystem::HandlerId& handlerId) const;

        void ExitDispatch() const;

    private:
        //Disable copying and assignment
        ConnectionBase(const ConnectionBase& d);
        ConnectionBase& operator=(const ConnectionBase& rhs);

        friend class ConnectionAspectBase;

        virtual long GetControllerId() const = 0;

        void Set(const Dob::EntityPtr&              entity,
                 const Dob::Typesystem::InstanceId& instanceId,
                 const Dob::Typesystem::HandlerId&  handlerId,
                 const bool                         considerChangeFlags) const;
    };

}
}

#endif