Edge and protocol translator common definitions.

Files
file	pt_api_error_codes.h
	Edge service error codes.

Enumerations
enum	pt_api_result_code_e {   PT_API_SUCCESS = 0, PT_API_UNKNOWN_ERROR = -1, PT_API_INTERNAL_ERROR = -30000, PT_API_PROTOCOL_TRANSLATOR_NOT_REGISTERED = -30001,   PT_API_PROTOCOL_TRANSLATOR_ALREADY_REGISTERED = -30002, PT_API_PROTOCOL_TRANSLATOR_NAME_RESERVED = -30003, PT_API_REGISTERED_ENDPOINT_LIMIT_REACHED = -30004, PT_API_ENDPOINT_ALREADY_REGISTERED = -30005,   PT_API_EDGE_CORE_SHUTTING_DOWN = -30006, PT_API_REQUEST_TIMEOUT = -30007, PT_API_REMOTE_DISCONNECTED = -30008, PT_API_PROTOCOL_TRANSLATOR_CLIENT_WRITE_ERROR = -30100,   PT_API_ILLEGAL_VALUE = -30101, PT_API_RESOURCE_NOT_FOUND = -30102, PT_API_INVALID_JSON_STRUCTURE = -30103, PT_API_RESOURCE_NOT_READABLE = -30104,   PT_API_RESOURCE_NOT_WRITABLE = -30105, PT_API_WRITE_TO_PROTOCOL_TRANSLATOR_FAILED = -30106, PT_API_CERTIFICATE_RENEWAL_BUSY = -30107, PT_API_CERTIFICATE_RENEWAL_ERROR = -30108,   PT_API_CERTIFICATE_RENEWAL_INVALID_PARAMETERS = -30109, PT_API_CERTIFICATE_RENEWAL_MEMORY_ALLOCATION_FAILURE = -30110, GRM_API_RESOURCE_MANAGER_NOT_REGISTERED = -30200, GRM_API_RESOURCE_MANAGER_ALREADY_REGISTERED = -30201,   GRM_API_RESOURCE_MANAGER_NAME_RESERVED = -30202, GRM_API_OBJECT_RESERVED = -30250, GRM_API_RESOURCE_AlREADY_EXISTS = -30251 }

Functions
const char *	pt_api_get_error_message (pt_api_result_code_e code)
	Get the human-readable error message for the error code. More...

Detailed Description

Enumeration Type Documentation

enum pt_api_result_code_e

Enumerator
PT_API_SUCCESS	Operation succeeded.
PT_API_UNKNOWN_ERROR	Unknown PT API error.
PT_API_INTERNAL_ERROR	An internal error code.
PT_API_PROTOCOL_TRANSLATOR_NOT_REGISTERED	The protocol translator is not registered.
PT_API_PROTOCOL_TRANSLATOR_ALREADY_REGISTERED	The protocol translator is already registered.
PT_API_PROTOCOL_TRANSLATOR_NAME_RESERVED	The given protocol translator name is already registered.
PT_API_REGISTERED_ENDPOINT_LIMIT_REACHED	Cannot add new endpoint, because the maximum number of registered endpoints is already in use.
PT_API_ENDPOINT_ALREADY_REGISTERED	Cannot register the endpoint, because it is already registered.
PT_API_EDGE_CORE_SHUTTING_DOWN	The Edge Core is shutting down.
PT_API_REQUEST_TIMEOUT	The request timed out.
PT_API_REMOTE_DISCONNECTED	The request timed out.
PT_API_PROTOCOL_TRANSLATOR_CLIENT_WRITE_ERROR	The protocol translator client write error.
PT_API_ILLEGAL_VALUE	An illegal value was given to write.
PT_API_RESOURCE_NOT_FOUND	The given resource was not found.
PT_API_INVALID_JSON_STRUCTURE	the JSON structure is not according to specification.
PT_API_RESOURCE_NOT_READABLE	The resource was not readable.
PT_API_RESOURCE_NOT_WRITABLE	The resource was not writable.
PT_API_WRITE_TO_PROTOCOL_TRANSLATOR_FAILED	Write to protocol translator failed.
PT_API_CERTIFICATE_RENEWAL_BUSY	Certificate renewal failed because one is already in progress.
PT_API_CERTIFICATE_RENEWAL_ERROR	Certificate renewal failed to internal error.
PT_API_CERTIFICATE_RENEWAL_INVALID_PARAMETERS	Certificate renewal failed to invalid parameters.
PT_API_CERTIFICATE_RENEWAL_MEMORY_ALLOCATION_FAILURE	Certificate renewal failed because a memory allocation failed.
GRM_API_RESOURCE_MANAGER_NOT_REGISTERED	The resource manager is not registered.
GRM_API_RESOURCE_MANAGER_ALREADY_REGISTERED	The given resource manager is already registered.
GRM_API_RESOURCE_MANAGER_NAME_RESERVED	The resource manager name is reserved.
GRM_API_OBJECT_RESERVED	The given object id is reserved.
GRM_API_RESOURCE_AlREADY_EXISTS	Cannot add the given gateway resource because it already exists.

Function Documentation

const char* pt_api_get_error_message

(

pt_api_result_code_e

code

)

Get the human-readable error message for the error code.

Returns

The error message.