DataFlowI.h

Go to the documentation of this file.

/***************************************************************************
  tag: FMTC  do nov 2 13:06:20 CET 2006  DataFlowI.h

                        DataFlowI.h -  description
                           -------------------
    begin                : do november 02 2006
    copyright            : (C) 2006 FMTC
    email                : peter.soetens@fmtc.be

 ***************************************************************************
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU General Public                   *
 *   License as published by the Free Software Foundation;                 *
 *   version 2 of the License.                                             *
 *                                                                         *
 *   As a special exception, you may use this file as part of a free       *
 *   software library without restriction.  Specifically, if other files   *
 *   instantiate templates or use macros or inline functions from this     *
 *   file, or you compile this file and link it with other files to        *
 *   produce an executable, this file does not by itself cause the         *
 *   resulting executable to be covered by the GNU General Public          *
 *   License.  This exception does not however invalidate any other        *
 *   reasons why the executable file might be covered by the GNU General   *
 *   Public License.                                                       *
 *                                                                         *
 *   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 General Public             *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 59 Temple Place,                                    *
 *   Suite 330, Boston, MA  02111-1307  USA                                *
 *                                                                         *
 ***************************************************************************/

#ifndef DATAFLOWI_H_
#define DATAFLOWI_H_

#include "corba.h"
#ifdef CORBA_IS_TAO
#include "DataFlowS.h"
#else
#include "DataFlowC.h"
#endif
#include "CorbaConversion.hpp"
#include "../../base/ChannelElement.hpp"
#include "../../internal/DataSources.hpp"
#include "CorbaTypeTransporter.hpp"
#include <list>
#include <rtt/os/Mutex.hpp>

#if !defined (ACE_LACKS_PRAGMA_ONCE)
#pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */


namespace RTT {

    namespace corba {
        class CDataFlowInterface_i;

        class RTT_CORBA_API CRemoteChannelElement_i
            : public POA_RTT::corba::CRemoteChannelElement
            , public virtual PortableServer::RefCountServantBase
        {
        protected:
            CRemoteChannelElement_var remote_side;
            RTT::corba::CorbaTypeTransporter const& transport;
            PortableServer::POA_var mpoa;
            CDataFlowInterface_i* mdataflow;

        public:
            // standard constructor
            CRemoteChannelElement_i(corba::CorbaTypeTransporter const& transport,
              PortableServer::POA_ptr poa);
            virtual ~CRemoteChannelElement_i();

            virtual RTT::corba::CRemoteChannelElement_ptr activate_this() {
                PortableServer::ObjectId_var oid = mpoa->activate_object(this); // ref count=2
                _remove_ref(); // ref count=1
                return _this();
            }

            virtual void transferSamples() = 0;

            void setCDataFlowInterface(CDataFlowInterface_i* dataflow) {
                mdataflow = dataflow;
            }

            PortableServer::POA_ptr _default_POA();

            void setRemoteSide(CRemoteChannelElement_ptr remote) ACE_THROW_SPEC ((
                  CORBA::SystemException
                ));
        };

        class RTT_CORBA_API CDataFlowInterface_i
            : public virtual POA_RTT::corba::CDataFlowInterface
        {
            DataFlowInterface* mdf;
            PortableServer::POA_var mpoa;

            struct ServantInfo
            {
                RTT::corba::CDataFlowInterface_var objref;
                RTT::corba::CDataFlowInterface_i* servant;
                DataFlowInterface* getDataFlowInterface() const { return servant->getDataFlowInterface(); }
                ServantInfo(CDataFlowInterface_var objref, CDataFlowInterface_i* servant)
                    : objref(objref), servant(servant) {}
            };
            typedef std::list<ServantInfo> ServantMap;
            static ServantMap s_servant_map;

            typedef std::list<
                std::pair<RTT::corba::CChannelElement_var, base::ChannelElementBase::shared_ptr>
                > ChannelList;
            ChannelList channel_list;
            // Lock that should be taken before access to channel_list
            RTT::os::Mutex channel_list_mtx;
        public:
            // standard constructor
            CDataFlowInterface_i(DataFlowInterface* interface, PortableServer::POA_ptr poa);
            virtual ~CDataFlowInterface_i();

            DataFlowInterface* getDataFlowInterface() const;

            static void registerServant(CDataFlowInterface_ptr objref, CDataFlowInterface_i* servant);
            static void deregisterServant(DataFlowInterface* obj);
            static void clearServants();
            static DataFlowInterface* getLocalInterface(CDataFlowInterface_ptr objref);

            void deregisterChannel(CChannelElement_ptr channel);

            static CDataFlowInterface_ptr getRemoteInterface(DataFlowInterface* dfi, PortableServer::POA_ptr poa);

            virtual RTT::corba::CDataFlowInterface_ptr activate_this() {
                 PortableServer::ObjectId_var oid = mpoa->activate_object(this); // ref count=2
                 //_remove_ref(); // ref count=1
                 return _this();
             }

            PortableServer::POA_ptr _default_POA();

            // methods corresponding to defined IDL attributes and operations
            RTT::corba::CDataFlowInterface::CPortNames* getPorts() ACE_THROW_SPEC ((
                      CORBA::SystemException
                    ));
            RTT::corba::CDataFlowInterface::CPortDescriptions* getPortDescriptions() ACE_THROW_SPEC ((
                      CORBA::SystemException
                    ));
            RTT::corba::CPortType getPortType(const char* port_name) ACE_THROW_SPEC ((
                  CORBA::SystemException
                  ,::RTT::corba::CNoSuchPortException
                ));
            char* getDataType(const char* port_name) ACE_THROW_SPEC ((
                      CORBA::SystemException
                      ,::RTT::corba::CNoSuchPortException
                    ));
            ::CORBA::Boolean isConnected(const char* port_name) ACE_THROW_SPEC ((
                      CORBA::SystemException
                      ,::RTT::corba::CNoSuchPortException
                    ));
            ::CORBA::Boolean channelReady(const char* port_name, RTT::corba::CChannelElement_ptr channel, RTT::corba::CConnPolicy const& policy) ACE_THROW_SPEC ((
                      CORBA::SystemException
                      ,::RTT::corba::CNoSuchPortException
                    ));
            void disconnectPort(const char* port_name) ACE_THROW_SPEC ((
                      CORBA::SystemException
                      ,::RTT::corba::CNoSuchPortException
                    ));

            CChannelElement_ptr buildChannelOutput(const char* reader_port, RTT::corba::CConnPolicy& policy) ACE_THROW_SPEC ((
                      CORBA::SystemException
                      ,::RTT::corba::CNoCorbaTransport
                      ,::RTT::corba::CNoSuchPortException
                    ));
            CChannelElement_ptr buildChannelInput(const char* writer_port, RTT::corba::CConnPolicy& policy) ACE_THROW_SPEC ((
                  CORBA::SystemException
                  ,::RTT::corba::CNoCorbaTransport
                  ,::RTT::corba::CNoSuchPortException
                ));

            ::CORBA::Boolean createConnection( const char* writer_port,
                                               CDataFlowInterface_ptr reader_interface,
                                               const char* reader_port,
                                               RTT::corba::CConnPolicy & policy) ACE_THROW_SPEC ((
                                                      CORBA::SystemException
                                                      ,::RTT::corba::CNoSuchPortException
                                                    ));
            bool removeConnection( const char* writer_port,
                                               CDataFlowInterface_ptr reader_interface,
                                               const char* reader_port) ACE_THROW_SPEC ((
                                                      CORBA::SystemException
                                                      ,::RTT::corba::CNoSuchPortException
                                                    ));

            ::CORBA::Boolean createStream( const char* port,
                                           RTT::corba::CConnPolicy & policy) ACE_THROW_SPEC ((
                                                  CORBA::SystemException
                                                  ,::RTT::corba::CNoSuchPortException
                                                ));
            void removeStream( const char* port, const char* stream_name) ACE_THROW_SPEC ((
                  CORBA::SystemException
                  ,::RTT::corba::CNoSuchPortException
                ));
        };
    }
}


#endif /* DATAFLOWI_H_  */