resource/csdk/stack/include/ocpayload.h

   1 //******************************************************************
   2 //
   3 // Copyright 2015 Intel Mobile Communications GmbH All Rights Reserved.
   4 //
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   6 //
   7 // Licensed under the Apache License, Version 2.0 (the "License");
   8 // you may not use this file except in compliance with the License.
   9 // You may obtain a copy of the License at
  10 //
  11 //      http://www.apache.org/licenses/LICENSE-2.0
  12 //
  13 // Unless required by applicable law or agreed to in writing, software
  14 // distributed under the License is distributed on an "AS IS" BASIS,
  15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16 // See the License for the specific language governing permissions and
  17 // limitations under the License.
  18 //
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  20
  21 #ifndef OCPAYLOAD_H_
  22 #define OCPAYLOAD_H_
  23
  24 #include <stdbool.h>
  25 #include <inttypes.h>
  26 #include "octypes.h"
  27
  28 #ifdef WITH_RD
  29 #include "rd_payload.h"
  30 #endif
  31
  32 #ifdef __cplusplus
  33 extern "C"
  34 {
  35 #endif
  36
  37 typedef struct OCResource OCResource;
  38
  39 void OCPayloadDestroy(OCPayload* payload);
  40
  41 // Representation Payload
  42 OCRepPayload* OCRepPayloadCreate();
  43
  44 size_t calcDimTotal(const size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  45
  46 OCRepPayload* OCRepPayloadClone(const OCRepPayload* payload);
  47
  48 void OCRepPayloadAppend(OCRepPayload* parent, OCRepPayload* child);
  49
  50 bool OCRepPayloadSetUri(OCRepPayload* payload, const char* uri);
  51
  52 bool OCRepPayloadAddResourceType(OCRepPayload* payload, const char* resourceType);
  53 bool OCRepPayloadAddInterface(OCRepPayload* payload, const char* interface);
  54
  55 bool OCRepPayloadAddResourceTypeAsOwner(OCRepPayload* payload, char* resourceType);
  56 bool OCRepPayloadAddInterfaceAsOwner(OCRepPayload* payload, char* interface);
  57
  58 bool OCRepPayloadIsNull(const OCRepPayload* payload, const char* name);
  59 bool OCRepPayloadSetNull(OCRepPayload* payload, const char* name);
  60
  61 bool OCRepPayloadSetPropInt(OCRepPayload* payload, const char* name, int64_t value);
  62 bool OCRepPayloadGetPropInt(const OCRepPayload* payload, const char* name, int64_t* value);
  63
  64 bool OCRepPayloadSetPropDouble(OCRepPayload* payload, const char* name, double value);
  65 bool OCRepPayloadGetPropDouble(const OCRepPayload* payload, const char* name, double* value);
  66
  67 bool OCRepPayloadSetPropString(OCRepPayload* payload, const char* name, const char* value);
  68 bool OCRepPayloadSetPropStringAsOwner(OCRepPayload* payload, const char* name, char* value);
  69 bool OCRepPayloadGetPropString(const OCRepPayload* payload, const char* name, char** value);
  70
  71 bool OCRepPayloadSetPropBool(OCRepPayload* payload, const char* name, bool value);
  72 bool OCRepPayloadGetPropBool(const OCRepPayload* payload, const char* name, bool* value);
  73
  74 bool OCRepPayloadSetPropObject(OCRepPayload* payload, const char* name, const OCRepPayload* value);
  75 bool OCRepPayloadSetPropObjectAsOwner(OCRepPayload* payload, const char* name,
  76         OCRepPayload* value);
  77 bool OCRepPayloadGetPropObject(const OCRepPayload* payload, const char* name, OCRepPayload** value);
  78
  79 bool OCRepPayloadSetIntArrayAsOwner(OCRepPayload* payload, const char* name,
  80         int64_t* array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  81 bool OCRepPayloadSetIntArray(OCRepPayload* payload, const char* name,
  82         const int64_t* array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  83 bool OCRepPayloadGetIntArray(const OCRepPayload* payload, const char* name,
  84         int64_t** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  85
  86 bool OCRepPayloadSetDoubleArrayAsOwner(OCRepPayload* payload, const char* name,
  87         double* array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  88 bool OCRepPayloadSetDoubleArray(OCRepPayload* payload, const char* name,
  89         const double* array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  90 bool OCRepPayloadGetDoubleArray(const OCRepPayload* payload, const char* name,
  91         double** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  92
  93 bool OCRepPayloadSetStringArrayAsOwner(OCRepPayload* payload, const char* name,
  94         char** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  95 bool OCRepPayloadSetStringArray(OCRepPayload* payload, const char* name,
  96         const char** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  97 bool OCRepPayloadGetStringArray(const OCRepPayload* payload, const char* name,
  98         char*** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  99
 100 bool OCRepPayloadSetBoolArrayAsOwner(OCRepPayload* payload, const char* name,
 101         bool* array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
 102 bool OCRepPayloadSetBoolArray(OCRepPayload* payload, const char* name,
 103         const bool* array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
 104 bool OCRepPayloadGetBoolArray(const OCRepPayload* payload, const char* name,
 105         bool** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
 106
 107 bool OCRepPayloadSetPropObjectArrayAsOwner(OCRepPayload* payload, const char* name,
 108         OCRepPayload** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
 109 bool OCRepPayloadSetPropObjectArray(OCRepPayload* payload, const char* name,
 110         const OCRepPayload** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
 111 bool OCRepPayloadGetPropObjectArray(const OCRepPayload* payload, const char* name,
 112         OCRepPayload*** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
 113
 114 void OCRepPayloadDestroy(OCRepPayload* payload);
 115
 116 // Discovery Payload
 117 OCDiscoveryPayload* OCDiscoveryPayloadCreate();
 118
 119 OCSecurityPayload* OCSecurityPayloadCreate(const char* securityData);
 120 void OCSecurityPayloadDestroy(OCSecurityPayload* payload);
 121
 122 void OCDiscoveryPayloadAddResource(OCDiscoveryPayload* payload, const OCResource* res,
 123         uint16_t port);
 124 void OCDiscoveryPayloadAddNewResource(OCDiscoveryPayload* payload, OCResourcePayload* res);
 125 size_t OCDiscoveryPayloadGetResourceCount(OCDiscoveryPayload* payload);
 126 OCResourcePayload* OCDiscoveryPayloadGetResource(OCDiscoveryPayload* payload, size_t index);
 127
 128 void OCDiscoveryPayloadDestroy(OCDiscoveryPayload* payload);
 129
 130 // Device Payload
 131 OCDevicePayload* OCDevicePayloadCreate(const char* uri, const uint8_t* sid, const char* dname,
 132         const char* specVer, const char* dmVer);
 133 void OCDevicePayloadDestroy(OCDevicePayload* payload);
 134
 135 // Platform Payload
 136 OCPlatformPayload* OCPlatformPayloadCreate(const char* uri, const OCPlatformInfo* platformInfo);
 137 OCPlatformPayload* OCPlatformPayloadCreateAsOwner(char* uri, OCPlatformInfo* platformInfo);
 138
 139 void OCPlatformPayloadDestroy(OCPlatformPayload* payload);
 140
 141 // Presence Payload
 142 OCPresencePayload* OCPresencePayloadCreate(uint32_t seqNum, uint32_t maxAge,
 143         OCPresenceTrigger trigger, const char* resourceType);
 144 void OCPresencePayloadDestroy(OCPresencePayload* payload);
 145
 146 #ifdef __cplusplus
 147 }
 148 #endif
 149
 150 #endif
 151