Awa LWM2M C API (0.2.5)  
Enumerations | Functions
error.h File Reference

Provides definitions for Awa LWM2M Client and Server API error codes and error function declarations. More...

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

Go to the source code of this file.

Enumerations

enum  AwaError {
  AwaError_Success,
  AwaError_Unspecified,
  AwaError_Unsupported,
  AwaError_Internal,
  AwaError_OutOfMemory,
  AwaError_SessionInvalid,
  AwaError_SessionNotConnected,
  AwaError_NotDefined,
  AwaError_AlreadyDefined,
  AwaError_OperationInvalid,
  AwaError_PathInvalid,
  AwaError_PathNotFound,
  AwaError_TypeMismatch,
  AwaError_Timeout,
  AwaError_Overrun,
  AwaError_IDInvalid,
  AwaError_AddInvalid,
  AwaError_CannotCreate,
  AwaError_CannotDelete,
  AwaError_DefinitionInvalid,
  AwaError_AlreadySubscribed,
  AwaError_SubscriptionInvalid,
  AwaError_ObservationInvalid,
  AwaError_IPCError,
  AwaError_ResponseInvalid,
  AwaError_ClientIDInvalid,
  AwaError_ClientNotFound,
  AwaError_LWM2MError,
  AwaError_IteratorInvalid,
  AwaError_Response,
  AwaError_RangeInvalid,
  AwaError_StaticClientInvalid,
  AwaError_StaticClientNotConfigured,
  AwaError_StaticClientNotInitialized,
  AwaError_LogLevelInvalid,
  AwaError_LAST
}
 API Error Codes. More...
 
enum  AwaLWM2MError {
  AwaLWM2MError_Success,
  AwaLWM2MError_Unspecified,
  AwaLWM2MError_BadRequest,
  AwaLWM2MError_Unauthorized,
  AwaLWM2MError_NotFound,
  AwaLWM2MError_MethodNotAllowed,
  AwaLWM2MError_NotAcceptable,
  AwaLWM2MError_Timeout,
  AwaLWM2MError_LAST
}
 

Functions

const char * AwaError_ToString (AwaError error)
 Get a descriptive name for the specified error code. More...
 
AwaError AwaError_FromString (const char *errorString)
 Get an error code from a descriptive name of an error. More...
 
const char * AwaLWM2MError_ToString (AwaLWM2MError error)
 Get a descriptive name for the specified error code. More...
 
AwaLWM2MError AwaLWM2MError_FromString (const char *errorString)
 Get an error code from a descriptive name of an error. More...
 

Detailed Description

Provides definitions for Awa LWM2M Client and Server API error codes and error function declarations.

Enumeration Type Documentation

enum AwaError

API Error Codes.

Enumerator
AwaError_Success 

Indicates an operation was successful.

AwaError_Unspecified 

Used as a default error value.

AwaError_Unsupported 

Indicates an API function or value is not supported.

AwaError_Internal 

Indicates an internal error has occurred.

AwaError_OutOfMemory 

Indicates an operation failed to allocate memory.

AwaError_SessionInvalid 

Indicates an operation was attempted in the context of an invalid session.

AwaError_SessionNotConnected 

Indicates an operation was attempted in the context of a valid session that is not connected to IPC.

AwaError_NotDefined 

Indicates an operation was attempted on an object or resource that is not defined in the session.

AwaError_AlreadyDefined 

Indicates an object or resource has already been defined.

AwaError_OperationInvalid 

Indicates an operation was attempted on an invalid operation.

AwaError_PathInvalid 

Indicates a specified path is invalid in the context of the operation.

AwaError_PathNotFound 

Indicates a valid path is not found during an operation.

AwaError_TypeMismatch 

Indicates a type mismatch between data and function.

AwaError_Timeout 

Indicates an operation has timed out.

AwaError_Overrun 

Indicates an operation has overrun the supplied buffer.

AwaError_IDInvalid 

Indicates an invalid ID or ID pointer was provided.

AwaError_AddInvalid 

Indicates an incorrect or malformed Add operation was attempted.

AwaError_CannotCreate 

Indicates an attempt to create something that can't be created.

AwaError_CannotDelete 

Indicates an attempt to delete something that can't be deleted.

AwaError_DefinitionInvalid 

Indicates an attempt to use an invalid object/resource definition instance.

AwaError_AlreadySubscribed 

Indicates an attempt to subscribe to a resource, object instance or object more than once.

AwaError_SubscriptionInvalid 

Indicates an attempt to use an invalid subscription instance.

AwaError_ObservationInvalid 

Indicates an attempt to use an invalid observation instance.

AwaError_IPCError 

Indicates a general IPC error occurred.

AwaError_ResponseInvalid 

Indicates an attempt to get or use an invalid response.

AwaError_ClientIDInvalid 

Indicates a client ID is invalid.

AwaError_ClientNotFound 

Indicates a client with a matching ID was not found.

AwaError_LWM2MError 

Indicates a LWM2M error has occurred.

AwaError_IteratorInvalid 

Indicates an invalid iterator was used.

AwaError_Response 

Indicates an operation response has errors.

AwaError_RangeInvalid 

Indicates an operation on an invalid array range.

AwaError_StaticClientInvalid 

Indicates an operation was attempted in the context of an invalid Static Client.

AwaError_StaticClientNotConfigured 

Indicates a Static Client was initialised without being configured.

AwaError_StaticClientNotInitialized 

Indicates a Static Client was not initialized.

AwaError_LogLevelInvalid 

Indicates an attempt to set an unknown log level.

AwaError_LAST 

Reserved value.

Enumerator
AwaLWM2MError_Success 

Indicates no server occurred.

AwaLWM2MError_Unspecified 

Used as a default error value.

AwaLWM2MError_BadRequest 

Indicates a LWM2M 4.00 Bad Request error was encountered.

AwaLWM2MError_Unauthorized 

Indicates a LWM2M 4.01 Unauthorized error was encountered.

AwaLWM2MError_NotFound 

Indicates a LWM2M 4.04 Not Found error was encountered.

AwaLWM2MError_MethodNotAllowed 

Indicates a LWM2M 4.05 Not Allowed error was encountered.

AwaLWM2MError_NotAcceptable 

Indicates a LWM2M 4.06 Not Acceptable error was encountered.

AwaLWM2MError_Timeout 

Indicates a CoAP 5.04 Gateway timeout error was encountered.

AwaLWM2MError_LAST 

Reserved value.

Function Documentation

const char* AwaError_ToString ( AwaError  error)

Get a descriptive name for the specified error code.

Parameters
[in]errorError code returned by an API function.
Returns
Pointer to an immutable c string.
AwaError AwaError_FromString ( const char *  errorString)

Get an error code from a descriptive name of an error.

Parameters
[in]errorStringAn error string to convert into a AwaError error code.
Returns
Pointer to an immutable c string.
const char* AwaLWM2MError_ToString ( AwaLWM2MError  error)

Get a descriptive name for the specified error code.

Parameters
[in]errorServer error code returned by an API function.
Returns
Pointer to an immutable c string.
AwaLWM2MError AwaLWM2MError_FromString ( const char *  errorString)

Get an error code from a descriptive name of an error.

Parameters
[in]errorStringAn error string to convert into a AwaLWM2MError error code.
Returns
Pointer to an immutable c string.