Process.h

Go to the documentation of this file.

/*****************************************************************************
 * vim:tw=78
 * $Id: Process.h,v 1e99c743f804 2018/11/22 15:51:51 lerichi $
 *
 * Copyright (C) 2016       Richard Hacker (lerichi at gmx dot net)
 *
 * This file is part of the PdCom library.
 *
 * The PdCom 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 3 of the License, or (at your
 * option) any later version.
 *
 * The PdCom 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 the PdCom library. If not, see <http://www.gnu.org/licenses/>.
 *
 *****************************************************************************/

#ifndef PDCOM_PROCESS_H
#define PDCOM_PROCESS_H

#include <stddef.h>
#include <string>
#include <list>
#include <stdint.h>

class IOLayer;
class ProtocolHandler;

namespace PdCom {

    struct Subscriber;
    class Variable;

    class Process {
        public:
            Process();

            virtual ~Process();

            std::string name() const;

            std::string version() const;

            void reset();

            virtual std::string applicationName() const;

            virtual std::string hostname() const;

            virtual int read(       char *buf, size_t count) = 0;

            virtual void write(const char *buf, size_t count) = 0;

            virtual void flush() = 0;

            int asyncData();

            virtual void connected() = 0;

            bool list(const std::string& path) const;

            virtual void listReply(
                    std::list<const Variable*>& variables,
                    std::list<std::string>& directories);

            bool find(const std::string& path) const;

            virtual void findReply(const Variable* variable);

            bool login(const char* mech, const char* clientData) const;

            void logout() const;

            virtual void loginReply(const char* mechlist,
                    const char* serverData, int finished);

            bool startTLS() const;

            virtual void startTLSReply();

            void ping() const;

            virtual void pingReply();

            virtual bool alive();

            void subscribe(Subscriber* subscriber,
                    const std::string& path, double interval, int id) const;

            void unsubscribe(Subscriber* subscriber) const;

            void parameterMonitor(Subscriber* subscriber, bool state) const;

            enum LogLevel_t {
                Reset,          
                Emergency,      
                Alert,          
                Critical,       
                Error,          
                Warn,           
                Info,           
                Debug,          
                Trace           
            };

            struct Message {
                uint32_t seqNo;   
                LogLevel_t level; 
                std::string path; 
                int index;        
                uint64_t time_ns; 
                std::string text; 
            };

            virtual void processMessage(const Message& message);

            void getMessage(uint32_t seqNo) const;

            virtual void getMessageReply(const Message& message);

            void activeMessages() const;

            virtual void activeMessagesReply(
                    const std::list<Message>& messageList);

            virtual void protocolLog(
                    LogLevel_t severity,
                    const std::string& message
                    );

            virtual void broadcastReply(const std::string& message,
                    const std::string& attr);

            void broadcast(const std::string& message,
                    const std::string& attr = "text");

            virtual void transmitSemaphore(bool state);

        private:
            ProtocolHandler *protocolHandler;
            IOLayer* const io;

            std::string initialBuffer;
    };
}       // namespace

#endif // PDCOM_PROCESS_H