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 "logger.h"
  27 #include "octypes.h"
  28
  29 #ifdef WITH_RD
  30 #include "rd_payload.h"
  31 #endif
  32
  33 #ifdef __cplusplus
  34 extern "C"
  35 {
  36 #endif
  37
  38 typedef struct OCResource OCResource;
  39
  40 void OCPayloadDestroy(OCPayload* payload);
  41
  42 // Representation Payload
  43 OCRepPayload* OCRepPayloadCreate();
  44
  45 size_t calcDimTotal(const size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  46
  47 OCRepPayload* OCRepPayloadClone(const OCRepPayload* payload);
  48
  49 void OCRepPayloadAppend(OCRepPayload* parent, OCRepPayload* child);
  50
  51 bool OCRepPayloadSetUri(OCRepPayload* payload, const char* uri);
  52
  53 bool OCRepPayloadAddResourceType(OCRepPayload* payload, const char* resourceType);
  54 bool OCRepPayloadAddInterface(OCRepPayload* payload, const char* interface);
  55
  56 bool OCRepPayloadAddResourceTypeAsOwner(OCRepPayload* payload, char* resourceType);
  57 bool OCRepPayloadAddInterfaceAsOwner(OCRepPayload* payload, char* interface);
  58
  59 bool OCRepPayloadIsNull(const OCRepPayload* payload, const char* name);
  60 bool OCRepPayloadSetNull(OCRepPayload* payload, const char* name);
  61
  62 bool OCRepPayloadSetPropInt(OCRepPayload* payload, const char* name, int64_t value);
  63 bool OCRepPayloadGetPropInt(const OCRepPayload* payload, const char* name, int64_t* value);
  64
  65 bool OCRepPayloadSetPropDouble(OCRepPayload* payload, const char* name, double value);
  66 bool OCRepPayloadGetPropDouble(const OCRepPayload* payload, const char* name, double* value);
  67
  68 bool OCRepPayloadSetPropString(OCRepPayload* payload, const char* name, const char* value);
  69 bool OCRepPayloadSetPropStringAsOwner(OCRepPayload* payload, const char* name, char* value);
  70 bool OCRepPayloadGetPropString(const OCRepPayload* payload, const char* name, const char** value);
  71
  72 bool OCRepPayloadSetPropBool(OCRepPayload* payload, const char* name, bool value);
  73 bool OCRepPayloadGetPropBool(const OCRepPayload* payload, const char* name, bool* value);
  74
  75 bool OCRepPayloadSetPropObject(OCRepPayload* payload, const char* name, const OCRepPayload* value);
  76 bool OCRepPayloadSetPropObjectAsOwner(OCRepPayload* payload, const char* name,
  77         OCRepPayload* value);
  78 bool OCRepPayloadGetPropObject(const OCRepPayload* payload, const char* name, OCRepPayload** value);
  79
  80 bool OCRepPayloadSetIntArrayAsOwner(OCRepPayload* payload, const char* name,
  81         int64_t* array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  82 bool OCRepPayloadSetIntArray(OCRepPayload* payload, const char* name,
  83         const int64_t* array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  84 bool OCRepPayloadGetIntArray(const OCRepPayload* payload, const char* name,
  85         int64_t** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  86
  87 bool OCRepPayloadSetDoubleArrayAsOwner(OCRepPayload* payload, const char* name,
  88         double* array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  89 bool OCRepPayloadSetDoubleArray(OCRepPayload* payload, const char* name,
  90         const double* array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  91 bool OCRepPayloadGetDoubleArray(const OCRepPayload* payload, const char* name,
  92         double** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  93
  94 bool OCRepPayloadSetStringArrayAsOwner(OCRepPayload* payload, const char* name,
  95         char** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  96 bool OCRepPayloadSetStringArray(OCRepPayload* payload, const char* name,
  97         const char** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
  98 bool OCRepPayloadGetStringArray(const OCRepPayload* payload, const char* name,
  99         char*** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
 100
 101 bool OCRepPayloadSetBoolArrayAsOwner(OCRepPayload* payload, const char* name,
 102         bool* array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
 103 bool OCRepPayloadSetBoolArray(OCRepPayload* payload, const char* name,
 104         const bool* array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
 105 bool OCRepPayloadGetBoolArray(const OCRepPayload* payload, const char* name,
 106         bool** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
 107
 108 bool OCRepPayloadSetPropObjectArrayAsOwner(OCRepPayload* payload, const char* name,
 109         OCRepPayload** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
 110 bool OCRepPayloadSetPropObjectArray(OCRepPayload* payload, const char* name,
 111         const OCRepPayload** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
 112 bool OCRepPayloadGetPropObjectArray(const OCRepPayload* payload, const char* name,
 113         OCRepPayload*** array, size_t dimensions[MAX_REP_ARRAY_DEPTH]);
 114
 115 void OCRepPayloadDestroy(OCRepPayload* payload);
 116
 117 // Discovery Payload
 118 OCDiscoveryPayload* OCDiscoveryPayloadCreate();
 119
 120 OCSecurityPayload* OCSecurityPayloadCreate(const char* securityData);
 121 void OCSecurityPayloadDestroy(OCSecurityPayload* payload);
 122
 123 void OCDiscoveryPayloadAddResource(OCDiscoveryPayload* payload, const OCResource* res,
 124         uint16_t port);
 125 void OCDiscoveryPayloadAddNewResource(OCDiscoveryPayload* payload, OCResourcePayload* res);
 126 size_t OCDiscoveryPayloadGetResourceCount(OCDiscoveryPayload* payload);
 127 OCResourcePayload* OCDiscoveryPayloadGetResource(OCDiscoveryPayload* payload, size_t index);
 128
 129 void OCDiscoveryPayloadDestroy(OCDiscoveryPayload* payload);
 130
 131 // Device Payload
 132 OCDevicePayload* OCDevicePayloadCreate(const char* uri, const uint8_t* sid, const char* dname,
 133         const char* specVer, const char* dmVer);
 134 void OCDevicePayloadDestroy(OCDevicePayload* payload);
 135
 136 // Platform Payload
 137 OCPlatformPayload* OCPlatformPayloadCreate(const char* uri, const OCPlatformInfo* platformInfo);
 138 OCPlatformPayload* OCPlatformPayloadCreateAsOwner(char* uri, OCPlatformInfo* platformInfo);
 139
 140 void OCPlatformPayloadDestroy(OCPlatformPayload* payload);
 141
 142 // Presence Payload
 143 OCPresencePayload* OCPresencePayloadCreate(uint32_t seqNum, uint32_t maxAge,
 144         OCPresenceTrigger trigger, const char* resourceType);
 145 void OCPresencePayloadDestroy(OCPresencePayload* payload);
 146
 147 #ifdef __cplusplus
 148 }
 149 #endif
 150
 151 #endif
 152