BaseBufferedRemoteTransport.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 https://www.thecoderscorner.com (Dave Cherry).
 * This product is licensed under an Apache license, see the LICENSE file in the top-level directory.
 */
 
#ifndef TCMENU_BASEBUFFEREDREMOTETRANSPORT_H
#define TCMENU_BASEBUFFEREDREMOTETRANSPORT_H
 
#include <RemoteConnector.h>
#define TICKS_TO_FLUSH_WRITE 140
 
namespace tcremote {
 
    enum BufferingMode : uint8_t {
        BUFFER_ONE_MESSAGE, BUFFER_MESSAGES_TILL_FULL
    };
 
    class EncryptionHandler {
    public:
        virtual int encryptData(const uint8_t *plainText, int bytesIn, const uint8_t *buffer, size_t buffLen) = 0;
        virtual int decryptData(const uint8_t *encoded, int bytesIn, const uint8_t *buffer, size_t buffLen) = 0;
    };
 
 
    class BaseBufferedRemoteTransport : public TagValueTransport {
    protected:
        const uint16_t writeBufferSize;
        const uint16_t readBufferSize;
        uint8_t *readBuffer;
        uint8_t *writeBuffer;
        uint8_t *encryptionBuffer;
        uint16_t writeBufferPos;
        uint16_t readBufferPos;
        uint16_t encryptionBufferPos;
        uint16_t readBufferAvail;
        EncryptionHandler* encryptionHandler;
        BufferingMode mode;
        uint8_t ticksSinceWrite;
    public:
        BaseBufferedRemoteTransport(BufferingMode bufferMode, uint8_t readBufferSize, uint8_t writeBufferSize,
                                    EncryptionHandler* encHandler = nullptr);
 
        ~BaseBufferedRemoteTransport() override;
 
        void endMsg() override;
 
        int writeChar(char data) override;
 
        int writeStr(const char *data) override;
 
        uint8_t readByte() override;
 
        bool readAvailable() override;
 
        void close() override;
 
        void flushIfRequired();
 
        void flushInternal();
 
        virtual int fillReadBuffer(uint8_t *dataBuffer, int maxSize) = 0;
    };
}
 
#endif //TCMENU_BASEBUFFEREDREMOTETRANSPORT_H