axStatusCodes.h

00001 
00002 #ifndef _AXSTATUSCODES_H_
00003 #define _AXSTATUSCODES_H_
00004 
00005 #define AX_ERROR -1                         //A General Error has occurred
00006 #define AX_OK 0                             //Operation Success
00007 #define AX_UNKNOWN -42                      //An unknown error has occurred. Functions are normally initialized to return this value. The function should change it before returning it.
00008 #define AX_ARGNULL -999                     //An argument passed to the function was left null
00009 #define AX_OUT_OF_RANGE -998                //An argument passed to the function was out of range
00010 #define AX_DI_UNKNOWN_TYPE -997             //An argument passed to the function indicating the Data Item type was incorrect
00011 #define AX_CONFLICTING_ARG -996             //Two arguments passed to a function describing the same object have conflicting values e.g. arg1(string)=="fubar"; arg2(strlength)==0, The string fubar is obviously longer than 0
00012 #define AX_ARG_EMPTY  -995          //An argument passed to the function was a string but it was empty eg mystring="". This will be thrown when a value is required. 
00013 
00014 #define AX_NET_ERR_UNABLE_TO_CONNECT  700       //Call to open the TCP port to IP or hostname has failed. Is the port open? IP contactable?
00015 #define AX_NET_ERR_PORT_WRITE         701       //The program was unable to write data onto the socket.
00016 #define AX_NET_ERR_HEADER_WRITE       702       //a write error occurred while writing the HTTP headers
00017 #define AX_NET_ERR_DATA_WRITE         703       //a write error occurred while writing the HTTP data/body
00018 #define AX_NET_ERR_TIMEOUT            704       //A timeout occurred while waiting for a response.
00019 #define AX_NET_PORT_INVALID           705       //The port that was specified is larger than 65536 or less than 0
00020 #define AX_NET_DNS_ERROR          706   //There was an error resolving the name of the platform server
00021 #define AX_NET_MORE_WAITING       707   //Thrown when the data written to the port does not equal the amount of data that was requested to be written.
00022 
00023 #define AX_GEN_STR_TRUNC                604     //the string to be stored was too long and has been truncated, This is a warning only.
00024 #define AX_EGR_JSON_PARSE_FAIL          800     //The egress message that was returned did not have the necessary fields
00025 #define AX_GEN_PARSE_ERR                603     //A general parsing failure has occured. Invalid JSON will cause this error. 
00026 
00027 
00028 //The following codes are used for an optional Queueing implementation example. 
00029 #define AX_GEN_QUEUE_FULL               600     //The queue is full and cannot accept more items. Item was not added. Enable overwrite or empty the queue
00030 #define AX_GEN_QUEUE_ITEM_EXISTS        601     //The item you tried to enqueue already exists in the queue.
00031 #define AX_GEN_QUEUE_EMPTY              602     //The queue is empty, thrown on a dequeue operation
00032 
00033 
00034 
00035 
00036 #endif
00037