Awa LWM2M C API (0.2.5)  
common.h
Go to the documentation of this file.
1 /************************************************************************************************************************
2  Copyright (c) 2016, Imagination Technologies Limited and/or its affiliated group companies.
3  All rights reserved.
4 
5  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
6  following conditions are met:
7  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the
8  following disclaimer.
9  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
10  following disclaimer in the documentation and/or other materials provided with the distribution.
11  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
12  products derived from this software without specific prior written permission.
13 
14  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
15  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
18  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
19  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
20  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
21 ************************************************************************************************************************/
22 
28 #ifndef AWA_COMMON_H
29 #define AWA_COMMON_H
30 
31 // @cond
32 #include <stdbool.h>
33 #include <stdint.h>
34 #include <stdlib.h>
35 // @endcond
36 
37 #include "types.h"
38 #include "error.h"
39 
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43 
44 /**************************************************************************************************
45  * Public Types and Enumerations
46  *************************************************************************************************/
47 
51 typedef enum
52 {
53  AwaChangeType_Invalid = 0,
55  AwaChangeType_ResourceCreated,
56  AwaChangeType_ResourceModified,
57  AwaChangeType_ResourceDeleted,
59  AwaChangeType_ObjectInstanceCreated,
60  AwaChangeType_ObjectInstanceModified,
61  AwaChangeType_ObjectInstanceDeleted,
63  AwaChangeType_Current,
65 } AwaChangeType;
66 
70 typedef int AwaTimeout;
71 
75 typedef enum
76 {
77  AwaSubscribeType_None,
78  AwaSubscribeType_Change,
79  AwaSubscribeType_Execute,
80 } AwaSubscribeType;
81 
82 /**************************************************************************************************
83  * Array Management for Resources
84  *************************************************************************************************/
85 
89 typedef size_t AwaArrayIndex;
90 
94 typedef size_t AwaArrayLength;
95 
96 // Public array types
97 typedef struct _AwaStringArray AwaStringArray;
98 typedef struct _AwaIntegerArray AwaIntegerArray;
99 typedef struct _AwaFloatArray AwaFloatArray;
100 typedef struct _AwaBooleanArray AwaBooleanArray;
101 typedef struct _AwaOpaqueArray AwaOpaqueArray;
102 typedef struct _AwaTimeArray AwaTimeArray;
103 typedef struct _AwaObjectLinkArray AwaObjectLinkArray;
104 
105 // Public Array Iterator types
106 typedef struct _AwaCStringArrayIterator AwaCStringArrayIterator;
107 typedef struct _AwaIntegerArrayIterator AwaIntegerArrayIterator;
108 typedef struct _AwaFloatArrayIterator AwaFloatArrayIterator;
109 typedef struct _AwaBooleanArrayIterator AwaBooleanArrayIterator;
110 typedef struct _AwaOpaqueArrayIterator AwaOpaqueArrayIterator;
111 typedef struct _AwaTimeArrayIterator AwaTimeArrayIterator;
112 typedef struct _AwaObjectLinkArrayIterator AwaObjectLinkArrayIterator;
113 
124 AwaStringArray * AwaStringArray_New (void);
125 AwaIntegerArray * AwaIntegerArray_New (void);
126 AwaFloatArray * AwaFloatArray_New (void);
127 AwaBooleanArray * AwaBooleanArray_New (void);
128 AwaOpaqueArray * AwaOpaqueArray_New (void);
129 AwaTimeArray * AwaTimeArray_New (void);
130 AwaObjectLinkArray * AwaObjectLinkArray_New(void);
141 void AwaStringArray_Free (AwaStringArray ** array);
142 void AwaIntegerArray_Free (AwaIntegerArray ** array);
143 void AwaFloatArray_Free (AwaFloatArray ** array);
144 void AwaBooleanArray_Free (AwaBooleanArray ** array);
145 void AwaOpaqueArray_Free (AwaOpaqueArray ** array);
146 void AwaTimeArray_Free (AwaTimeArray ** array);
147 void AwaObjectLinkArray_Free(AwaObjectLinkArray ** array);
159 // RESERVED for UTF8 support:
160 //void AwaStringArray_SetValue (AwaStringArray * array, AwaArrayIndex index, AwaString value);
161 void AwaStringArray_SetValueAsCString(AwaStringArray * array, AwaArrayIndex index, const char * value);
162 void AwaIntegerArray_SetValue (AwaIntegerArray * array, AwaArrayIndex index, AwaInteger value);
163 void AwaFloatArray_SetValue (AwaFloatArray * array, AwaArrayIndex index, AwaFloat value);
164 void AwaBooleanArray_SetValue (AwaBooleanArray * array, AwaArrayIndex index, AwaBoolean value);
165 void AwaOpaqueArray_SetValue (AwaOpaqueArray * array, AwaArrayIndex index, AwaOpaque value);
166 void AwaTimeArray_SetValue (AwaTimeArray * array, AwaArrayIndex index, AwaTime value);
167 void AwaObjectLinkArray_SetValue (AwaObjectLinkArray * array, AwaArrayIndex index, AwaObjectLink value);
178 void AwaStringArray_DeleteValue (AwaStringArray * array, AwaArrayIndex index);
179 void AwaIntegerArray_DeleteValue (AwaIntegerArray * array, AwaArrayIndex index);
180 void AwaFloatArray_DeleteValue (AwaFloatArray * array, AwaArrayIndex index);
181 void AwaBooleanArray_DeleteValue (AwaBooleanArray * array, AwaArrayIndex index);
182 void AwaOpaqueArray_DeleteValue (AwaOpaqueArray * array, AwaArrayIndex index);
183 void AwaTimeArray_DeleteValue (AwaTimeArray * array, AwaArrayIndex index);
184 void AwaObjectLinkArray_DeleteValue(AwaObjectLinkArray * array, AwaArrayIndex index);
197 // RESERVED for UTF8 support:
198 //AwaString AwaStringArray_GetValue (const AwaStringArray * array, AwaArrayIndex index);
199 const char * AwaStringArray_GetValueAsCString(const AwaStringArray * array, AwaArrayIndex index);
200 AwaInteger AwaIntegerArray_GetValue (const AwaIntegerArray * array, AwaArrayIndex index);
201 AwaFloat AwaFloatArray_GetValue (const AwaFloatArray * array, AwaArrayIndex index);
202 AwaBoolean AwaBooleanArray_GetValue (const AwaBooleanArray * array, AwaArrayIndex index);
203 AwaOpaque AwaOpaqueArray_GetValue (const AwaOpaqueArray * array, AwaArrayIndex index);
204 AwaTime AwaTimeArray_GetValue (const AwaTimeArray * array, AwaArrayIndex index);
205 AwaObjectLink AwaObjectLinkArray_GetValue (const AwaObjectLinkArray * array, AwaArrayIndex index);
217 size_t AwaStringArray_GetValueCount (const AwaStringArray * array);
218 size_t AwaIntegerArray_GetValueCount (const AwaIntegerArray * array);
219 size_t AwaFloatArray_GetValueCount (const AwaFloatArray * array);
220 size_t AwaBooleanArray_GetValueCount (const AwaBooleanArray * array);
221 size_t AwaOpaqueArray_GetValueCount (const AwaOpaqueArray * array);
222 size_t AwaTimeArray_GetValueCount (const AwaTimeArray * array);
223 size_t AwaObjectLinkArray_GetValueCount(const AwaObjectLinkArray * array);
237 AwaCStringArrayIterator * AwaStringArray_NewCStringArrayIterator (const AwaStringArray * array);
238 AwaIntegerArrayIterator * AwaIntegerArray_NewIntegerArrayIterator (const AwaIntegerArray * array);
239 AwaFloatArrayIterator * AwaFloatArray_NewFloatArrayIterator (const AwaFloatArray * array);
240 AwaBooleanArrayIterator * AwaBooleanArray_NewBooleanArrayIterator (const AwaBooleanArray * array);
241 AwaOpaqueArrayIterator * AwaOpaqueArray_NewOpaqueArrayIterator (const AwaOpaqueArray * array);
242 AwaTimeArrayIterator * AwaTimeArray_NewTimeArrayIterator (const AwaTimeArray * array);
243 AwaObjectLinkArrayIterator * AwaObjectLinkArray_NewObjectLinkArrayIterator(const AwaObjectLinkArray * array);
257 bool AwaStringArray_IsValid (const AwaStringArray * array, AwaArrayIndex index);
258 bool AwaIntegerArray_IsValid (const AwaIntegerArray * array, AwaArrayIndex index);
259 bool AwaFloatArray_IsValid (const AwaFloatArray * array, AwaArrayIndex index);
260 bool AwaBooleanArray_IsValid (const AwaBooleanArray * array, AwaArrayIndex index);
261 bool AwaOpaqueArray_IsValid (const AwaOpaqueArray * array, AwaArrayIndex index);
262 bool AwaTimeArray_IsValid (const AwaTimeArray * array, AwaArrayIndex index);
263 bool AwaObjectLinkArray_IsValid(const AwaObjectLinkArray * array, AwaArrayIndex index);
266 // TODO: Array appending can be handled by the high-level API
267 
278 bool AwaCStringArrayIterator_Next (AwaCStringArrayIterator * iterator);
279 bool AwaIntegerArrayIterator_Next (AwaIntegerArrayIterator * iterator);
280 bool AwaFloatArrayIterator_Next (AwaFloatArrayIterator * iterator);
281 bool AwaBooleanArrayIterator_Next (AwaBooleanArrayIterator * iterator);
282 bool AwaOpaqueArrayIterator_Next (AwaOpaqueArrayIterator * iterator);
283 bool AwaTimeArrayIterator_Next (AwaTimeArrayIterator * iterator);
284 bool AwaObjectLinkArrayIterator_Next(AwaObjectLinkArrayIterator * iterator);
296 AwaArrayIndex AwaCStringArrayIterator_GetIndex (const AwaCStringArrayIterator * iterator);
297 AwaArrayIndex AwaIntegerArrayIterator_GetIndex (const AwaIntegerArrayIterator * iterator);
298 AwaArrayIndex AwaFloatArrayIterator_GetIndex (const AwaFloatArrayIterator * iterator);
299 AwaArrayIndex AwaBooleanArrayIterator_GetIndex (const AwaBooleanArrayIterator * iterator);
300 AwaArrayIndex AwaOpaqueArrayIterator_GetIndex (const AwaOpaqueArrayIterator * iterator);
301 AwaArrayIndex AwaTimeArrayIterator_GetIndex (const AwaTimeArrayIterator * iterator);
302 AwaArrayIndex AwaObjectLinkArrayIterator_GetIndex(const AwaObjectLinkArrayIterator * iterator);
314 // RESERVED for UTF8 support:
315 //AwaString AwaStringArrayIterator_GetValue (const AwaStringArrayIterator * iterator);
316 const char * AwaCStringArrayIterator_GetValueAsCString(const AwaCStringArrayIterator * iterator);
317 AwaInteger AwaIntegerArrayIterator_GetValue (const AwaIntegerArrayIterator * iterator);
318 AwaFloat AwaFloatArrayIterator_GetValue (const AwaFloatArrayIterator * iterator);
319 AwaBoolean AwaBooleanArrayIterator_GetValue (const AwaBooleanArrayIterator * iterator);
320 AwaOpaque AwaOpaqueArrayIterator_GetValue (const AwaOpaqueArrayIterator * iterator);
321 AwaTime AwaTimeArrayIterator_GetValue (const AwaTimeArrayIterator * iterator);
322 AwaObjectLink AwaObjectLinkArrayIterator_GetValue (const AwaObjectLinkArrayIterator * iterator);
333 void AwaCStringArrayIterator_Free (AwaCStringArrayIterator ** iterator);
334 void AwaIntegerArrayIterator_Free (AwaIntegerArrayIterator ** iterator);
335 void AwaFloatArrayIterator_Free (AwaFloatArrayIterator ** iterator);
336 void AwaBooleanArrayIterator_Free (AwaBooleanArrayIterator ** iterator);
337 void AwaOpaqueArrayIterator_Free (AwaOpaqueArrayIterator ** iterator);
338 void AwaTimeArrayIterator_Free (AwaTimeArrayIterator ** iterator);
339 void AwaObjectLinkArrayIterator_Free(AwaObjectLinkArrayIterator ** iterator);
342 /**************************************************************************************************
343  * Definition Functions common to Server and Client
344  *************************************************************************************************/
345 
346 typedef struct _ObjectDefinition AwaObjectDefinition;
347 typedef struct _ResourceDefinition AwaResourceDefinition;
348 typedef struct _AwaObjectDefinitionIterator AwaObjectDefinitionIterator;
349 typedef struct _AwaResourceDefinitionIterator AwaResourceDefinitionIterator;
350 
360 AwaObjectDefinition * AwaObjectDefinition_New(AwaObjectID objectID, const char * objectName, int minimumInstances, int maximumInstances);
361 
367 void AwaObjectDefinition_Free(AwaObjectDefinition ** objectDefinition);
368 
384 AwaError AwaObjectDefinition_AddResourceDefinitionAsNoType(AwaObjectDefinition * objectDefinition, AwaResourceID resourceID, const char * resourceName, bool isMandatory, AwaResourceOperations operations);
385 
406 AwaError AwaObjectDefinition_AddResourceDefinitionAsString (AwaObjectDefinition * objectDefinition, AwaResourceID resourceID, const char * resourceName, bool isMandatory, AwaResourceOperations operations, const char * defaultValue);
407 AwaError AwaObjectDefinition_AddResourceDefinitionAsInteger (AwaObjectDefinition * objectDefinition, AwaResourceID resourceID, const char * resourceName, bool isMandatory, AwaResourceOperations operations, AwaInteger defaultValue);
408 AwaError AwaObjectDefinition_AddResourceDefinitionAsFloat (AwaObjectDefinition * objectDefinition, AwaResourceID resourceID, const char * resourceName, bool isMandatory, AwaResourceOperations operations, AwaFloat defaultValue);
409 AwaError AwaObjectDefinition_AddResourceDefinitionAsBoolean (AwaObjectDefinition * objectDefinition, AwaResourceID resourceID, const char * resourceName, bool isMandatory, AwaResourceOperations operations, AwaBoolean defaultValue);
410 AwaError AwaObjectDefinition_AddResourceDefinitionAsOpaque (AwaObjectDefinition * objectDefinition, AwaResourceID resourceID, const char * resourceName, bool isMandatory, AwaResourceOperations operations, AwaOpaque defaultValue);
411 AwaError AwaObjectDefinition_AddResourceDefinitionAsTime (AwaObjectDefinition * objectDefinition, AwaResourceID resourceID, const char * resourceName, bool isMandatory, AwaResourceOperations operations, AwaTime defaultValue);
412 AwaError AwaObjectDefinition_AddResourceDefinitionAsObjectLink(AwaObjectDefinition * objectDefinition, AwaResourceID resourceID, const char * resourceName, bool isMandatory, AwaResourceOperations operations, AwaObjectLink defaultValue);
437 AwaError AwaObjectDefinition_AddResourceDefinitionAsStringArray (AwaObjectDefinition * objectDefinition, AwaResourceID resourceID, const char * resourceName, int minimumInstances, int maximumInstances, AwaResourceOperations operations, const AwaStringArray * defaultArray);
438 AwaError AwaObjectDefinition_AddResourceDefinitionAsIntegerArray (AwaObjectDefinition * objectDefinition, AwaResourceID resourceID, const char * resourceName, int minimumInstances, int maximumInstances, AwaResourceOperations operations, const AwaIntegerArray * defaultArray);
439 AwaError AwaObjectDefinition_AddResourceDefinitionAsFloatArray (AwaObjectDefinition * objectDefinition, AwaResourceID resourceID, const char * resourceName, int minimumInstances, int maximumInstances, AwaResourceOperations operations, const AwaFloatArray * defaultArray);
440 AwaError AwaObjectDefinition_AddResourceDefinitionAsBooleanArray (AwaObjectDefinition * objectDefinition, AwaResourceID resourceID, const char * resourceName, int minimumInstances, int maximumInstances, AwaResourceOperations operations, const AwaBooleanArray * defaultArray);
441 AwaError AwaObjectDefinition_AddResourceDefinitionAsTimeArray (AwaObjectDefinition * objectDefinition, AwaResourceID resourceID, const char * resourceName, int minimumInstances, int maximumInstances, AwaResourceOperations operations, const AwaTimeArray * defaultArray);
442 AwaError AwaObjectDefinition_AddResourceDefinitionAsOpaqueArray (AwaObjectDefinition * objectDefinition, AwaResourceID resourceID, const char * resourceName, int minimumInstances, int maximumInstances, AwaResourceOperations operations, const AwaOpaqueArray * defaultArray);
443 AwaError AwaObjectDefinition_AddResourceDefinitionAsObjectLinkArray(AwaObjectDefinition * objectDefinition, AwaResourceID resourceID, const char * resourceName, int minimumInstances, int maximumInstances, AwaResourceOperations operations, const AwaObjectLinkArray * defaultArray);
452 AwaObjectID AwaObjectDefinition_GetID (const AwaObjectDefinition * objectDefinition);
453 
460 const char * AwaObjectDefinition_GetName (const AwaObjectDefinition * objectDefinition);
461 
468 int AwaObjectDefinition_GetMinimumInstances (const AwaObjectDefinition * objectDefinition);
469 
476 int AwaObjectDefinition_GetMaximumInstances (const AwaObjectDefinition * objectDefinition);
477 
485 bool AwaObjectDefinition_IsResourceDefined (const AwaObjectDefinition * objectDefinition, AwaResourceID resourceID);
486 
495 const AwaResourceDefinition * AwaObjectDefinition_GetResourceDefinition(const AwaObjectDefinition * objectDefinition, AwaResourceID resourceID);
496 
504 bool AwaObjectDefinitionIterator_Next(AwaObjectDefinitionIterator * iterator);
505 
512 const AwaObjectDefinition * AwaObjectDefinitionIterator_Get(const AwaObjectDefinitionIterator * iterator);
513 
519 void AwaObjectDefinitionIterator_Free(AwaObjectDefinitionIterator ** iterator);
520 
527 AwaResourceID AwaResourceDefinition_GetID(const AwaResourceDefinition * resourceDefinition);
528 
535 AwaResourceType AwaResourceDefinition_GetType(const AwaResourceDefinition * resourceDefinition);
536 
543 const char * AwaResourceDefinition_GetName(const AwaResourceDefinition * resourceDefinition);
544 
551 int AwaResourceDefinition_GetMinimumInstances(const AwaResourceDefinition * resourceDefinition);
552 
559 int AwaResourceDefinition_GetMaximumInstances(const AwaResourceDefinition * resourceDefinition);
560 
567 AwaResourceOperations AwaResourceDefinition_GetSupportedOperations(const AwaResourceDefinition * resourceDefinition);
568 
575 bool AwaResourceDefinition_IsMandatory(const AwaResourceDefinition * resourceDefinition);
576 
585 AwaResourceDefinitionIterator * AwaObjectDefinition_NewResourceDefinitionIterator(const AwaObjectDefinition * objectDefinition);
586 
594 bool AwaResourceDefinitionIterator_Next(AwaResourceDefinitionIterator * iterator);
595 
602 const AwaResourceDefinition * AwaResourceDefinitionIterator_Get(const AwaResourceDefinitionIterator * iterator);
603 
609 void AwaResourceDefinitionIterator_Free(AwaResourceDefinitionIterator ** iterator);
610 
611 
612 /**************************************************************************************************
613  * Utility Functions
614  *************************************************************************************************/
615 
616 // Path Iterator
617 typedef struct _AwaPathIterator AwaPathIterator;
618 
626 bool AwaPathIterator_Next(AwaPathIterator * iterator);
627 
635 const char * AwaPathIterator_Get(const AwaPathIterator * iterator);
636 
642 void AwaPathIterator_Free(AwaPathIterator ** iterator);
643 
653 AwaError AwaAPI_MakeObjectPath(char * path, size_t pathSize, AwaObjectID objectID);
654 
665 AwaError AwaAPI_MakeObjectInstancePath(char * path, size_t pathSize, AwaObjectID objectID, AwaObjectInstanceID objectInstanceID);
666 
678 AwaError AwaAPI_MakeResourcePath(char * path, size_t pathSize, AwaObjectID objectID, AwaObjectInstanceID objectInstanceID, AwaResourceID resourceID);
679 
691 AwaError AwaAPI_MakePath(char * path, size_t pathSize, AwaObjectID objectID, AwaObjectInstanceID objectInstanceID, AwaResourceID resourceID);
692 
699 bool AwaAPI_IsPathValid(const char * path);
700 
701 
702 // Encapsulates Execute arguments
703 typedef AwaOpaque AwaExecuteArguments;
704 
705 
706 /**************************************************************************************************
707  * Response Functions
708  *************************************************************************************************/
709 
710 typedef struct _AwaPathResult AwaPathResult;
711 
719 AwaError AwaPathResult_GetError(const AwaPathResult * result);
720 
727 AwaLWM2MError AwaPathResult_GetLWM2MError(const AwaPathResult * result);
728 
729 
730 /**************************************************************************************************
731  * ChangeSet Functions for Change Subscriptions and Observations
732  *************************************************************************************************/
733 
734 typedef struct _AwaChangeSet AwaChangeSet;
735 
745 AwaPathIterator * AwaChangeSet_NewPathIterator(const AwaChangeSet * changeSet);
746 
754 AwaChangeType AwaChangeSet_GetChangeType(const AwaChangeSet * changeSet, const char * path);
755 
765 bool AwaChangeSet_HasValue(const AwaChangeSet * changeSet, const char * path);
766 
775 bool AwaChangeSet_ContainsPath(const AwaChangeSet * changeSet, const char * path);
776 
784 AwaResourceType AwaChangeSet_GetResourceType(const AwaChangeSet * changeSet, const char * path);
785 
803 AwaError AwaChangeSet_GetValueAsCStringPointer (const AwaChangeSet * changeSet, const char * path, const char ** value);
804 AwaError AwaChangeSet_GetValueAsIntegerPointer (const AwaChangeSet * changeSet, const char * path, const AwaInteger ** value);
805 AwaError AwaChangeSet_GetValueAsFloatPointer (const AwaChangeSet * changeSet, const char * path, const AwaFloat ** value);
806 AwaError AwaChangeSet_GetValueAsBooleanPointer (const AwaChangeSet * changeSet, const char * path, const AwaBoolean ** value);
807 AwaError AwaChangeSet_GetValueAsTimePointer (const AwaChangeSet * changeSet, const char * path, const AwaTime ** value);
808 AwaError AwaChangeSet_GetValueAsObjectLinkPointer(const AwaChangeSet * changeSet, const char * path, const AwaObjectLink ** value);
809 AwaError AwaChangeSet_GetValueAsOpaquePointer (const AwaChangeSet * changeSet, const char * path, const AwaOpaque ** value);
829 AwaError AwaChangeSet_GetValueAsOpaque (const AwaChangeSet * changeSet, const char * path, AwaOpaque * value);
830 
845 AwaError AwaChangeSet_GetValueAsObjectLink (const AwaChangeSet * changeSet, const char * path, AwaObjectLink * value);
846 
865 AwaError AwaChangeSet_GetValuesAsStringArrayPointer (const AwaChangeSet * changeSet, const char * path, const AwaStringArray ** valueArray);
866 AwaError AwaChangeSet_GetValuesAsIntegerArrayPointer (const AwaChangeSet * changeSet, const char * path, const AwaIntegerArray ** valueArray);
867 AwaError AwaChangeSet_GetValuesAsFloatArrayPointer (const AwaChangeSet * changeSet, const char * path, const AwaFloatArray ** valueArray);
868 AwaError AwaChangeSet_GetValuesAsBooleanArrayPointer (const AwaChangeSet * changeSet, const char * path, const AwaBooleanArray ** valueArray);
869 AwaError AwaChangeSet_GetValuesAsTimeArrayPointer (const AwaChangeSet * changeSet, const char * path, const AwaTimeArray ** valueArray);
870 AwaError AwaChangeSet_GetValuesAsOpaqueArrayPointer (const AwaChangeSet * changeSet, const char * path, const AwaOpaqueArray ** valueArray);
871 AwaError AwaChangeSet_GetValuesAsObjectLinkArrayPointer(const AwaChangeSet * changeSet, const char * path, const AwaObjectLinkArray ** valueArray);
875 /**************************************************************************************************
876  * Logging
877  *************************************************************************************************/
878 
884 AwaLogLevel AwaLog_SetLevel(AwaLogLevel level);
885 
886 
887 #ifdef __cplusplus
888 }
889 #endif
890 
891 #endif // AWA_COMMON_H
892 
AwaOpaqueArrayIterator
struct _AwaOpaqueArrayIterator AwaOpaqueArrayIterator
Definition: common.h:110
AwaError
AwaError
API Error Codes.
Definition: error.h:38
AwaOpaqueArray_New
AwaOpaqueArray * AwaOpaqueArray_New(void)
AwaPathResult
struct _AwaPathResult AwaPathResult
Definition: common.h:710
AwaResourceDefinition_GetType
AwaResourceType AwaResourceDefinition_GetType(const AwaResourceDefinition *resourceDefinition)
Retrieve the resource type of a Resource Definition.
AwaObjectLinkArrayIterator_Free
void AwaObjectLinkArrayIterator_Free(AwaObjectLinkArrayIterator **iterator)
AwaObjectDefinition_GetID
AwaObjectID AwaObjectDefinition_GetID(const AwaObjectDefinition *objectDefinition)
Retrieve the unique ID of an Object Definition.
AwaTimeArray_IsValid
bool AwaTimeArray_IsValid(const AwaTimeArray *array, AwaArrayIndex index)
AwaBooleanArrayIterator
struct _AwaBooleanArrayIterator AwaBooleanArrayIterator
Definition: common.h:109
types.h
Provides definitions for types and enums used by Awa LWM2M API and Static API.
AwaObjectDefinition_AddResourceDefinitionAsFloatArray
AwaError AwaObjectDefinition_AddResourceDefinitionAsFloatArray(AwaObjectDefinition *objectDefinition, AwaResourceID resourceID, const char *resourceName, int minimumInstances, int maximumInstances, AwaResourceOperations operations, const AwaFloatArray *defaultArray)
AwaIntegerArray_SetValue
void AwaIntegerArray_SetValue(AwaIntegerArray *array, AwaArrayIndex index, AwaInteger value)
AwaObjectDefinition_Free
void AwaObjectDefinition_Free(AwaObjectDefinition **objectDefinition)
Clean up an Object Definition, freeing all allocated resources.
AwaChangeSet_GetValueAsObjectLink
AwaError AwaChangeSet_GetValueAsObjectLink(const AwaChangeSet *changeSet, const char *path, AwaObjectLink *value)
Retrieve an object link resource&#39;s value from a ChangeSet.
AwaBooleanArray_NewBooleanArrayIterator
AwaBooleanArrayIterator * AwaBooleanArray_NewBooleanArrayIterator(const AwaBooleanArray *array)
AwaAPI_MakeObjectPath
AwaError AwaAPI_MakeObjectPath(char *path, size_t pathSize, AwaObjectID objectID)
Construct a path from an object ID.
AwaObjectDefinition_AddResourceDefinitionAsTimeArray
AwaError AwaObjectDefinition_AddResourceDefinitionAsTimeArray(AwaObjectDefinition *objectDefinition, AwaResourceID resourceID, const char *resourceName, int minimumInstances, int maximumInstances, AwaResourceOperations operations, const AwaTimeArray *defaultArray)
AwaTimeout
int AwaTimeout
Represents a timeout value, in milliseconds.
Definition: common.h:70
AwaBooleanArray_New
AwaBooleanArray * AwaBooleanArray_New(void)
AwaAPI_MakeResourcePath
AwaError AwaAPI_MakeResourcePath(char *path, size_t pathSize, AwaObjectID objectID, AwaObjectInstanceID objectInstanceID, AwaResourceID resourceID)
Construct a path from an object, object instance, and resource ID.
AwaObjectDefinition_AddResourceDefinitionAsObjectLinkArray
AwaError AwaObjectDefinition_AddResourceDefinitionAsObjectLinkArray(AwaObjectDefinition *objectDefinition, AwaResourceID resourceID, const char *resourceName, int minimumInstances, int maximumInstances, AwaResourceOperations operations, const AwaObjectLinkArray *defaultArray)
AwaIntegerArrayIterator_GetValue
AwaInteger AwaIntegerArrayIterator_GetValue(const AwaIntegerArrayIterator *iterator)
AwaBooleanArray
struct _AwaBooleanArray AwaBooleanArray
Definition: common.h:100
AwaOpaqueArray_IsValid
bool AwaOpaqueArray_IsValid(const AwaOpaqueArray *array, AwaArrayIndex index)
AwaObjectDefinition_AddResourceDefinitionAsInteger
AwaError AwaObjectDefinition_AddResourceDefinitionAsInteger(AwaObjectDefinition *objectDefinition, AwaResourceID resourceID, const char *resourceName, bool isMandatory, AwaResourceOperations operations, AwaInteger defaultValue)
AwaTimeArrayIterator_Free
void AwaTimeArrayIterator_Free(AwaTimeArrayIterator **iterator)
AwaOpaqueArray_GetValueCount
size_t AwaOpaqueArray_GetValueCount(const AwaOpaqueArray *array)
AwaIntegerArrayIterator_Next
bool AwaIntegerArrayIterator_Next(AwaIntegerArrayIterator *iterator)
AwaStringArray_NewCStringArrayIterator
AwaCStringArrayIterator * AwaStringArray_NewCStringArrayIterator(const AwaStringArray *array)
AwaChangeType_ResourceModified
indicates a resource was modified on the specified path
Definition: common.h:56
AwaOpaqueArrayIterator_Next
bool AwaOpaqueArrayIterator_Next(AwaOpaqueArrayIterator *iterator)
AwaIntegerArray
struct _AwaIntegerArray AwaIntegerArray
Definition: common.h:98
AwaOpaqueArray_DeleteValue
void AwaOpaqueArray_DeleteValue(AwaOpaqueArray *array, AwaArrayIndex index)
AwaPathIterator_Get
const char * AwaPathIterator_Get(const AwaPathIterator *iterator)
Retrieve the current path from a Path Iterator.
AwaObjectDefinition_GetName
const char * AwaObjectDefinition_GetName(const AwaObjectDefinition *objectDefinition)
Retrieve the name of an Object Definition.
AwaChangeType_ResourceCreated
indicates a resource was created on the specified path
Definition: common.h:55
AwaFloatArrayIterator_GetValue
AwaFloat AwaFloatArrayIterator_GetValue(const AwaFloatArrayIterator *iterator)
AwaSubscribeType_Execute
Definition: common.h:79
AwaArrayLength
size_t AwaArrayLength
Represents a multiple-instance array length value.
Definition: common.h:94
AwaObjectDefinition_AddResourceDefinitionAsOpaque
AwaError AwaObjectDefinition_AddResourceDefinitionAsOpaque(AwaObjectDefinition *objectDefinition, AwaResourceID resourceID, const char *resourceName, bool isMandatory, AwaResourceOperations operations, AwaOpaque defaultValue)
AwaResourceDefinition_IsMandatory
bool AwaResourceDefinition_IsMandatory(const AwaResourceDefinition *resourceDefinition)
Determine whether or not a Resource Definition is mandatory.
AwaChangeSet_GetValueAsOpaque
AwaError AwaChangeSet_GetValueAsOpaque(const AwaChangeSet *changeSet, const char *path, AwaOpaque *value)
Retrieve an opaque resource&#39;s value from a ChangeSet.
AwaBooleanArrayIterator_GetValue
AwaBoolean AwaBooleanArrayIterator_GetValue(const AwaBooleanArrayIterator *iterator)
AwaFloatArray
struct _AwaFloatArray AwaFloatArray
Definition: common.h:99
AwaPathIterator_Next
bool AwaPathIterator_Next(AwaPathIterator *iterator)
Determine whether the Path Iterator has not reached the end of a set of paths.
AwaIntegerArrayIterator_GetIndex
AwaArrayIndex AwaIntegerArrayIterator_GetIndex(const AwaIntegerArrayIterator *iterator)
AwaOpaqueArrayIterator_GetValue
AwaOpaque AwaOpaqueArrayIterator_GetValue(const AwaOpaqueArrayIterator *iterator)
AwaObjectLinkArray_GetValueCount
size_t AwaObjectLinkArray_GetValueCount(const AwaObjectLinkArray *array)
AwaResourceDefinition_GetName
const char * AwaResourceDefinition_GetName(const AwaResourceDefinition *resourceDefinition)
Retrieve the name of a Resource Definition.
AwaObjectDefinition_AddResourceDefinitionAsFloat
AwaError AwaObjectDefinition_AddResourceDefinitionAsFloat(AwaObjectDefinition *objectDefinition, AwaResourceID resourceID, const char *resourceName, bool isMandatory, AwaResourceOperations operations, AwaFloat defaultValue)
AwaOpaqueArrayIterator_GetIndex
AwaArrayIndex AwaOpaqueArrayIterator_GetIndex(const AwaOpaqueArrayIterator *iterator)
AwaOpaqueArray
struct _AwaOpaqueArray AwaOpaqueArray
Definition: common.h:101
AwaIntegerArray_GetValue
AwaInteger AwaIntegerArray_GetValue(const AwaIntegerArray *array, AwaArrayIndex index)
AwaChangeSet_GetValuesAsBooleanArrayPointer
AwaError AwaChangeSet_GetValuesAsBooleanArrayPointer(const AwaChangeSet *changeSet, const char *path, const AwaBooleanArray **valueArray)
AwaChangeType_ObjectInstanceCreated
indicates an object instance was created on the specified path
Definition: common.h:59
AwaChangeType_ResourceDeleted
indicates a resource was deleted on the specified path
Definition: common.h:57
AwaChangeType_ObjectInstanceDeleted
indicates an object instance was deleted on the specified path
Definition: common.h:61
AwaLog_SetLevel
AwaLogLevel AwaLog_SetLevel(AwaLogLevel level)
Set the current API log level.
AwaIntegerArrayIterator
struct _AwaIntegerArrayIterator AwaIntegerArrayIterator
Definition: common.h:107
AwaStringArray_IsValid
bool AwaStringArray_IsValid(const AwaStringArray *array, AwaArrayIndex index)
AwaChangeSet_GetValueAsCStringPointer
AwaError AwaChangeSet_GetValueAsCStringPointer(const AwaChangeSet *changeSet, const char *path, const char **value)
AwaIntegerArray_Free
void AwaIntegerArray_Free(AwaIntegerArray **array)
AwaFloatArrayIterator_GetIndex
AwaArrayIndex AwaFloatArrayIterator_GetIndex(const AwaFloatArrayIterator *iterator)
AwaBoolean
bool AwaBoolean
Corresponds to the LWM2M Boolean type.
Definition: types.h:71
AwaObjectDefinitionIterator_Free
void AwaObjectDefinitionIterator_Free(AwaObjectDefinitionIterator **iterator)
Clean up an Object Definition iterator, freeing all allocated resources.
AwaObjectDefinition_AddResourceDefinitionAsObjectLink
AwaError AwaObjectDefinition_AddResourceDefinitionAsObjectLink(AwaObjectDefinition *objectDefinition, AwaResourceID resourceID, const char *resourceName, bool isMandatory, AwaResourceOperations operations, AwaObjectLink defaultValue)
AwaIntegerArray_DeleteValue
void AwaIntegerArray_DeleteValue(AwaIntegerArray *array, AwaArrayIndex index)
AwaTimeArray_GetValue
AwaTime AwaTimeArray_GetValue(const AwaTimeArray *array, AwaArrayIndex index)
AwaTimeArrayIterator_GetValue
AwaTime AwaTimeArrayIterator_GetValue(const AwaTimeArrayIterator *iterator)
AwaObjectLinkArray_NewObjectLinkArrayIterator
AwaObjectLinkArrayIterator * AwaObjectLinkArray_NewObjectLinkArrayIterator(const AwaObjectLinkArray *array)
AwaObjectDefinition_IsResourceDefined
bool AwaObjectDefinition_IsResourceDefined(const AwaObjectDefinition *objectDefinition, AwaResourceID resourceID)
Determine whether a Resource Definition exists within an Object Definition for the specified ID...
AwaObjectLinkArray_DeleteValue
void AwaObjectLinkArray_DeleteValue(AwaObjectLinkArray *array, AwaArrayIndex index)
AwaBooleanArrayIterator_Free
void AwaBooleanArrayIterator_Free(AwaBooleanArrayIterator **iterator)
AwaFloatArray_New
AwaFloatArray * AwaFloatArray_New(void)
AwaFloatArray_DeleteValue
void AwaFloatArray_DeleteValue(AwaFloatArray *array, AwaArrayIndex index)
error.h
Provides definitions for Awa LWM2M Client and Server API error codes and error function declarations...
AwaAPI_MakeObjectInstancePath
AwaError AwaAPI_MakeObjectInstancePath(char *path, size_t pathSize, AwaObjectID objectID, AwaObjectInstanceID objectInstanceID)
Construct a path from an object and object instance ID.
AwaFloatArray_Free
void AwaFloatArray_Free(AwaFloatArray **array)
AwaChangeSet_GetValuesAsTimeArrayPointer
AwaError AwaChangeSet_GetValuesAsTimeArrayPointer(const AwaChangeSet *changeSet, const char *path, const AwaTimeArray **valueArray)
AwaTimeArray_Free
void AwaTimeArray_Free(AwaTimeArray **array)
AwaBooleanArray_SetValue
void AwaBooleanArray_SetValue(AwaBooleanArray *array, AwaArrayIndex index, AwaBoolean value)
AwaPathResult_GetError
AwaError AwaPathResult_GetError(const AwaPathResult *result)
Retrieve an error from a Path Result.
AwaOpaque
A utility struct used to convey data pointer and size of an opaque data block.
Definition: types.h:81
AwaBooleanArray_IsValid
bool AwaBooleanArray_IsValid(const AwaBooleanArray *array, AwaArrayIndex index)
AwaCStringArrayIterator_Free
void AwaCStringArrayIterator_Free(AwaCStringArrayIterator **iterator)
AwaStringArray_DeleteValue
void AwaStringArray_DeleteValue(AwaStringArray *array, AwaArrayIndex index)
AwaStringArray_GetValueAsCString
const char * AwaStringArray_GetValueAsCString(const AwaStringArray *array, AwaArrayIndex index)
AwaChangeSet_GetResourceType
AwaResourceType AwaChangeSet_GetResourceType(const AwaChangeSet *changeSet, const char *path)
Get the resource type for the specified change.
AwaChangeSet_GetValueAsObjectLinkPointer
AwaError AwaChangeSet_GetValueAsObjectLinkPointer(const AwaChangeSet *changeSet, const char *path, const AwaObjectLink **value)
AwaObjectLinkArray_New
AwaObjectLinkArray * AwaObjectLinkArray_New(void)
AwaResourceDefinitionIterator_Free
void AwaResourceDefinitionIterator_Free(AwaResourceDefinitionIterator **iterator)
Clean up an Resource Definition iterator, freeing all allocated resources.
AwaTimeArray
struct _AwaTimeArray AwaTimeArray
Definition: common.h:102
AwaStringArray_New
AwaStringArray * AwaStringArray_New(void)
AwaObjectInstanceID
int AwaObjectInstanceID
Definition: types.h:44
AwaArrayIndex
size_t AwaArrayIndex
Represents a multiple-instance array index value.
Definition: common.h:89
AwaTimeArrayIterator
struct _AwaTimeArrayIterator AwaTimeArrayIterator
Definition: common.h:111
AwaObjectDefinition_AddResourceDefinitionAsOpaqueArray
AwaError AwaObjectDefinition_AddResourceDefinitionAsOpaqueArray(AwaObjectDefinition *objectDefinition, AwaResourceID resourceID, const char *resourceName, int minimumInstances, int maximumInstances, AwaResourceOperations operations, const AwaOpaqueArray *defaultArray)
AwaChangeType
AwaChangeType
Supported change types for a change subscription.
Definition: common.h:51
AwaObjectLinkArrayIterator_Next
bool AwaObjectLinkArrayIterator_Next(AwaObjectLinkArrayIterator *iterator)
AwaChangeSet
struct _AwaChangeSet AwaChangeSet
Definition: common.h:734
AwaResourceDefinitionIterator
struct _AwaResourceDefinitionIterator AwaResourceDefinitionIterator
Definition: common.h:349
AwaResourceOperations
AwaResourceOperations
Supported resource operations for management servers.
Definition: types.h:133
AwaBooleanArrayIterator_Next
bool AwaBooleanArrayIterator_Next(AwaBooleanArrayIterator *iterator)
AwaBooleanArrayIterator_GetIndex
AwaArrayIndex AwaBooleanArrayIterator_GetIndex(const AwaBooleanArrayIterator *iterator)
AwaChangeSet_HasValue
bool AwaChangeSet_HasValue(const AwaChangeSet *changeSet, const char *path)
Test if the ChangeSet has a value for the specified resource path.
AwaBooleanArray_Free
void AwaBooleanArray_Free(AwaBooleanArray **array)
AwaStringArray_Free
void AwaStringArray_Free(AwaStringArray **array)
AwaChangeSet_GetValuesAsOpaqueArrayPointer
AwaError AwaChangeSet_GetValuesAsOpaqueArrayPointer(const AwaChangeSet *changeSet, const char *path, const AwaOpaqueArray **valueArray)
AwaIntegerArray_New
AwaIntegerArray * AwaIntegerArray_New(void)
AwaStringArray_GetValueCount
size_t AwaStringArray_GetValueCount(const AwaStringArray *array)
AwaChangeSet_GetChangeType
AwaChangeType AwaChangeSet_GetChangeType(const AwaChangeSet *changeSet, const char *path)
Retrieve the change type for a specified path in a ChangeSet.
AwaCStringArrayIterator_GetValueAsCString
const char * AwaCStringArrayIterator_GetValueAsCString(const AwaCStringArrayIterator *iterator)
AwaIntegerArray_GetValueCount
size_t AwaIntegerArray_GetValueCount(const AwaIntegerArray *array)
AwaResourceDefinitionIterator_Next
bool AwaResourceDefinitionIterator_Next(AwaResourceDefinitionIterator *iterator)
Determine whether the Resource Definition iterator has not reached the end of a set of Resource Defin...
AwaTimeArray_New
AwaTimeArray * AwaTimeArray_New(void)
AwaObjectDefinition_AddResourceDefinitionAsBoolean
AwaError AwaObjectDefinition_AddResourceDefinitionAsBoolean(AwaObjectDefinition *objectDefinition, AwaResourceID resourceID, const char *resourceName, bool isMandatory, AwaResourceOperations operations, AwaBoolean defaultValue)
AwaFloatArray_GetValue
AwaFloat AwaFloatArray_GetValue(const AwaFloatArray *array, AwaArrayIndex index)
AwaSubscribeType_None
Definition: common.h:77
AwaObjectDefinitionIterator
struct _AwaObjectDefinitionIterator AwaObjectDefinitionIterator
Definition: common.h:348
AwaChangeSet_GetValuesAsObjectLinkArrayPointer
AwaError AwaChangeSet_GetValuesAsObjectLinkArrayPointer(const AwaChangeSet *changeSet, const char *path, const AwaObjectLinkArray **valueArray)
AwaIntegerArray_NewIntegerArrayIterator
AwaIntegerArrayIterator * AwaIntegerArray_NewIntegerArrayIterator(const AwaIntegerArray *array)
AwaObjectDefinition_New
AwaObjectDefinition * AwaObjectDefinition_New(AwaObjectID objectID, const char *objectName, int minimumInstances, int maximumInstances)
Define object metadata against an Object ID.
AwaObjectDefinition_AddResourceDefinitionAsBooleanArray
AwaError AwaObjectDefinition_AddResourceDefinitionAsBooleanArray(AwaObjectDefinition *objectDefinition, AwaResourceID resourceID, const char *resourceName, int minimumInstances, int maximumInstances, AwaResourceOperations operations, const AwaBooleanArray *defaultArray)
AwaObjectDefinition_NewResourceDefinitionIterator
AwaResourceDefinitionIterator * AwaObjectDefinition_NewResourceDefinitionIterator(const AwaObjectDefinition *objectDefinition)
Retrieves a new Resource Definition iterator that can be used to iterate through the set of defined r...
AwaOpaqueArray_Free
void AwaOpaqueArray_Free(AwaOpaqueArray **array)
AwaChangeSet_GetValuesAsStringArrayPointer
AwaError AwaChangeSet_GetValuesAsStringArrayPointer(const AwaChangeSet *changeSet, const char *path, const AwaStringArray **valueArray)
AwaChangeSet_GetValuesAsIntegerArrayPointer
AwaError AwaChangeSet_GetValuesAsIntegerArrayPointer(const AwaChangeSet *changeSet, const char *path, const AwaIntegerArray **valueArray)
AwaBooleanArray_GetValueCount
size_t AwaBooleanArray_GetValueCount(const AwaBooleanArray *array)
AwaChangeSet_NewPathIterator
AwaPathIterator * AwaChangeSet_NewPathIterator(const AwaChangeSet *changeSet)
Create a new Path Iterator for a ChangeSet, used to iterate through the list of resource paths retrie...
AwaBooleanArray_DeleteValue
void AwaBooleanArray_DeleteValue(AwaBooleanArray *array, AwaArrayIndex index)
AwaChangeType_ObjectInstanceModified
indicates an object instance was modified on the specified path
Definition: common.h:60
AwaPathIterator_Free
void AwaPathIterator_Free(AwaPathIterator **iterator)
Clean up a Path Iterator, freeing all allocated resources.
AwaChangeType_Current
TODO: indicates the current value of an object instance or resource on the specified path on subscrip...
Definition: common.h:63
AwaObjectLinkArray_Free
void AwaObjectLinkArray_Free(AwaObjectLinkArray **array)
AwaTimeArray_GetValueCount
size_t AwaTimeArray_GetValueCount(const AwaTimeArray *array)
AwaResourceDefinition_GetMinimumInstances
int AwaResourceDefinition_GetMinimumInstances(const AwaResourceDefinition *resourceDefinition)
Retrieve the minimum number of instances which can be created for an Resource Definition.
AwaChangeSet_GetValueAsTimePointer
AwaError AwaChangeSet_GetValueAsTimePointer(const AwaChangeSet *changeSet, const char *path, const AwaTime **value)
AwaExecuteArguments
AwaOpaque AwaExecuteArguments
Definition: common.h:703
AwaFloatArray_SetValue
void AwaFloatArray_SetValue(AwaFloatArray *array, AwaArrayIndex index, AwaFloat value)
AwaFloat
double AwaFloat
Corresponds to the LWM2M Float type.
Definition: types.h:66
AwaOpaqueArray_GetValue
AwaOpaque AwaOpaqueArray_GetValue(const AwaOpaqueArray *array, AwaArrayIndex index)
AwaBooleanArray_GetValue
AwaBoolean AwaBooleanArray_GetValue(const AwaBooleanArray *array, AwaArrayIndex index)
AwaObjectDefinition_GetMinimumInstances
int AwaObjectDefinition_GetMinimumInstances(const AwaObjectDefinition *objectDefinition)
Retrieve the minimum number of instances which can be created for an Object Definition.
AwaObjectDefinition
struct _ObjectDefinition AwaObjectDefinition
Definition: common.h:346
AwaObjectLinkArrayIterator_GetValue
AwaObjectLink AwaObjectLinkArrayIterator_GetValue(const AwaObjectLinkArrayIterator *iterator)
AwaStringArray_SetValueAsCString
void AwaStringArray_SetValueAsCString(AwaStringArray *array, AwaArrayIndex index, const char *value)
AwaStringArray
struct _AwaStringArray AwaStringArray
Definition: common.h:97
AwaObjectID
int AwaObjectID
Definition: types.h:43
AwaResourceDefinition_GetMaximumInstances
int AwaResourceDefinition_GetMaximumInstances(const AwaResourceDefinition *resourceDefinition)
Retrieve the maximum number of instances which can be created for an Resource Definition.
AwaObjectDefinition_AddResourceDefinitionAsNoType
AwaError AwaObjectDefinition_AddResourceDefinitionAsNoType(AwaObjectDefinition *objectDefinition, AwaResourceID resourceID, const char *resourceName, bool isMandatory, AwaResourceOperations operations)
Add a Resource Definition to an existing Object Definition.
AwaTimeArrayIterator_Next
bool AwaTimeArrayIterator_Next(AwaTimeArrayIterator *iterator)
AwaObjectDefinitionIterator_Get
const AwaObjectDefinition * AwaObjectDefinitionIterator_Get(const AwaObjectDefinitionIterator *iterator)
Retrieve the current Object Definition from an Object Definition iterator.
AwaOpaqueArray_NewOpaqueArrayIterator
AwaOpaqueArrayIterator * AwaOpaqueArray_NewOpaqueArrayIterator(const AwaOpaqueArray *array)
AwaTimeArrayIterator_GetIndex
AwaArrayIndex AwaTimeArrayIterator_GetIndex(const AwaTimeArrayIterator *iterator)
AwaObjectDefinition_AddResourceDefinitionAsTime
AwaError AwaObjectDefinition_AddResourceDefinitionAsTime(AwaObjectDefinition *objectDefinition, AwaResourceID resourceID, const char *resourceName, bool isMandatory, AwaResourceOperations operations, AwaTime defaultValue)
AwaOpaqueArray_SetValue
void AwaOpaqueArray_SetValue(AwaOpaqueArray *array, AwaArrayIndex index, AwaOpaque value)
AwaCStringArrayIterator
struct _AwaCStringArrayIterator AwaCStringArrayIterator
Definition: common.h:106
AwaLogLevel
AwaLogLevel
Supported log levels for a log command.
Definition: types.h:150
AwaObjectLinkArray_SetValue
void AwaObjectLinkArray_SetValue(AwaObjectLinkArray *array, AwaArrayIndex index, AwaObjectLink value)
AwaResourceID
int AwaResourceID
Definition: types.h:45
AwaResourceDefinition_GetSupportedOperations
AwaResourceOperations AwaResourceDefinition_GetSupportedOperations(const AwaResourceDefinition *resourceDefinition)
Retrieve the supported operations for an Resource Definition.
AwaTimeArray_NewTimeArrayIterator
AwaTimeArrayIterator * AwaTimeArray_NewTimeArrayIterator(const AwaTimeArray *array)
AwaCStringArrayIterator_Next
bool AwaCStringArrayIterator_Next(AwaCStringArrayIterator *iterator)
AwaChangeType_Invalid
indicates an invalid change type for the specified path
Definition: common.h:53
AwaAPI_IsPathValid
bool AwaAPI_IsPathValid(const char *path)
Check if a path string conforms to the valid path syntax.
AwaIntegerArray_IsValid
bool AwaIntegerArray_IsValid(const AwaIntegerArray *array, AwaArrayIndex index)
AwaSubscribeType
AwaSubscribeType
Supported subscribe types.
Definition: common.h:75
AwaFloatArrayIterator_Next
bool AwaFloatArrayIterator_Next(AwaFloatArrayIterator *iterator)
AwaChangeSet_GetValueAsIntegerPointer
AwaError AwaChangeSet_GetValueAsIntegerPointer(const AwaChangeSet *changeSet, const char *path, const AwaInteger **value)
AwaObjectLinkArray_GetValue
AwaObjectLink AwaObjectLinkArray_GetValue(const AwaObjectLinkArray *array, AwaArrayIndex index)
AwaObjectDefinition_GetResourceDefinition
const AwaResourceDefinition * AwaObjectDefinition_GetResourceDefinition(const AwaObjectDefinition *objectDefinition, AwaResourceID resourceID)
Retrieve a Resource Definition from an Object Definition using a resource ID.
AwaObjectLinkArray_IsValid
bool AwaObjectLinkArray_IsValid(const AwaObjectLinkArray *array, AwaArrayIndex index)
AwaInteger
int64_t AwaInteger
Corresponds to the LWM2M 64-bit Integer type.
Definition: types.h:61
AwaObjectDefinition_AddResourceDefinitionAsIntegerArray
AwaError AwaObjectDefinition_AddResourceDefinitionAsIntegerArray(AwaObjectDefinition *objectDefinition, AwaResourceID resourceID, const char *resourceName, int minimumInstances, int maximumInstances, AwaResourceOperations operations, const AwaIntegerArray *defaultArray)
AwaChangeSet_ContainsPath
bool AwaChangeSet_ContainsPath(const AwaChangeSet *changeSet, const char *path)
Test if the ChangeSet has the specified path (resource, object instance or object) present...
AwaObjectLinkArray
struct _AwaObjectLinkArray AwaObjectLinkArray
Definition: common.h:103
AwaFloatArray_GetValueCount
size_t AwaFloatArray_GetValueCount(const AwaFloatArray *array)
AwaTimeArray_DeleteValue
void AwaTimeArray_DeleteValue(AwaTimeArray *array, AwaArrayIndex index)
AwaObjectDefinitionIterator_Next
bool AwaObjectDefinitionIterator_Next(AwaObjectDefinitionIterator *iterator)
Determine whether the Object Definition iterator has not reached the end of a set of Object Definitio...
AwaResourceType
AwaResourceType
Supported resource types.
Definition: types.h:101
AwaChangeSet_GetValueAsOpaquePointer
AwaError AwaChangeSet_GetValueAsOpaquePointer(const AwaChangeSet *changeSet, const char *path, const AwaOpaque **value)
AwaObjectDefinition_AddResourceDefinitionAsStringArray
AwaError AwaObjectDefinition_AddResourceDefinitionAsStringArray(AwaObjectDefinition *objectDefinition, AwaResourceID resourceID, const char *resourceName, int minimumInstances, int maximumInstances, AwaResourceOperations operations, const AwaStringArray *defaultArray)
AwaResourceDefinitionIterator_Get
const AwaResourceDefinition * AwaResourceDefinitionIterator_Get(const AwaResourceDefinitionIterator *iterator)
Retrieve the current Resource Definition from an Resource Definition iterator.
AwaCStringArrayIterator_GetIndex
AwaArrayIndex AwaCStringArrayIterator_GetIndex(const AwaCStringArrayIterator *iterator)
AwaPathResult_GetLWM2MError
AwaLWM2MError AwaPathResult_GetLWM2MError(const AwaPathResult *result)
Retrieve a LWM2M error from a Path Result.
AwaTimeArray_SetValue
void AwaTimeArray_SetValue(AwaTimeArray *array, AwaArrayIndex index, AwaTime value)
AwaResourceDefinition_GetID
AwaResourceID AwaResourceDefinition_GetID(const AwaResourceDefinition *resourceDefinition)
Retrieve the unique ID of a Resource Definition.
AwaTime
int64_t AwaTime
Corresponds to the LWM2M Time type.
Definition: types.h:76
AwaChangeSet_GetValueAsFloatPointer
AwaError AwaChangeSet_GetValueAsFloatPointer(const AwaChangeSet *changeSet, const char *path, const AwaFloat **value)
AwaFloatArrayIterator
struct _AwaFloatArrayIterator AwaFloatArrayIterator
Definition: common.h:108
AwaObjectLinkArrayIterator
struct _AwaObjectLinkArrayIterator AwaObjectLinkArrayIterator
Definition: common.h:112
AwaObjectLinkArrayIterator_GetIndex
AwaArrayIndex AwaObjectLinkArrayIterator_GetIndex(const AwaObjectLinkArrayIterator *iterator)
AwaFloatArray_NewFloatArrayIterator
AwaFloatArrayIterator * AwaFloatArray_NewFloatArrayIterator(const AwaFloatArray *array)
AwaChangeSet_GetValuesAsFloatArrayPointer
AwaError AwaChangeSet_GetValuesAsFloatArrayPointer(const AwaChangeSet *changeSet, const char *path, const AwaFloatArray **valueArray)
AwaChangeSet_GetValueAsBooleanPointer
AwaError AwaChangeSet_GetValueAsBooleanPointer(const AwaChangeSet *changeSet, const char *path, const AwaBoolean **value)
AwaFloatArrayIterator_Free
void AwaFloatArrayIterator_Free(AwaFloatArrayIterator **iterator)
AwaPathIterator
struct _AwaPathIterator AwaPathIterator
Definition: common.h:617
AwaFloatArray_IsValid
bool AwaFloatArray_IsValid(const AwaFloatArray *array, AwaArrayIndex index)
AwaLWM2MError
AwaLWM2MError
Definition: error.h:93
AwaIntegerArrayIterator_Free
void AwaIntegerArrayIterator_Free(AwaIntegerArrayIterator **iterator)
AwaAPI_MakePath
AwaError AwaAPI_MakePath(char *path, size_t pathSize, AwaObjectID objectID, AwaObjectInstanceID objectInstanceID, AwaResourceID resourceID)
Construct a path from an object, object instance, and resource ID.
AwaObjectDefinition_AddResourceDefinitionAsString
AwaError AwaObjectDefinition_AddResourceDefinitionAsString(AwaObjectDefinition *objectDefinition, AwaResourceID resourceID, const char *resourceName, bool isMandatory, AwaResourceOperations operations, const char *defaultValue)
AwaSubscribeType_Change
Definition: common.h:78
AwaObjectDefinition_GetMaximumInstances
int AwaObjectDefinition_GetMaximumInstances(const AwaObjectDefinition *objectDefinition)
Retrieve the maximum number of instances which can be created for an Object Definition.
AwaOpaqueArrayIterator_Free
void AwaOpaqueArrayIterator_Free(AwaOpaqueArrayIterator **iterator)
AwaResourceDefinition
struct _ResourceDefinition AwaResourceDefinition
Definition: common.h:347
Copyright (c) 2016, Imagination Technologies Limited
Generated on Thu Apr 27 2017 15:11:51 for Awa LWM2M C API by   doxygen 1.8.11