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 /**
  33  * Maximum length of the URI supported by client/server while processing
  34  * REST requests/responses.
  35  */
  36 #ifdef ARDUINO
  37 #define MAX_URI_LENGTH (64)
  38 #else
  39 #define MAX_URI_LENGTH (256)
  40 #endif
  41
  42 /**
  43  * Maximum length of the query supported by client/server while processing
  44  * REST requests/responses.
  45  */
  46 #ifdef ARDUINO
  47 #define MAX_QUERY_LENGTH (64)
  48 #else
  49 #define MAX_QUERY_LENGTH (256)
  50 #endif
  51
  52
  53 /**
  54  * Maximum length of the Manufacturer name supported by the server
  55  * for manufacturer name.
  56  * @deprecated use MAX_PLATFORM_NAME_LENGTH instead.
  57  */
  58 #define MAX_MANUFACTURER_NAME_LENGTH (64)
  59
  60 /**
  61  * Maximum length of the URL to the Manufacturer details supported by
  62  * the server.
  63  * @deprecated use MAX_PLATFORM_URL_LENGTH instead.
  64  */
  65 #define MAX_MANUFACTURER_URL_LENGTH (256)
  66
  67 /**
  68  * Maximum length of the value supported by the server
  69  * for platform property of type string.
  70  */
  71 #define MAX_PLATFORM_NAME_LENGTH (64)
  72
  73 /**
  74  * Maximum length of the URL supported by the server
  75  * for platform property of type url.
  76  */
  77 #define MAX_PLATFORM_URL_LENGTH (256)
  78
  79 /**
  80  * Maximum number of resources which can be contained inside collection
  81  * resource.
  82  */
  83 #define MAX_CONTAINED_RESOURCES  (5)
  84
  85 /**
  86  *  Maximum number of vendor specific header options an application can set or receive
  87  *  in PDU
  88  */
  89 #ifdef ARDUINO
  90 #define MAX_HEADER_OPTIONS (2)
  91 #else
  92 #define MAX_HEADER_OPTIONS (50)
  93 #endif
  94
  95 /**
  96  *  Maximum Length of the vendor specific header option
  97  */
  98 #ifdef ARDUINO
  99 #define MAX_HEADER_OPTION_DATA_LENGTH (20)
 100 #else
 101 #define MAX_HEADER_OPTION_DATA_LENGTH (1024)
 102 #endif
 103
 104 /**
 105  * Sets the time to live (TTL) for response callback(s).
 106  * The callback(s) will be up for deletion after such time but are not guaranteed
 107  * to be deleted immediately and you may get responses even after timeout.
 108  * This timeout will NOT apply to OBSERVE requests. OBSERVE needs an explicit cancel using OCCancel().
 109  * @note: Changing the setting to a very long duration may lead to unsupported and untested
 110  * operation. Setting this to as small a value as reasonable will reclaim memory faster.
 111  */
 112 #define MAX_CB_TIMEOUT_SECONDS   (2 * 60 * 60)  // 2 hours = 7200 seconds.
 113
 114 #endif //OCSTACK_CONFIG_H_