resource/csdk/stack/include/ocstackconfig.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  * @file
  24  *
  25  * This file contains all the variables which can be configured/modified as
  26  * per platform or specific product usage scenarios.
  27  */
  28
  29 #ifndef OCSTACK_CONFIG_H_
  30 #define OCSTACK_CONFIG_H_
  31
  32 /** This would need to be updated in future as we move to support IPv6 and other
  33  *  technologies.
  34  */
  35 #define DEV_ADDR_SIZE_MAX (16)
  36
  37 /**
  38  * Maximum length of the response supported by Server for any REST request.
  39  * The actual repsonse length is 256 for Arduino and 1024 for other platforms.
  40  * Note that the stack will add a prefix and suffix to the payload.
  41  * @code
  42  * Prefix : {"oic":[
  43  * Suffix : ]}
  44  * @endcode
  45  * They have a combined size of 10 bytes.
  46  */
  47 #ifdef WITH_ARDUINO
  48 #define MAX_RESPONSE_LENGTH (256)
  49 #else
  50 #define MAX_RESPONSE_LENGTH (1024)
  51 #endif
  52
  53 /**
  54  * Maximum length of the request supported by Client/Server for any REST request.
  55  */
  56 #ifdef WITH_ARDUINO
  57 #define MAX_REQUEST_LENGTH (256)
  58 #else
  59 #define MAX_REQUEST_LENGTH (1024)
  60 #endif
  61
  62 /**
  63  * Maximum length of the URI supported by client/server while processing
  64  * REST requests/responses.
  65  */
  66 #define MAX_URI_LENGTH (64)
  67
  68 /**
  69  * Maximum length of the query supported by client/server while processing
  70  * REST requests/responses.
  71  */
  72 #define MAX_QUERY_LENGTH (64)
  73
  74 /**
  75  * Maximum length of the Manufacturer name supported by the server
  76  * for manufacturer name.
  77  */
  78 #define MAX_MANUFACTURER_NAME_LENGTH (16)
  79
  80 /**
  81  * Maximum length of the URL to the Manufacturer details supported by
  82  * the server.
  83  */
  84 #define MAX_MANUFACTURER_URL_LENGTH (32)
  85
  86 /**
  87  * Maximum number of resources which can be contained inside collection
  88  * resource.
  89  */
  90 #define MAX_CONTAINED_RESOURCES  (5)
  91
  92 /**
  93  *  Maximum number of vendor specific header options an application can set or receive
  94  *  in PDU
  95  */
  96 #define MAX_HEADER_OPTIONS (2)
  97
  98 /**
  99  *  Maximum Length of the vendor specific header option
 100  */
 101 #define MAX_HEADER_OPTION_DATA_LENGTH (16)
 102
 103 /**
 104  * Sets the time to live (TTL) for response callback(s).
 105  * The callback(s) will be up for deletion after such time but are not guaranteed
 106  * to be deleted immediately and you may get responses even after timeout.
 107  * This timeout will NOT apply to OBSERVE requests. OBSERVE needs an explicit cancel using OCCancel().
 108  * @note: Changing the setting to a very long duration may lead to unsupported and untested
 109  * operation. Setting this to as small a value as reasonable will reclaim memory faster.
 110  */
 111 #define MAX_CB_TIMEOUT_SECONDS   (2 * 60 * 60)  // 2 hours = 7200 seconds.
 112
 113 #endif //OCSTACK_CONFIG_H_