resource/csdk/stack/include/internal/ocstackinternal.h

   1 //******************************************************************
   2 //
   3 // Copyright 2014 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
  22
  23
  24 /**
  25  * @file
  26  *
  27  * This file contains the Internal include file used by lower layers of the OC stack
  28  *
  29  */
  30
  31 #ifndef OCSTACKINTERNAL_H_
  32 #define OCSTACKINTERNAL_H_
  33
  34 //-----------------------------------------------------------------------------
  35 // Includes
  36 //-----------------------------------------------------------------------------
  37 #include <stdbool.h>
  38 #include "ocstack.h"
  39 #include "ocstackconfig.h"
  40 #include "occlientcb.h"
  41 #include <ocrandom.h>
  42
  43 #include "cacommon.h"
  44 #include "cainterface.h"
  45 #include "securevirtualresourcetypes.h"
  46
  47 #ifdef __cplusplus
  48 extern "C" {
  49 #endif // __cplusplus
  50
  51
  52 //-----------------------------------------------------------------------------
  53 // Global variables
  54 //-----------------------------------------------------------------------------
  55
  56 /** Default device entity Handler.*/
  57 extern OCDeviceEntityHandler defaultDeviceHandler;
  58
  59 /** Default Callback parameter.*/
  60 extern void* defaultDeviceHandlerCallbackParameter;
  61
  62 //-----------------------------------------------------------------------------
  63 // Defines
  64 //-----------------------------------------------------------------------------
  65
  66 /** The coap scheme */
  67 #define OC_COAP_SCHEME "coap://"
  68
  69 /** the first outgoing sequence number will be 5*/
  70 #define OC_OFFSET_SEQUENCE_NUMBER (4)
  71
  72 /**
  73  * This structure will be created in occoap and passed up the stack on the server side.
  74  */
  75 typedef struct
  76 {
  77     /** Observe option field.*/
  78     uint32_t observationOption;
  79
  80     /** The REST method retrieved from received request PDU.*/
  81     OCMethod method;
  82
  83     /** the requested payload format. */
  84     OCPayloadFormat acceptFormat;
  85
  86     /** resourceUrl will be filled in occoap using the path options in received request PDU.*/
  87     char resourceUrl[MAX_URI_LENGTH];
  88
  89     /** resource query send by client.*/
  90     char query[MAX_QUERY_LENGTH];
  91
  92     /** reqJSON is retrieved from the payload of the received request PDU.*/
  93     uint8_t *payload;
  94
  95     /** qos is indicating if the request is CON or NON.*/
  96     OCQualityOfService qos;
  97
  98     /** Number of the received vendor specific header options.*/
  99     uint8_t numRcvdVendorSpecificHeaderOptions;
 100
 101     /** Array of received vendor specific header option .*/
 102     OCHeaderOption rcvdVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
 103
 104     /** Remote end-point address **/
 105     OCDevAddr devAddr;
 106
 107     /** Token for the observe request.*/
 108     CAToken_t requestToken;
 109
 110     /** token length.*/
 111     uint8_t tokenLength;
 112
 113     /** The ID of CoAP PDU.*/
 114     uint16_t coapID;
 115
 116     /** For delayed Response.*/
 117     uint8_t delayedResNeeded;
 118
 119     /** For More packet.*/
 120     uint8_t reqMorePacket;
 121
 122     /** The number of requested packet.*/
 123     uint32_t reqPacketNum;
 124
 125     /** The size of requested packet.*/
 126     uint16_t reqPacketSize;
 127
 128     /** The number of responded packet.*/
 129     uint32_t resPacketNum;
 130
 131     /** Responded packet size.*/
 132     uint16_t resPacketSize;
 133
 134     /** The total size of requested packet.*/
 135     size_t reqTotalSize;
 136 } OCServerProtocolRequest;
 137
 138 /**
 139  * This structure will be created in occoap and passed up the stack on the client side.
 140  */
 141 typedef struct
 142 {
 143     /** handle is retrieved by comparing the token-handle pair in the PDU.*/
 144     ClientCB * cbNode;
 145
 146     /** This is how long this response is valid for (in seconds).*/
 147     uint32_t maxAge;
 148
 149     /** This is the Uri of the resource. (ex. "coap://192.168.1.1/a/led").*/
 150     char * fullUri;
 151
 152     /** This is the relative Uri of the resource. (ex. "/a/led").*/
 153     char * rcvdUri;
 154
 155     /** This is the received payload.*/
 156     char * bufRes;
 157
 158     /** This is the token received OTA.*/
 159     CAToken_t rcvdToken;
 160
 161     /** this structure will be passed to client.*/
 162     OCClientResponse * clientResponse;
 163 } OCResponse;
 164
 165 /**
 166  * This typedef is to represent our Server Instance identification.
 167  */
 168 typedef uint8_t ServerID[16];
 169
 170 //-----------------------------------------------------------------------------
 171 // Internal function prototypes
 172 //-----------------------------------------------------------------------------
 173
 174
 175 /**
 176  * Handler function for sending a response from multiple resources, such as a collection.
 177  * Aggregates responses from multiple resource until all responses are received then sends the
 178  * concatenated response
 179  *
 180  * TODO: Need to add a timeout in case a (remote?) resource does not respond
 181  *
 182  * @param token         Token to search for.
 183  * @param tokenLength   Length of token.
 184  * @param status        Feedback status.
 185  * @return
 186  *     ::OCStackResult
 187  */
 188
 189 OCStackResult OCStackFeedBack(CAToken_t token, uint8_t tokenLength, uint8_t status);
 190
 191
 192 /**
 193  * Handler function to execute stack requests
 194  *
 195  * @param protocolRequest      Pointer to the protocol requests from server.
 196  *
 197  * @return
 198  *     ::OCStackResult
 199  */
 200 OCStackResult HandleStackRequests(OCServerProtocolRequest * protocolRequest);
 201
 202 OCStackResult SendDirectStackResponse(const CAEndpoint_t* endPoint, const uint16_t coapID,
 203         const CAResponseResult_t responseResult, const CAMessageType_t type,
 204         const uint8_t numOptions, const CAHeaderOption_t *options,
 205         CAToken_t token, uint8_t tokenLength, const char *resourceUri);
 206
 207 #ifdef WITH_PRESENCE
 208
 209 /**
 210  * Notify Presence subscribers that a resource has been modified.
 211  *
 212  * @param resourceType    Handle to the resourceType linked list of resource that was modified.
 213  * @param trigger         The simplified reason this API was invoked.
 214  *
 215  * @return ::OC_STACK_OK on success, some other value upon failure.
 216  */
 217 OCStackResult SendPresenceNotification(OCResourceType *resourceType,
 218         OCPresenceTrigger trigger);
 219
 220 /**
 221  * Send Stop Notification to Presence subscribers.
 222  *
 223  * @return ::OC_STACK_OK on success, some other value upon failure.
 224  */
 225 OCStackResult SendStopNotification();
 226 #endif // WITH_PRESENCE
 227
 228 /**
 229  * Function to parse the IPv4 address.
 230  *
 231  * @param ipAddrStr       Pointer to a string of IPv4 address.
 232  * @param ipAddr          pointer to IPv4 adress.
 233  * @param port            Port number.
 234  *
 235  * @return true on success, false upon failure.
 236  */
 237 bool ParseIPv4Address(char * ipAddrStr, uint8_t * ipAddr, uint16_t * port);
 238
 239 /**
 240  * Bind a resource interface to a resource.
 241  *
 242  * @param resource Target resource.
 243  * @param resourceInterfaceName Resource interface.
 244  *
 245  * @return ::OC_STACK_OK on success, some other value upon failure.
 246  */
 247 OCStackResult BindResourceInterfaceToResource(OCResource* resource,
 248                                             const char *resourceInterfaceName);
 249 /**
 250  * Bind a resource type to a resource.
 251  *
 252  * @param resource Target resource.
 253  * @param resourceTypeName Name of resource type.
 254  * @return ::OC_STACK_OK on success, some other value upon failure.
 255  */
 256 OCStackResult BindResourceTypeToResource(OCResource* resource,
 257                                             const char *resourceTypeName);
 258
 259
 260 /**
 261  * Converts a CAResult_t type to a OCStackResult type.
 262  *
 263  * @param caResult CAResult_t value to convert.
 264  * @return OCStackResult that was converted from the input CAResult_t value.
 265  */
 266 OCStackResult CAResultToOCResult(CAResult_t caResult);
 267
 268 /**
 269  * Get a byte representation of the server instance ID.
 270  * The memory is managed internal to this function, so freeing it externally will
 271  * result in a runtime error.
 272  *
 273  * Note: This will NOT seed the RNG, so it must be called after the RNG is seeded.
 274  * This is done automatically during the OCInit process,
 275  * so ensure that this call is done after that.
 276  *
 277  * @return A uint8_t representation the server instance ID.
 278  */
 279 const OicUuid_t* OCGetServerInstanceID(void);
 280
 281 /**
 282  * Get a string representation the server instance ID.
 283  * The memory is managed internal to this function, so freeing externally will result
 284  * in a runtime error.
 285  * Note: This will NOT seed the RNG, so it must be called after the RNG is seeded.
 286  * This is done automatically during the OCInit process,
 287  * so ensure that this call is done after that.
 288  *
 289  * @return A string representation  the server instance ID.
 290  */
 291 const char* OCGetServerInstanceIDString(void);
 292
 293 /**
 294  * Map OCQualityOfService to CAMessageType.
 295  *
 296  * @param qos Input qos.
 297  *
 298  * @return CA message type for a given qos.
 299  */
 300 CAMessageType_t qualityOfServiceToMessageType(OCQualityOfService qos);
 301
 302 #ifdef WITH_PRESENCE
 303 /**
 304  * Enable/disable a resource property.
 305  *
 306  * @param inputProperty             Pointer to resource property.
 307  * @param resourceProperties        Property to be enabled/disabled.
 308  * @param enable                    0:disable, 1:enable.
 309  *
 310  * @return OCStackResult that was converted from the input CAResult_t value.
 311  */
 312 //TODO: should the following function be public?
 313 OCStackResult OCChangeResourceProperty(OCResourceProperty * inputProperty,
 314         OCResourceProperty resourceProperties, uint8_t enable);
 315 #endif
 316
 317 const char *convertTriggerEnumToString(OCPresenceTrigger trigger);
 318
 319 OCPresenceTrigger convertTriggerStringToEnum(const char * triggerStr);
 320
 321 void CopyEndpointToDevAddr(const CAEndpoint_t *in, OCDevAddr *out);
 322
 323 void CopyDevAddrToEndpoint(const OCDevAddr *in, CAEndpoint_t *out);
 324
 325 #ifdef __cplusplus
 326 }
 327 #endif // __cplusplus
 328
 329 #endif /* OCSTACKINTERNAL_H_ */
 330