structs.hpp

Go to the documentation of this file.

#ifndef IV_SRC_COMMS_SERIAL_STRUCTS_HPP_
#define IV_SRC_COMMS_SERIAL_STRUCTS_HPP_
 
#include "comms/serial/enums.hpp"
#include "core/defines.hpp"
 
namespace iv::comms::serial
{
 
struct Timeout
{
    static uint32_t max()
    {
        return std::numeric_limits<uint32_t>::max();
    }
 
    static iv::comms::serial::Timeout simpleTimeout(const uint32_t timeout)
    {
        return Timeout(max(), timeout, 0, timeout, 0);
    }
 
    explicit Timeout(const uint32_t _interByteTimeout = 0, const uint32_t _readTimeoutConstant = 0,
                     const uint32_t _readTimeoutMultiplier = 0, const uint32_t _writeTimeoutConstant = 0,
                     const uint32_t _writeTimeoutMultiplier = 0)
        : interByteTimeout(_interByteTimeout), readTimeoutConstant(_readTimeoutConstant),
          readTimeoutMultiplier(_readTimeoutMultiplier), writeTimeoutConstant(_writeTimeoutConstant),
          writeTimeoutMultiplier(_writeTimeoutMultiplier)
    {
    }
 
    /* Number of milliseconds between bytes received to timeout on. */
    uint32_t interByteTimeout;
    /* A constant number of milliseconds to wait after calling read. */
    uint32_t readTimeoutConstant;
    /* A multiplier against the number of requested bytes to wait after calling read.*/
    uint32_t readTimeoutMultiplier;
    /* A constant number of milliseconds to wait after calling write. */
    uint32_t writeTimeoutConstant;
    /* A multiplier against the number of requested bytes to wait after calling write.*/
    uint32_t writeTimeoutMultiplier;
};
 
}// namespace iv::comms::serial
 
#endif//IV_SRC_COMMS_SERIAL_STRUCTS_HPP_