mip_result.h

Go to the documentation of this file.

#pragma once
 
#include <stdbool.h>
#include <stdint.h>
 
#ifdef __cplusplus
namespace mip {
namespace C {
extern "C" {
#endif // __cplusplus
 
 
 
typedef enum mip_cmd_result
{
    MIP_STATUS_USER_START = -10, 
 
    // Status codes < 0
    MIP_STATUS_ERROR     = -6,  
    MIP_STATUS_CANCELLED = -5,  
    MIP_STATUS_TIMEDOUT  = -4,  
    MIP_STATUS_WAITING   = -3,  
    MIP_STATUS_PENDING   = -2,  
    MIP_STATUS_NONE      = -1,  
 
    // Device replies >= 0
    MIP_ACK_OK                = 0x00,  
    MIP_NACK_COMMAND_UNKNOWN  = 0x01,  
    MIP_NACK_INVALID_CHECKSUM = 0x02,  
    MIP_NACK_INVALID_PARAM    = 0x03,  
    MIP_NACK_COMMAND_FAILED   = 0x04,  
    MIP_NACK_COMMAND_TIMEOUT  = 0x05,  
} mip_cmd_result;
 
const char *mip_cmd_result_to_string(enum mip_cmd_result result);
 
bool mip_cmd_result_is_finished(enum mip_cmd_result result);
 
bool mip_cmd_result_is_reply(enum mip_cmd_result result);
bool mip_cmd_result_is_status(enum mip_cmd_result result);
bool mip_cmd_result_is_user(enum mip_cmd_result result);
 
bool mip_cmd_result_is_ack(enum mip_cmd_result result);
 
 
#ifdef __cplusplus
} // extern "C"
} // namespace C
} // namespace mip
#endif // __cplusplus