MBTCPMultiMaster.h

/*
 * Copyright (c) 2015 Pavel Vainerman.
 *
 * This program 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, version 2.1.
 *
 * This program 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 Lesser Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
// -----------------------------------------------------------------------------
#ifndef _MBTCPMultiMaster_H_
#define _MBTCPMultiMaster_H_
// -----------------------------------------------------------------------------
#include <ostream>
#include <string>
#include <map>
#include <vector>
#include "MBExchange.h"
#include "modbus/ModbusTCPMaster.h"
// -------------------------------------------------------------------------
namespace uniset
{
// -----------------------------------------------------------------------------
// -----------------------------------------------------------------------------
class MBTCPMultiMaster:
    public MBExchange
{
    public:
        MBTCPMultiMaster( uniset::ObjectId objId, uniset::ObjectId shmID, const std::shared_ptr<SharedMemory>& ic = nullptr,
                          const std::string& prefix = "mbtcp" );
        virtual ~MBTCPMultiMaster();

        static std::shared_ptr<MBTCPMultiMaster> init_mbmaster(int argc, const char* const* argv,
                uniset::ObjectId shmID, const std::shared_ptr<SharedMemory>& ic = nullptr,
                const std::string& prefix = "mbtcp" );

        static void help_print( int argc, const char* const* argv );

        virtual uniset::SimpleInfo* getInfo( const char* userparam = 0 ) override;

    protected:
        virtual void sysCommand( const uniset::SystemMessage* sm ) override;
        virtual void initIterators() override;
        virtual std::shared_ptr<ModbusClient> initMB( bool reopen = false ) override;
        virtual void sigterm( int signo ) override;
        virtual bool deactivateObject() override;
        void initCheckConnectionParameters();

        void poll_thread();
        void check_thread();
        void final_thread();

        uniset::uniset_rwmutex mbMutex;
        bool force_disconnect;
        timeout_t checktime;

    private:
        MBTCPMultiMaster();

        struct MBSlaveInfo
        {
            MBSlaveInfo(): ip(""), port(0), mbtcp(0), priority(0),
                respond(false), respond_id(uniset::DefaultObjectId), respond_invert(false),
                recv_timeout(200), aftersend_pause(0), sleepPause_usec(100),
                force_disconnect(true),
                myname(""), use(false), initOK(false), ignore(false) {}

            std::string ip;
            int port;
            std::shared_ptr<ModbusTCPMaster> mbtcp;
            int priority;

            // параметры для проверки соединения..
            ModbusRTU::SlaveFunctionCode checkFunc = { ModbusRTU::fnUnknown };
            ModbusRTU::ModbusAddr checkAddr = { 0x00 };
            ModbusRTU::ModbusData checkReg = { 0 };

            bool respond;
            uniset::ObjectId respond_id;
            IOController::IOStateList::iterator respond_it;
            bool respond_invert;
            bool respond_init = { false };
            bool respond_force = { false }; // флаг означающий принудительно обновлять значение датчика связи на каждом цикле проверки
            DelayTimer respondDelay;
            timeout_t channel_timeout = { 0 };

            inline bool operator < ( const MBSlaveInfo& mbs ) const noexcept
            {
                return priority < mbs.priority;
            }

            bool init( std::shared_ptr<DebugStream>& mblog );
            bool check();
            void setUse( bool st );

            timeout_t recv_timeout;
            timeout_t aftersend_pause;
            timeout_t sleepPause_usec;
            bool force_disconnect;

            std::string myname;

            bool use = { false }; // флаг используется ли в данный момент этот канал
            bool initOK = { false };
            bool ignore = { false }; // игнорировать данное соединение (обычно флаг выставляется на время ignoreTimeout, если узел не отвечает, хотя связь есть.
            PassiveTimer ptIgnoreTimeout;

            const std::string getShortInfo() const;

            std::mutex mutInit;
        };

        typedef std::list<std::shared_ptr<MBSlaveInfo>> MBGateList;

        MBGateList mblist;
        MBGateList::reverse_iterator mbi;

        // т.к. TCP может "зависнуть" на подключении к недоступному узлу
        // делаем опрос в отдельном потоке
        std::shared_ptr< ThreadCreator<MBTCPMultiMaster> > pollThread; 
        std::shared_ptr< ThreadCreator<MBTCPMultiMaster> > checkThread; 
};
// --------------------------------------------------------------------------
} // end of namespace uniset
// -----------------------------------------------------------------------------
#endif // _MBTCPMultiMaster_H_
// -----------------------------------------------------------------------------