status.hpp File Reference

#include <cstdint>

Go to the source code of this file.

Classes
struct	mcprotocol::serial::Status
	Result object returned by most public APIs. More...

Namespaces
namespace	mcprotocol
namespace	mcprotocol::serial

Enumerations
enum class	mcprotocol::serial::StatusCode : std::uint8_t {   mcprotocol::serial::Ok = 0 , mcprotocol::serial::InvalidArgument , mcprotocol::serial::Busy , mcprotocol::serial::Timeout ,   mcprotocol::serial::Transport , mcprotocol::serial::Framing , mcprotocol::serial::SumCheckMismatch , mcprotocol::serial::Parse ,   mcprotocol::serial::UnsupportedConfiguration , mcprotocol::serial::PlcError , mcprotocol::serial::BufferTooSmall , mcprotocol::serial::Cancelled }
	Library-level status code returned by encode, decode, transport, and client operations. More...

Functions
constexpr Status	mcprotocol::serial::ok_status () noexcept
	Returns the default success status.
constexpr Status	mcprotocol::serial::make_status (StatusCode code, const char *message, std::uint16_t plc_error_code=0) noexcept
	Builds a status value with an optional PLC end code.