static.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_STATIC_H
#define AWA_STATIC_H

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

#include "types.h"
#include "error.h"

#ifdef __cplusplus
extern "C" {
#endif

/**************************************************************************************************
 * Example Usage
 *************************************************************************************************/

/**************************************************************************************************
 * Public Types and Enumerations
 *************************************************************************************************/

typedef enum
{
    AwaOperation_CreateObjectInstance,  
    AwaOperation_DeleteObjectInstance,  
    AwaOperation_Read,                  
    AwaOperation_Write,                 
    AwaOperation_Execute,               
    AwaOperation_CreateResource,        
    AwaOperation_DeleteResource,        
} AwaOperation;

typedef struct _AwaStaticClient AwaStaticClient;

typedef enum
{
  AwaSecurityMode_PreSharedKey,   
  AwaSecurityMode_RawPublicKey,   
  AwaSecurityMode_Certificate,    
  AwaSecurityMode_NoSec,          
} AwaSecurityMode;

#define BOOTSTRAP_CONFIG_SERVER_URI_SIZE (256)  
#define BOOTSTRAP_CONFIG_PUBLIC_KEY_SIZE (128)  
#define BOOTSTRAP_CONFIG_SERVER_KEY_SIZE (128)  
#define BOOTSTRAP_CONFIG_SECRET_KEY_SIZE (128)  
#define BOOTSTRAP_CONFIG_BINDING_SIZE     (10)  
typedef struct
{
    struct
    {
        char ServerURI[BOOTSTRAP_CONFIG_SERVER_URI_SIZE];           
        AwaSecurityMode SecurityMode;                               
        char PublicKeyOrIdentity[BOOTSTRAP_CONFIG_PUBLIC_KEY_SIZE]; 
        char ServerPublicKey[BOOTSTRAP_CONFIG_SERVER_KEY_SIZE];     
        char SecretKey[BOOTSTRAP_CONFIG_SECRET_KEY_SIZE];           
    } SecurityInfo;

    struct
    {
        int Lifetime;                                
        int DefaultMinPeriod;                        
        int DefaultMaxPeriod;                        
        int DisableTimeout;                          
        bool Notification;                           
        char Binding[BOOTSTRAP_CONFIG_BINDING_SIZE]; 
    } ServerInfo;
} AwaFactoryBootstrapInfo;

typedef enum
{
    AwaResult_Success = 200,           
    AwaResult_SuccessCreated = 201,    
    AwaResult_SuccessDeleted = 202,    
    AwaResult_SuccessChanged = 204,    
    AwaResult_SuccessContent = 205,    
    AwaResult_BadRequest = 400,        
    AwaResult_Unauthorized = 401,      
    AwaResult_Forbidden = 403,         
    AwaResult_NotFound = 404,          
    AwaResult_MethodNotAllowed = 405,  
    AwaResult_NotAcceptable = 406,     
    AwaResult_InternalError = 500,     
    AwaResult_OutOfMemory = 999,       
    AwaResult_AlreadyDefined,          
    AwaResult_MismatchedDefinition,    
    AwaResult_AlreadyCreated,          
    AwaResult_Unsupported,             
    AwaResult_Unspecified = -1,        
} AwaResult;


/**************************************************************************************************
 * Callbacks
 *************************************************************************************************/

typedef AwaResult (*AwaStaticClientHandler)(AwaStaticClient * client, AwaOperation operation,
                                            AwaObjectID objectID, AwaObjectInstanceID objectInstanceID, AwaResourceID resourceID, AwaResourceInstanceID resourceInstanceID,
                                            void ** dataPointer, size_t * dataSize, bool * changed);


/************************************************************************************************************
 * Awa Static Client Initialisation and Teardown
 ************************************************************************************************************/

AwaStaticClient * AwaStaticClient_New(void);

AwaContentType AwaStaticClient_GetDefaultContentType(void);

void AwaStaticClient_SetDefaultContentType(AwaContentType contentType);

AwaError AwaStaticClient_SetLogLevel(AwaLogLevel level);

AwaError AwaStaticClient_SetEndPointName(AwaStaticClient * client, const char * endPointName);

AwaError AwaStaticClient_SetCoAPListenAddressPort(AwaStaticClient * client, const char * address, int port);

AwaError AwaStaticClient_SetBootstrapServerURI(AwaStaticClient * client, const char * bootstrapServerURI);

AwaError AwaStaticClient_SetFactoryBootstrapInformation(AwaStaticClient * client, const AwaFactoryBootstrapInfo * factoryBootstrapInformation);

void AwaStaticClient_SetCertificate(AwaStaticClient * client, const uint8_t * certificate, int certificateLength, AwaCertificateFormat format);

void AwaStaticClient_SetPSK(AwaStaticClient * client, const char * identity, const uint8_t * key, int keyLength);

AwaError AwaStaticClient_SetApplicationContext(AwaStaticClient * client, void * context);

void * AwaStaticClient_GetApplicationContext(AwaStaticClient * client);

AwaClientRegistrationStatus AwaStaticClient_GetRegistrationStatus(AwaStaticClient * client);

AwaError AwaStaticClient_Init(AwaStaticClient * client);

void AwaStaticClient_Free(AwaStaticClient ** client);


/************************************************************************************************************
 * Awa Static Client Object and Resource Definition
 ************************************************************************************************************/

AwaError AwaStaticClient_DefineObject(AwaStaticClient * client, AwaObjectID objectID, const char * objectName,
                                      uint16_t minimumInstances, uint16_t maximumInstances);

AwaError AwaStaticClient_SetObjectOperationHandler(AwaStaticClient * client, AwaObjectID objectID, AwaStaticClientHandler handler);

AwaError AwaStaticClient_DefineResource(AwaStaticClient * client, AwaObjectID objectID, AwaResourceID resourceID,
                                        const char * resourceName, AwaResourceType resourceType,
                                        uint16_t minimumInstances, uint16_t maximumInstances, AwaResourceOperations operations);

AwaError AwaStaticClient_SetResourceOperationHandler(AwaStaticClient * client, AwaObjectID objectID, AwaResourceID resourceID, AwaStaticClientHandler handler);

AwaError AwaStaticClient_SetResourceStorageWithPointer(AwaStaticClient * client, AwaObjectID objectID, AwaResourceID resourceID, void * dataPointer, size_t dataElementSize, size_t dataStepSize);

AwaError AwaStaticClient_SetResourceStorageWithPointerArray(AwaStaticClient * client, AwaObjectID objectID, AwaResourceID resourceID, void * dataPointers[], size_t dataElementSize);


/************************************************************************************************************
 * Awa Static Client Processing
 ************************************************************************************************************/

int AwaStaticClient_Process(AwaStaticClient * client);


/************************************************************************************************************
 * Awa Static Client Object and Resource Manipulation
 ************************************************************************************************************/

const void * AwaStaticClient_GetResourceInstancePointer(AwaStaticClient * client, AwaObjectID objectID, AwaObjectInstanceID objectInstanceID, AwaResourceID resourceID, AwaResourceInstanceID resourceInstanceID, size_t * resourceSize);

AwaError AwaStaticClient_CreateResource(AwaStaticClient * client, AwaObjectID objectID, AwaObjectInstanceID objectInstanceID, AwaResourceID resourceID);

AwaError AwaStaticClient_DeleteResource(AwaStaticClient * client, AwaObjectID objectID, AwaObjectInstanceID objectInstanceID, AwaResourceID resourceID);

AwaError AwaStaticClient_CreateObjectInstance(AwaStaticClient * client, AwaObjectID objectID, AwaObjectInstanceID objectInstanceID);

AwaError AwaStaticClient_DeleteObjectInstance(AwaStaticClient * client, AwaObjectID objectID, AwaObjectInstanceID objectInstanceID);

AwaError AwaStaticClient_ResourceChanged(AwaStaticClient * client, AwaObjectID objectID, AwaObjectInstanceID objectInstanceID, AwaResourceID resourceID);

AwaError AwaStaticClient_ObjectInstanceChanged(AwaStaticClient * client, AwaObjectID objectID, AwaObjectInstanceID objectInstanceID);

#ifdef __cplusplus
}
#endif

#endif /* AWA_STATIC_CLIENT_H */