service/notification/src/consumer/NSConsumerCommon.h

   1 //******************************************************************
   2 //
   3 // Copyright 2016 Samsung Electronics 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 _NS_CONSUMER_CONSTANTS_H_
  22 #define _NS_CONSUMER_CONSTANTS_H_
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif // __cplusplus
  27
  28 #include <stdio.h>
  29 #include <stdbool.h>
  30
  31 #include "NSConsumerInterface.h"
  32 #include "NSStructs.h"
  33 #include "ocstack.h"
  34
  35 #define NS_QOS OC_HIGH_QOS
  36 #define NS_RESOURCE_TYPE "oic.r.notification"
  37 #define NS_RESOURCE_URI "/notification"
  38 #define NS_INTERFACE_BASELINE "oic.if.baseline"
  39 #define NS_INTERFACE_NOTIFICATION "oic.if.notification"
  40 #define NS_RESOURCE_QUERY "/oic/res"
  41
  42 #define NS_DISCOVER_QUERY "/oic/res?rt=oic.r.notification"
  43 #define NS_DEVICE_ID_LENGTH 37
  44
  45 #define NS_VERIFY_NOT_NULL_V(obj) \
  46     { \
  47         if ((obj) == NULL) \
  48         { \
  49             NS_LOG_V(ERROR, "%s : %s is null", __func__, #obj); \
  50             return; \
  51         } \
  52     }
  53
  54 #define NS_VERIFY_NOT_NULL(obj, retVal) \
  55     { \
  56         if ((obj) == NULL) \
  57         { \
  58             NS_LOG_V(ERROR, "%s : %s is null", __func__, #obj); \
  59             return (retVal); \
  60         } \
  61     }
  62
  63 #define NS_VERIFY_NOT_NULL_WITH_POST_CLEANING_V(obj, func) \
  64     { \
  65         if ((obj) == NULL) \
  66         { \
  67             NS_LOG_V(ERROR, "%s : %s is null", __func__, #obj); \
  68             NS_LOG(ERROR, "execute deletion"); \
  69             (func); \
  70             return; \
  71         } \
  72     }
  73
  74 #define NS_VERIFY_NOT_NULL_WITH_POST_CLEANING(obj, retVal, func) \
  75     { \
  76         if ((obj) == NULL) \
  77         { \
  78             NS_LOG_V(ERROR, "%s : %s is null", __func__, #obj); \
  79             NS_LOG(ERROR, "execute deletion"); \
  80             (func); \
  81             return (retVal); \
  82         } \
  83     }
  84
  85 #define NS_VERIFY_STACK_SUCCESS_V(obj) \
  86     { \
  87         bool _ret = (obj); \
  88         if ( _ret != true) \
  89         { \
  90             NS_LOG_V(ERROR, "%s : %s is not OC_STACK_OK : %d", __func__, #obj, _ret); \
  91             return; \
  92         } \
  93     }
  94
  95 #define NS_VERIFY_STACK_SUCCESS(obj, retVal) \
  96     { \
  97         bool _ret = (obj); \
  98         if ( _ret != true) \
  99         { \
 100             NS_LOG_V(ERROR, "%s : %s is not OC_STACK_OK : %d", __func__, #obj, _ret); \
 101             return (retVal); \
 102         } \
 103     }
 104
 105 #define NS_VERIFY_STACK_SUCCESS_WITH_POST_CLEANING(obj, retVal, func) \
 106     { \
 107         bool _ret = (obj); \
 108         if ( _ret != true) \
 109         { \
 110             NS_LOG_V(ERROR, "%s : %s is not OC_STACK_OK : %d", __func__, #obj, _ret); \
 111             (func); \
 112             return (retVal); \
 113         } \
 114     }
 115
 116 #define NSOICFree(obj) \
 117     { \
 118         if ((obj)) \
 119         { \
 120             OICFree((obj)); \
 121             (obj) = NULL; \
 122             NS_LOG_V(DEBUG, "%s : %s Removed", __func__, #obj); \
 123         } \
 124     }
 125
 126 typedef enum
 127 {
 128     NS_DISCOVER_DEFAULT, // will work for adapter_ip.
 129     NS_DISCOVER_UDP,
 130     NS_DISCOVER_TCP,
 131     NS_DISCOVER_CLOUD
 132 } NSConsumerDiscoverType;
 133
 134 typedef struct NSProviderConnectionInfo
 135 {
 136     OCDevAddr * addr;
 137
 138     OCDoHandle messageHandle;
 139     OCDoHandle syncHandle;
 140
 141     bool isCloudConnection;
 142     bool isSubscribing;
 143
 144     struct NSProviderConnectionInfo * next;
 145
 146 } NSProviderConnectionInfo;
 147
 148 typedef struct
 149 {
 150     char providerId[NS_DEVICE_ID_LENGTH];
 151
 152     char * messageUri;
 153     char * syncUri;
 154
 155     NSAccessPolicy accessPolicy;
 156
 157     NSProviderConnectionInfo * connection;
 158
 159 } NSProvider_internal;
 160
 161 typedef struct
 162 {
 163     uint64_t messageId;
 164     char providerId[NS_DEVICE_ID_LENGTH];
 165     NSSyncType state;
 166
 167     NSProviderConnectionInfo * connection;
 168
 169 } NSSyncInfo_internal;
 170
 171 typedef struct
 172 {
 173     // Mandatory
 174     uint64_t messageId;
 175     char providerId[NS_DEVICE_ID_LENGTH];
 176
 177     //optional
 178     NSMessageType type;
 179     char * dateTime;
 180     uint64_t ttl;
 181     char * title;
 182     char * contentText;
 183     char * sourceName;
 184     NSMediaContents * mediaContents;
 185
 186 } NSMessage_consumer;
 187
 188 bool NSIsStartedConsumer();
 189 void NSSetIsStartedConsumer(bool setValue);
 190
 191 void NSSetDiscoverProviderCb(NSProviderDiscoveredCallback cb);
 192 void NSDiscoveredProvider(NSProvider * provider);
 193
 194 void NSSetSubscriptionAcceptedCb(NSSubscriptionAcceptedCallback cb);
 195 void NSSubscriptionAccepted(NSProvider * provider);
 196
 197 void NSSetMessagePostedCb(NSMessageReceivedCallback  cb);
 198 void NSMessagePost(NSMessage * obj);
 199
 200 void NSSetNotificationSyncCb(NSSyncInfoReceivedCallback cb);
 201 void NSNotificationSync(NSSyncInfo * sync);
 202
 203 char ** NSGetConsumerId();
 204 void NSSetConsumerId(char * cId);
 205
 206 char * NSMakeRequestUriWithConsumerId(const char * uri);
 207
 208 NSTask * NSMakeTask(NSTaskType, void *);
 209
 210 NSResult NSConsumerPushEvent(NSTask *);
 211
 212 NSMessage_consumer * NSCopyMessage(NSMessage_consumer *);
 213 void NSRemoveMessage(NSMessage_consumer *);
 214
 215 NSProviderConnectionInfo * NSCreateProviderConnections(OCDevAddr * inAddr);
 216 NSProviderConnectionInfo * NSCopyProviderConnections(NSProviderConnectionInfo * conn);
 217 void NSRemoveConnections(NSProviderConnectionInfo * connections);
 218
 219 NSProvider_internal * NSCopyProvider(NSProvider_internal *);
 220 void NSRemoveProvider(NSProvider_internal *);
 221
 222 OCStackResult NSInvokeRequest(OCDoHandle * handle,
 223         OCMethod method, const OCDevAddr * addr,
 224         const char * queryUrl, OCPayload * payload,
 225         void * callbackFunc, void * callbackData, OCConnectivityType type);
 226
 227 bool NSOCResultToSuccess(OCStackResult ret);
 228
 229 #ifdef __cplusplus
 230 }
 231 #endif // __cplusplus
 232
 233 #endif // _NS_CONSUMER_CONSTANTS_H_