error_cc.h File Reference

Error definition and functions. More...

#include "mip_cc/result_cc.h"

Include dependency graph for error_cc.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	mip_cc_error
	Error information. More...

Macros
#define	ERROR_STRING_BUFFER_SIZE   1024

Enumerations
enum	mip_cc_network_error_category {   MIP_NETWORK_ERROR_CATEGORY_UNKNOWN ,   MIP_NETWORK_ERROR_CATEGORY_FAILURE_RESPONSE_CODE ,   MIP_NETWORK_ERROR_CATEGORY_BAD_RESPONSE ,   MIP_NETWORK_ERROR_CATEGORY_UNEXPECTED_RESPONSE ,   MIP_NETWORK_ERROR_CATEGORY_NO_CONNECTION ,   MIP_NETWORK_ERROR_CATEGORY_PROXY ,   MIP_NETWORK_ERROR_CATEGORY_SSL ,   MIP_NETWORK_ERROR_CATEGORY_TIMEOUT ,   MIP_NETWORK_ERROR_CATEGORY_OFFLINE ,   MIP_NETWORK_ERROR_CATEGORY_THROTTLED ,   MIP_NETWORK_ERROR_CATEGORY_CANCELLED ,   MIP_NETWORK_ERROR_CATEGORY_FUNCTION_NOT_IMPLEMENTED ,   MIP_NETWORK_ERROR_CATEGORY_SERVICE_UNAVAILABLE }
enum	mip_cc_no_permissions_error_category {   MIP_NO_PERMISSIONS_ERROR_UNKNOWN ,   MIP_NO_PERMISSIONS_ERROR_USER_NOT_FOUND ,   MIP_NO_PERMISSIONS_ERROR_ACCESS_DENIED ,   MIP_NO_PERMISSIONS_ERROR_ACCESS_EXPIRED ,   MIP_NO_PERMISSIONS_ERROR_INVALID_EMAIL ,   MIP_NO_PERMISSIONS_ERROR_UNKNOWN_TENANT ,   MIP_NO_PERMISSIONS_ERROR_NOT_OWNER ,   MIP_NO_PERMISSIONS_ERROR_NOT_PREMIUM_LICENSE_USER ,   MIP_NO_PERMISSIONS_ERROR_CLIENT_NOT_UPDATED }
enum	mip_cc_service_disabled_error_extent {   MIP_SERVICE_DISABLED_ERROR_EXTENT_USER ,   MIP_SERVICE_DISABLED_ERROR_EXTENT_DEVICE ,   MIP_SERVICE_DISABLED_ERROR_EXTENT_PLATFORM ,   MIP_SERVICE_DISABLED_ERROR_EXTENT_TENANT }

Detailed Description

Error definition and functions.

Definition in file error_cc.h.

Macro Definition Documentation

ERROR_STRING_BUFFER_SIZE

#define ERROR_STRING_BUFFER_SIZE   1024

Definition at line 39 of file error_cc.h.

Enumeration Type Documentation

mip_cc_network_error_category

enum mip_cc_network_error_category

Enumerator
MIP_NETWORK_ERROR_CATEGORY_UNKNOWN	Unknown network failure.
MIP_NETWORK_ERROR_CATEGORY_FAILURE_RESPONSE_CODE	HTTP response code indicates failure.
MIP_NETWORK_ERROR_CATEGORY_BAD_RESPONSE	HTTP response could not be read.
MIP_NETWORK_ERROR_CATEGORY_UNEXPECTED_RESPONSE	HTTP response completed but contained unexpected data.
MIP_NETWORK_ERROR_CATEGORY_NO_CONNECTION	Failed to establish a connection.
MIP_NETWORK_ERROR_CATEGORY_PROXY	Proxy failure.
MIP_NETWORK_ERROR_CATEGORY_SSL	SSL failure.
MIP_NETWORK_ERROR_CATEGORY_TIMEOUT	Connection timed out.
MIP_NETWORK_ERROR_CATEGORY_OFFLINE	Operation requires network connectivity.
MIP_NETWORK_ERROR_CATEGORY_THROTTLED	HTTP operation failed due to server traffic throttling.
MIP_NETWORK_ERROR_CATEGORY_CANCELLED	HTTP operation has been cancelled by the application.
MIP_NETWORK_ERROR_CATEGORY_FUNCTION_NOT_IMPLEMENTED	HTTP operation has been cancelled by the application.
MIP_NETWORK_ERROR_CATEGORY_SERVICE_UNAVAILABLE	HTTP response code indicates service is unavailable.

Definition at line 41 of file error_cc.h.

             {
  MIP_NETWORK_ERROR_CATEGORY_UNKNOWN,                   /**< Unknown network failure */
  MIP_NETWORK_ERROR_CATEGORY_FAILURE_RESPONSE_CODE,     /**< HTTP response code indicates failure */
  MIP_NETWORK_ERROR_CATEGORY_BAD_RESPONSE,              /**< HTTP response could not be read */
  MIP_NETWORK_ERROR_CATEGORY_UNEXPECTED_RESPONSE,       /**< HTTP response completed but contained unexpected data */
  MIP_NETWORK_ERROR_CATEGORY_NO_CONNECTION,             /**< Failed to establish a connection */
  MIP_NETWORK_ERROR_CATEGORY_PROXY,                     /**< Proxy failure */
  MIP_NETWORK_ERROR_CATEGORY_SSL,                       /**< SSL failure */
  MIP_NETWORK_ERROR_CATEGORY_TIMEOUT,                   /**< Connection timed out */
  MIP_NETWORK_ERROR_CATEGORY_OFFLINE,                   /**< Operation requires network connectivity */
  MIP_NETWORK_ERROR_CATEGORY_THROTTLED,                 /**< HTTP operation failed due to server traffic throttling */
  MIP_NETWORK_ERROR_CATEGORY_CANCELLED,                 /**< HTTP operation has been cancelled by the application */
  MIP_NETWORK_ERROR_CATEGORY_FUNCTION_NOT_IMPLEMENTED,  /**< HTTP operation has been cancelled by the application */
  MIP_NETWORK_ERROR_CATEGORY_SERVICE_UNAVAILABLE,       /**< HTTP response code indicates service is unavailable */
} mip_cc_network_error_category;

mip_cc_no_permissions_error_category

enum mip_cc_no_permissions_error_category

Enumerator
MIP_NO_PERMISSIONS_ERROR_UNKNOWN	Unknown no permissions failure.
MIP_NO_PERMISSIONS_ERROR_USER_NOT_FOUND	User was not found.
MIP_NO_PERMISSIONS_ERROR_ACCESS_DENIED
MIP_NO_PERMISSIONS_ERROR_ACCESS_EXPIRED
MIP_NO_PERMISSIONS_ERROR_INVALID_EMAIL
MIP_NO_PERMISSIONS_ERROR_UNKNOWN_TENANT
MIP_NO_PERMISSIONS_ERROR_NOT_OWNER
MIP_NO_PERMISSIONS_ERROR_NOT_PREMIUM_LICENSE_USER
MIP_NO_PERMISSIONS_ERROR_CLIENT_NOT_UPDATED	The SDK used by the client application does not support the requested operation. Update the SDK or check to make sure the correct arguments were provided

Definition at line 64 of file error_cc.h.

             {
  MIP_NO_PERMISSIONS_ERROR_UNKNOWN,     /**< Unknown no permissions failure */
  MIP_NO_PERMISSIONS_ERROR_USER_NOT_FOUND,   /**< User was not found */
  MIP_NO_PERMISSIONS_ERROR_ACCESS_DENIED,
  MIP_NO_PERMISSIONS_ERROR_ACCESS_EXPIRED,
  MIP_NO_PERMISSIONS_ERROR_INVALID_EMAIL,
  MIP_NO_PERMISSIONS_ERROR_UNKNOWN_TENANT,
  MIP_NO_PERMISSIONS_ERROR_NOT_OWNER,
  MIP_NO_PERMISSIONS_ERROR_NOT_PREMIUM_LICENSE_USER,
  MIP_NO_PERMISSIONS_ERROR_CLIENT_NOT_UPDATED,  /**< The SDK used by the client application does not support the requested operation. Update the SDK or check to make sure the correct arguments were provided */
} mip_cc_no_permissions_error_category;

mip_cc_service_disabled_error_extent

enum mip_cc_service_disabled_error_extent

Enumerator
MIP_SERVICE_DISABLED_ERROR_EXTENT_USER	Service is disabled for the user.
MIP_SERVICE_DISABLED_ERROR_EXTENT_DEVICE	Service is disabled for the device.
MIP_SERVICE_DISABLED_ERROR_EXTENT_PLATFORM	Service is disabled for the platform.
MIP_SERVICE_DISABLED_ERROR_EXTENT_TENANT	Service is disabled for the tenant.

Definition at line 57 of file error_cc.h.

             {
  MIP_SERVICE_DISABLED_ERROR_EXTENT_USER,     /**< Service is disabled for the user. */
  MIP_SERVICE_DISABLED_ERROR_EXTENT_DEVICE,   /**< Service is disabled for the device. */
  MIP_SERVICE_DISABLED_ERROR_EXTENT_PLATFORM, /**< Service is disabled for the platform. */
  MIP_SERVICE_DISABLED_ERROR_EXTENT_TENANT,   /**< Service is disabled for the tenant. */
} mip_cc_service_disabled_error_extent;