types.h

Go to the documentation of this file.

/************************************************************************************************************************
 Copyright (c) 2016, Imagination Technologies Limited and/or its affiliated group companies.
 All rights reserved.

 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
 following conditions are met:
     1. Redistributions of source code must retain the above copyright notice, this list of conditions and the
        following disclaimer.
     2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
        following disclaimer in the documentation and/or other materials provided with the distribution.
     3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
        products derived from this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
************************************************************************************************************************/

#ifndef AWA_TYPES_H
#define AWA_TYPES_H

// @cond
#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
// @endcond

#include "error.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef int AwaObjectID;
typedef int AwaObjectInstanceID;
typedef int AwaResourceID;
typedef int AwaResourceInstanceID;

#define AWA_INVALID_ID (-1)

#define AWA_MAX_ID (65535)

typedef int64_t AwaInteger;

typedef double AwaFloat;

typedef bool AwaBoolean;

typedef int64_t AwaTime;

typedef struct AwaOpaque
{
    void * Data;        
    size_t Size;        
} AwaOpaque;

typedef struct AwaObjectLink
{
    AwaObjectID ObjectID;                  
    AwaObjectInstanceID ObjectInstanceID;  
} AwaObjectLink;

// AwaString reserved for future use (UTF-8)

typedef enum
{
    AwaResourceType_Invalid = 0,     
    AwaResourceType_None,            
    AwaResourceType_String,          
    AwaResourceType_Integer,         
    AwaResourceType_Float,           
    AwaResourceType_Boolean,         
    AwaResourceType_Opaque,          
    AwaResourceType_Time,            
    AwaResourceType_ObjectLink,      
    // arrays (for multiple resource instances) are their own type
    AwaResourceType_StringArray,     
    AwaResourceType_IntegerArray,    
    AwaResourceType_FloatArray,      
    AwaResourceType_BooleanArray,    
    AwaResourceType_OpaqueArray,     
    AwaResourceType_TimeArray,       
    AwaResourceType_ObjectLinkArray, 
    // sentinel, do not remove
    AwaResourceType_LAST,            
    AwaResourceType_FirstArrayType = AwaResourceType_StringArray,    
    AwaResourceType_LastArrayType = AwaResourceType_ObjectLinkArray, 
} AwaResourceType;

typedef enum
{
    AwaResourceOperations_Invalid = -1, 
    AwaResourceOperations_None,         
    AwaResourceOperations_ReadOnly,     
    AwaResourceOperations_WriteOnly,    
    AwaResourceOperations_ReadWrite,    
    AwaResourceOperations_Execute,      
    // sentinel, do not remove
    AwaResourceOperations_LAST          
} AwaResourceOperations;

typedef enum
{
    AwaLogLevel_None = -1,  
    AwaLogLevel_Error,      
    AwaLogLevel_Warning,    
    AwaLogLevel_Verbose,    
    AwaLogLevel_Debug,      
} AwaLogLevel;

typedef enum
{
    AwaCertificateFormat_None, 
    AwaCertificateFormat_ASN1, 
    AwaCertificateFormat_PEM,  
} AwaCertificateFormat;


typedef enum
{
    AwaContentType_None = -1,
    AwaContentType_ApplicationPlainText        = 0,       // The new standard suggests to use PlainText
    AwaContentType_ApplicationLinkFormat       = 40,      // Object link format
    AwaContentType_ApplicationOctetStream      = 42,      // The new standard uses OctetStream, rather than omg.lwm2m+opaque
    AwaContentType_ApplicationJson             = 50,      // The new standard uses Json, rather than omg.lwm2m+json
    AwaContentType_ApplicationOmaLwm2mText     = 1541,    // application/vnd.oma.lwm2m+text (leshan uses 1541)
    AwaContentType_ApplicationOmaLwm2mTLV_Old  = 1542,    // Previously used by Leshan
    AwaContentType_ApplicationOmaLwm2mJson_Old = 1543,    // Previously used by Leshan
    AwaContentType_ApplicationOmaLwm2mOpaque   = 1544,
    AwaContentType_ApplicationOmaLwm2mTLV      = 11542,   // application/vnd.oma.lwm2m+tlv
    AwaContentType_ApplicationOmaLwm2mJson     = 11543,
} AwaContentType;

typedef enum
{
    AwaClientRegistrationStatus_Invalid = -1,               
    AwaClientRegistrationStatus_Bootstrap,                  
    AwaClientRegistrationStatus_BootstrapFailed,            
    AwaClientRegistrationStatus_NotRegistered,              
    AwaClientRegistrationStatus_Registering,                
    AwaClientRegistrationStatus_Registered,                 
    AwaClientRegistrationStatus_RegisterFailed,             
} AwaClientRegistrationStatus;

#ifdef __cplusplus
}
#endif

#endif // AWA_TYPES_H