resource/csdk/stack/include/octypes.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 the definition, types and APIs for resource(s) be implemented.
  26  */
  27
  28 #ifndef OCTYPES_H_
  29 #define OCTYPES_H_
  30
  31 #include "platform_features.h"
  32 #include "ocstackconfig.h"
  33 #include <stdbool.h>
  34 #include <stdint.h>
  35 #include <stdio.h>
  36 #ifdef __cplusplus
  37 #include <string.h>
  38
  39 extern "C" {
  40 #endif // __cplusplus
  41
  42 /** For the feature presence.*/
  43 #define WITH_PRESENCE
  44
  45 #include "ocpresence.h"
  46 //-----------------------------------------------------------------------------
  47 // Defines
  48 //-----------------------------------------------------------------------------
  49
  50 /**
  51  * OIC Virtual resources supported by every OIC device.
  52  */
  53 /**
  54  *  Default discovery mechanism using '/oic/res' is supported by all OIC devices
  55  *  That are Discoverable.
  56  */
  57 #define OC_RSRVD_WELL_KNOWN_URI               "/oic/res"
  58
  59 /** Device URI.*/
  60 #define OC_RSRVD_DEVICE_URI                   "/oic/d"
  61
  62 /** Platform URI.*/
  63 #define OC_RSRVD_PLATFORM_URI                 "/oic/p"
  64
  65 /** Resource Type.*/
  66 #define OC_RSRVD_RESOURCE_TYPES_URI           "/oic/res/types/d"
  67 #ifdef ROUTING_GATEWAY
  68 /** Gateway URI.*/
  69 #define OC_RSRVD_GATEWAY_URI                  "/oic/gateway"
  70 #endif
  71 #ifdef WITH_PRESENCE
  72
  73 /** Presence URI through which the OIC devices advertise their presence.*/
  74 #define OC_RSRVD_PRESENCE_URI                 "/oic/ad"
  75
  76 /** Sets the default time to live (TTL) for presence.*/
  77 #define OC_DEFAULT_PRESENCE_TTL_SECONDS (60)
  78
  79 /** For multicast Discovery mechanism.*/
  80 #define OC_MULTICAST_DISCOVERY_URI           "/oic/res"
  81
  82 /** Separator for multiple query string.*/
  83 #define OC_QUERY_SEPARATOR                "&;"
  84
  85 /**
  86  *  OC_DEFAULT_PRESENCE_TTL_SECONDS sets the default time to live (TTL) for presence.
  87  */
  88 #define OC_DEFAULT_PRESENCE_TTL_SECONDS (60)
  89
  90 /**
  91  *  OC_MAX_PRESENCE_TTL_SECONDS sets the maximum time to live (TTL) for presence.
  92  *  NOTE: Changing the setting to a longer duration may lead to unsupported and untested
  93  *  operation.
  94  *  60 sec/min * 60 min/hr * 24 hr/day
  95  */
  96 #define OC_MAX_PRESENCE_TTL_SECONDS     (60 * 60 * 24)
  97 #endif
  98
  99 /**
 100  *  Presence "Announcement Triggers".
 101  */
 102
 103 /** To create.*/
 104 #define OC_RSRVD_TRIGGER_CREATE         "create"
 105
 106 /** To change.*/
 107 #define OC_RSRVD_TRIGGER_CHANGE         "change"
 108
 109 /** To delete.*/
 110 #define OC_RSRVD_TRIGGER_DELETE         "delete"
 111
 112 /**
 113  *  Attributes used to form a proper OIC conforming JSON message.
 114  */
 115
 116 #define OC_RSRVD_OC                     "oic"
 117
 118 /** For payload. */
 119
 120 #define OC_RSRVD_PAYLOAD                "payload"
 121
 122 /** To represent href */
 123 #define OC_RSRVD_HREF                   "href"
 124
 125 /** To represent property*/
 126 #define OC_RSRVD_PROPERTY               "prop"
 127
 128 /** For representation.*/
 129 #define OC_RSRVD_REPRESENTATION         "rep"
 130
 131 /** To represent content type.*/
 132 #define OC_RSRVD_CONTENT_TYPE           "ct"
 133
 134 /** To represent resource type.*/
 135 #define OC_RSRVD_RESOURCE_TYPE          "rt"
 136
 137 /** To represent resource type with presence.*/
 138 #define OC_RSRVD_RESOURCE_TYPE_PRESENCE "oic.wk.ad"
 139
 140 /** To represent interface.*/
 141 #define OC_RSRVD_INTERFACE              "if"
 142
 143 /** To represent time to live.*/
 144 #define OC_RSRVD_TTL                    "ttl"
 145
 146 /** To represent non*/
 147 #define OC_RSRVD_NONCE                  "non"
 148
 149 /** To represent trigger type.*/
 150 #define OC_RSRVD_TRIGGER                "trg"
 151
 152 /** To represent links.*/
 153 #define OC_RSRVD_LINKS                  "links"
 154
 155 /** To represent default interface.*/
 156 #define OC_RSRVD_INTERFACE_DEFAULT      "oic.if.baseline"
 157
 158 /** To represent ll interface.*/
 159 #define OC_RSRVD_INTERFACE_LL           "oic.if.ll"
 160
 161 /** To represent batch interface.*/
 162 #define OC_RSRVD_INTERFACE_BATCH        "oic.if.b"
 163
 164 /** To represent interface group.*/
 165 #define OC_RSRVD_INTERFACE_GROUP        "oic.mi.grp"
 166
 167 /** To represent MFG date.*/
 168 #define OC_RSRVD_MFG_DATE               "mndt"
 169
 170 /** To represent FW version.*/
 171 #define OC_RSRVD_FW_VERSION             "mnfv"
 172
 173 /** To represent host name.*/
 174 #define OC_RSRVD_HOST_NAME              "hn"
 175
 176 /** To represent version.*/
 177 #define OC_RSRVD_VERSION                "icv"
 178
 179 /** To represent policy.*/
 180 #define OC_RSRVD_POLICY                 "p"
 181
 182 /** To represent bitmap.*/
 183 #define OC_RSRVD_BITMAP                 "bm"
 184
 185 /** For security.*/
 186 #define OC_RSRVD_SECURE                 "sec"
 187
 188 /** Port. */
 189 #define OC_RSRVD_HOSTING_PORT           "port"
 190
 191 /** For Server instance ID.*/
 192 #define OC_RSRVD_SERVER_INSTANCE_ID     "sid"
 193
 194 /**
 195  *  Platform.
 196  */
 197
 198 /** Platform ID. */
 199 #define OC_RSRVD_PLATFORM_ID            "pi"
 200
 201 /** Platform MFG NAME. */
 202 #define OC_RSRVD_MFG_NAME               "mnmn"
 203
 204 /** Platform URL. */
 205 #define OC_RSRVD_MFG_URL                "mnml"
 206
 207 /** Model Number.*/
 208 #define OC_RSRVD_MODEL_NUM              "mnmo"
 209
 210 /** Platform MFG Date.*/
 211 #define OC_RSRVD_MFG_DATE               "mndt"
 212
 213 /** Platform versio.n */
 214 #define OC_RSRVD_PLATFORM_VERSION       "mnpv"
 215
 216 /** Platform Operating system version. */
 217 #define OC_RSRVD_OS_VERSION             "mnos"
 218
 219 /** Platform Hardware version. */
 220 #define OC_RSRVD_HARDWARE_VERSION       "mnhw"
 221
 222 /**Platform Firmware version. */
 223 #define OC_RSRVD_FIRMWARE_VERSION       "mnfv"
 224
 225 /** Support URL for the platform. */
 226 #define OC_RSRVD_SUPPORT_URL            "mnsl"
 227
 228 /** System time for the platform. */
 229 #define OC_RSRVD_SYSTEM_TIME             "st"
 230
 231 /**
 232  *  Device.
 233  */
 234
 235 /** Device ID.*/
 236 #define OC_RSRVD_DEVICE_ID              "di"
 237
 238 /** Device Name.*/
 239 #define OC_RSRVD_DEVICE_NAME            "n"
 240
 241 /** Device specification version.*/
 242 #define OC_RSRVD_SPEC_VERSION           "lcv"
 243
 244 /** Device data model.*/
 245 #define OC_RSRVD_DATA_MODEL_VERSION     "dmv"
 246
 247 /** Device specification version.*/
 248 #define OC_SPEC_VERSION                "0.9.2"
 249
 250 /** Device Data Model version.*/
 251 #define OC_DATA_MODEL_VERSION          "sec.0.95"
 252
 253 /**
 254  *  These provide backward compatibility - their use is deprecated.
 255  */
 256 #ifndef GOING_AWAY
 257
 258 /** Multicast Prefix.*/
 259 #define OC_MULTICAST_PREFIX                  "224.0.1.187:5683"
 260
 261 /** Multicast IP address.*/
 262 #define OC_MULTICAST_IP                      "224.0.1.187"
 263
 264 /** Multicast Port.*/
 265 #define OC_MULTICAST_PORT                    5683
 266 #endif // GOING_AWAY
 267
 268 /** Max Device address size. */
 269 #ifdef RA_ADAPTER
 270 #define MAX_ADDR_STR_SIZE (256)
 271 #else
 272 #define MAX_ADDR_STR_SIZE (40)
 273 #endif
 274
 275 /** Max identity size. */
 276 #define MAX_IDENTITY_SIZE (32)
 277
 278 /** Resource Directory */
 279
 280 /** Resource Directory URI used to Discover RD and Publish resources.*/
 281 #define OC_RSRVD_RD_URI                  "/oic/rd"
 282
 283 /** To represent resource type with rd.*/
 284 #define OC_RSRVD_RESOURCE_TYPE_RD        "oic.wk.rd"
 285
 286 /** RD Discovery bias factor type. */
 287 #define OC_RSRVD_RD_DISCOVERY_SEL        "sel"
 288
 289 /** Base URI. */
 290 #define OC_RSRVD_BASE_URI                "baseURI"
 291
 292 /** Unique value per collection/link. */
 293 #define OC_RSRVD_INS                     "ins"
 294
 295 /** Allowable resource types in the links. */
 296 #define OC_RSRVD_RTS                     "rts"
 297
 298 /** Default relationship. */
 299 #define OC_RSRVD_DREL                    "drel"
 300
 301 /** Defines relationship between links. */
 302 #define OC_RSRVD_REL                     "rel"
 303
 304 /** Defines title. */
 305 #define OC_RSRVD_TITLE                   "title"
 306
 307 /** Defines URI. */
 308 #define OC_RSRVD_URI                     "uri"
 309
 310 /** Defines media type. */
 311 #define OC_RSRVD_MEDIA_TYPE              "mt"
 312
 313 /** To represent resource type with Publish RD.*/
 314 #define OC_RSRVD_RESOURCE_TYPE_RDPUBLISH "oic.wk.rdPub"
 315
 316 /**
 317  * These enums (OCTransportAdapter and OCTransportFlags) must
 318  * be kept synchronized with OCConnectivityType (below) as well as
 319  * CATransportAdapter and CATransportFlags (in CACommon.h).
 320  */
 321 typedef enum
 322 {
 323     /** value zero indicates discovery.*/
 324     OC_DEFAULT_ADAPTER = 0,
 325
 326     /** IPv4 and IPv6, including 6LoWPAN.*/
 327     OC_ADAPTER_IP           = (1 << 0),
 328
 329     /** GATT over Bluetooth LE.*/
 330     OC_ADAPTER_GATT_BTLE    = (1 << 1),
 331
 332     /** RFCOMM over Bluetooth EDR.*/
 333     OC_ADAPTER_RFCOMM_BTEDR = (1 << 2),
 334
 335 #ifdef RA_ADAPTER
 336     /**Remote Access over XMPP.*/
 337     OC_ADAPTER_REMOTE_ACCESS = (1 << 3),
 338 #endif
 339
 340 #ifdef TCP_ADAPTER
 341     /** CoAP over TCP.*/
 342     OC_ADAPTER_TCP           = (1 << 4)
 343 #endif
 344
 345 } OCTransportAdapter;
 346
 347 /**
 348  *  Enum layout assumes some targets have 16-bit integer (e.g., Arduino).
 349  */
 350 typedef enum
 351 {
 352     /** default flag is 0*/
 353     OC_DEFAULT_FLAGS = 0,
 354
 355     /** Insecure transport is the default (subject to change).*/
 356     /** secure the transport path*/
 357     OC_FLAG_SECURE     = (1 << 4),
 358
 359     /** IPv4 & IPv6 auto-selection is the default.*/
 360     /** IP adapter only.*/
 361     OC_IP_USE_V6       = (1 << 5),
 362
 363     /** IP adapter only.*/
 364     OC_IP_USE_V4       = (1 << 6),
 365
 366     /** internal use only.*/
 367     OC_RESERVED1       = (1 << 7),   // internal use only
 368
 369     /** Link-Local multicast is the default multicast scope for IPv6.
 370      *  These are placed here to correspond to the IPv6 multicast address bits.*/
 371
 372     /** IPv6 Interface-Local scope (loopback).*/
 373     OC_SCOPE_INTERFACE = 0x1,
 374
 375     /** IPv6 Link-Local scope (default).*/
 376     OC_SCOPE_LINK      = 0x2,
 377
 378     /** IPv6 Realm-Local scope. */
 379     OC_SCOPE_REALM     = 0x3,
 380
 381     /** IPv6 Admin-Local scope. */
 382     OC_SCOPE_ADMIN     = 0x4,
 383
 384     /** IPv6 Site-Local scope. */
 385     OC_SCOPE_SITE      = 0x5,
 386
 387     /** IPv6 Organization-Local scope. */
 388     OC_SCOPE_ORG       = 0x8,
 389
 390     /**IPv6 Global scope. */
 391     OC_SCOPE_GLOBAL    = 0xE,
 392
 393 } OCTransportFlags;
 394
 395 /** Bit mask for scope.*/
 396 #define OC_MASK_SCOPE    (0x000F)
 397
 398 /** Bit mask for Mods.*/
 399 #define OC_MASK_MODS     (0x0FF0)
 400 #define OC_MASK_FAMS     (OC_IP_USE_V6|OC_IP_USE_V4)
 401
 402 /**
 403  * End point identity.
 404  */
 405 typedef struct
 406 {
 407     /** Identity Length */
 408     uint16_t id_length;
 409
 410     /** Array of end point identity.*/
 411     unsigned char id[MAX_IDENTITY_SIZE];
 412 } OCIdentity;
 413
 414 /**
 415  * Data structure to encapsulate IPv4/IPv6/Contiki/lwIP device addresses.
 416  * OCDevAddr must be the same as CAEndpoint (in CACommon.h).
 417  */
 418 typedef struct
 419 {
 420     /** adapter type.*/
 421     OCTransportAdapter      adapter;
 422
 423     /** transport modifiers.*/
 424     OCTransportFlags        flags;
 425
 426     /** for IP.*/
 427     uint16_t                port;
 428
 429     /** address for all adapters.*/
 430     char                    addr[MAX_ADDR_STR_SIZE];
 431
 432     /** usually zero for default interface.*/
 433     uint32_t                interface;
 434 #if defined (ROUTING_GATEWAY) || defined (ROUTING_EP)
 435     char                    routeData[MAX_ADDR_STR_SIZE]; //destination GatewayID:ClientId
 436 #endif
 437 } OCDevAddr;
 438
 439 /**
 440  * This enum type includes elements of both ::OCTransportAdapter and ::OCTransportFlags.
 441  * It is defined conditionally because the smaller definition limits expandability on 32/64 bit
 442  * integer machines, and the larger definition won't fit into an enum on 16-bit integer machines
 443  * like Arduino.
 444  *
 445  * This structure must directly correspond to ::OCTransportAdapter and ::OCTransportFlags.
 446  */
 447 typedef enum
 448 {
 449     /** use when defaults are ok. */
 450     CT_DEFAULT = 0,
 451
 452     /** IPv4 and IPv6, including 6LoWPAN.*/
 453     CT_ADAPTER_IP           = (1 << 16),
 454
 455     /** GATT over Bluetooth LE.*/
 456     CT_ADAPTER_GATT_BTLE    = (1 << 17),
 457
 458     /** RFCOMM over Bluetooth EDR.*/
 459     CT_ADAPTER_RFCOMM_BTEDR = (1 << 18),
 460
 461 #ifdef RA_ADAPTER
 462     /** Remote Access over XMPP.*/
 463     CT_ADAPTER_REMOTE_ACCESS = (1 << 19),
 464 #endif
 465
 466 #ifdef TCP_ADAPTER
 467     /** CoAP over TCP.*/
 468     CT_ADAPTER_TCP          = (1 << 20),
 469 #endif
 470
 471     /** Insecure transport is the default (subject to change).*/
 472
 473     /** secure the transport path.*/
 474     CT_FLAG_SECURE     = (1 << 4),
 475
 476     /** IPv4 & IPv6 autoselection is the default.*/
 477
 478     /** IP adapter only.*/
 479     CT_IP_USE_V6       = (1 << 5),
 480
 481     /** IP adapter only.*/
 482     CT_IP_USE_V4       = (1 << 6),
 483
 484     /** Link-Local multicast is the default multicast scope for IPv6.
 485      * These are placed here to correspond to the IPv6 address bits.*/
 486
 487     /** IPv6 Interface-Local scope(loopback).*/
 488     CT_SCOPE_INTERFACE = 0x1,
 489
 490     /** IPv6 Link-Local scope (default).*/
 491     CT_SCOPE_LINK      = 0x2,
 492
 493     /** IPv6 Realm-Local scope.*/
 494     CT_SCOPE_REALM     = 0x3,
 495
 496     /** IPv6 Admin-Local scope.*/
 497     CT_SCOPE_ADMIN     = 0x4,
 498
 499     /** IPv6 Site-Local scope.*/
 500     CT_SCOPE_SITE      = 0x5,
 501
 502     /** IPv6 Organization-Local scope.*/
 503     CT_SCOPE_ORG       = 0x8,
 504
 505     /** IPv6 Global scope.*/
 506     CT_SCOPE_GLOBAL    = 0xE,
 507 } OCConnectivityType;
 508
 509 /** bit shift required for connectivity adapter.*/
 510 #define CT_ADAPTER_SHIFT 16
 511
 512 /** Mask Flag.*/
 513 #define CT_MASK_FLAGS 0xFFFF
 514
 515 /** Mask Adapter.*/
 516 #define CT_MASK_ADAPTER 0xFFFF0000
 517
 518 /**
 519  *  OCDoResource methods to dispatch the request
 520  */
 521 typedef enum
 522 {
 523     OC_REST_NOMETHOD       = 0,
 524
 525     /** Read.*/
 526     OC_REST_GET            = (1 << 0),
 527
 528     /** Write.*/
 529     OC_REST_PUT            = (1 << 1),
 530
 531     /** Update.*/
 532     OC_REST_POST           = (1 << 2),
 533
 534     /** Delete.*/
 535     OC_REST_DELETE         = (1 << 3),
 536
 537     /** Register observe request for most up date notifications ONLY.*/
 538     OC_REST_OBSERVE        = (1 << 4),
 539
 540     /** Register observe request for all notifications, including stale notifications.*/
 541     OC_REST_OBSERVE_ALL    = (1 << 5),
 542
 543     /** De-register observation, intended for internal use.*/
 544     OC_REST_CANCEL_OBSERVE = (1 << 6),
 545
 546     #ifdef WITH_PRESENCE
 547     /** Subscribe for all presence notifications of a particular resource.*/
 548     OC_REST_PRESENCE       = (1 << 7),
 549
 550     #endif
 551     /** Allows OCDoResource caller to do discovery.*/
 552     OC_REST_DISCOVER       = (1 << 8)
 553 } OCMethod;
 554
 555 /**
 556  *  Formats for payload encoding.
 557  */
 558 typedef enum
 559 {
 560     OC_FORMAT_CBOR,
 561     OC_FORMAT_UNDEFINED,
 562     OC_FORMAT_UNSUPPORTED,
 563 } OCPayloadFormat;
 564
 565 /**
 566  * Host Mode of Operation.
 567  */
 568 typedef enum
 569 {
 570     OC_CLIENT = 0,
 571     OC_SERVER,
 572     OC_CLIENT_SERVER,
 573     OC_GATEWAY          /**< Client server mode along with routing capabilities.*/
 574 } OCMode;
 575
 576 /**
 577  * Quality of Service attempts to abstract the guarantees provided by the underlying transport
 578  * protocol. The precise definitions of each quality of service level depend on the
 579  * implementation. In descriptions below are for the current implementation and may changed
 580  * over time.
 581  */
 582 typedef enum
 583 {
 584     /** Packet delivery is best effort.*/
 585     OC_LOW_QOS = 0,
 586
 587     /** Packet delivery is best effort.*/
 588     OC_MEDIUM_QOS,
 589
 590     /** Acknowledgments are used to confirm delivery.*/
 591     OC_HIGH_QOS,
 592
 593     /** No Quality is defined, let the stack decide.*/
 594     OC_NA_QOS
 595 } OCQualityOfService;
 596
 597 /**
 598  * Resource Properties.
 599  * The value of a policy property is defined as bitmap.
 600  * The LSB represents OC_DISCOVERABLE and Second LSB bit represents OC_OBSERVABLE and so on.
 601  * Not including the policy property is equivalent to zero.
 602  *
 603  */
 604 typedef enum
 605 {
 606     /** When none of the bits are set, the resource is non-discoverable &
 607      *  non-observable by the client.*/
 608     OC_RES_PROP_NONE = (0),
 609
 610     /** When this bit is set, the resource is allowed to be discovered by clients.*/
 611     OC_DISCOVERABLE  = (1 << 0),
 612
 613     /** When this bit is set, the resource is allowed to be observed by clients.*/
 614     OC_OBSERVABLE    = (1 << 1),
 615
 616     /** When this bit is set, the resource is initialized, otherwise the resource
 617      *  is 'inactive'. 'inactive' signifies that the resource has been marked for
 618      *  deletion or is already deleted.*/
 619     OC_ACTIVE        = (1 << 2),
 620
 621     /** When this bit is set, the resource has been marked as 'slow'.
 622      * 'slow' signifies that responses from this resource can expect delays in
 623      *  processing its requests from clients.*/
 624     OC_SLOW          = (1 << 3),
 625
 626     /** When this bit is set, the resource is a secure resource.*/
 627     OC_SECURE        = (1 << 4),
 628
 629     /** When this bit is set, the resource is allowed to be discovered only
 630      *  if discovery request contains an explicit querystring.
 631      *  Ex: GET /oic/res?rt=oic.sec.acl */
 632     OC_EXPLICIT_DISCOVERABLE   = (1 << 5)
 633 } OCResourceProperty;
 634
 635 /**
 636  * Transport Protocol IDs.
 637  */
 638 typedef enum
 639 {
 640     /** For invalid ID.*/
 641     OC_INVALID_ID   = (1 << 0),
 642
 643     /* For coap ID.*/
 644     OC_COAP_ID      = (1 << 1)
 645 } OCTransportProtocolID;
 646
 647 /**
 648  * Declares Stack Results & Errors.
 649  */
 650 typedef enum
 651 {
 652     /** Success status code - START HERE.*/
 653     OC_STACK_OK = 0,
 654     OC_STACK_RESOURCE_CREATED,
 655     OC_STACK_RESOURCE_DELETED,
 656     OC_STACK_CONTINUE,
 657     /** Success status code - END HERE.*/
 658
 659     /** Error status code - START HERE.*/
 660     OC_STACK_INVALID_URI = 20,
 661     OC_STACK_INVALID_QUERY,
 662     OC_STACK_INVALID_IP,
 663     OC_STACK_INVALID_PORT,
 664     OC_STACK_INVALID_CALLBACK,
 665     OC_STACK_INVALID_METHOD,
 666
 667     /** Invalid parameter.*/
 668     OC_STACK_INVALID_PARAM,
 669     OC_STACK_INVALID_OBSERVE_PARAM,
 670     OC_STACK_NO_MEMORY,
 671     OC_STACK_COMM_ERROR,
 672     OC_STACK_TIMEOUT,
 673     OC_STACK_ADAPTER_NOT_ENABLED,
 674     OC_STACK_NOTIMPL,
 675
 676     /** Resource not found.*/
 677     OC_STACK_NO_RESOURCE,
 678
 679     /** e.g: not supported method or interface.*/
 680     OC_STACK_RESOURCE_ERROR,
 681     OC_STACK_SLOW_RESOURCE,
 682     OC_STACK_DUPLICATE_REQUEST,
 683
 684     /** Resource has no registered observers.*/
 685     OC_STACK_NO_OBSERVERS,
 686     OC_STACK_OBSERVER_NOT_FOUND,
 687     OC_STACK_VIRTUAL_DO_NOT_HANDLE,
 688     OC_STACK_INVALID_OPTION,
 689
 690     /** The remote reply contained malformed data.*/
 691     OC_STACK_MALFORMED_RESPONSE,
 692     OC_STACK_PERSISTENT_BUFFER_REQUIRED,
 693     OC_STACK_INVALID_REQUEST_HANDLE,
 694     OC_STACK_INVALID_DEVICE_INFO,
 695     OC_STACK_INVALID_JSON,
 696
 697     /** Request is not authorized by Resource Server. */
 698     OC_STACK_UNAUTHORIZED_REQ,
 699
 700     /** Error code from PDM */
 701     OC_STACK_PDM_IS_NOT_INITIALIZED,
 702     OC_STACK_DUPLICATE_UUID,
 703     OC_STACK_INCONSISTENT_DB,
 704
 705     /** Insert all new error codes here!.*/
 706     #ifdef WITH_PRESENCE
 707     OC_STACK_PRESENCE_STOPPED = 128,
 708     OC_STACK_PRESENCE_TIMEOUT,
 709     OC_STACK_PRESENCE_DO_NOT_HANDLE,
 710     #endif
 711     /** ERROR in stack.*/
 712     OC_STACK_ERROR = 255
 713     /** Error status code - END HERE.*/
 714 } OCStackResult;
 715
 716 /**
 717  * Handle to an OCDoResource invocation.
 718  */
 719 typedef void * OCDoHandle;
 720
 721 /**
 722  * Handle to an OCResource object owned by the OCStack.
 723  */
 724 typedef void * OCResourceHandle;
 725
 726 /**
 727  * Handle to an OCRequest object owned by the OCStack.
 728  */
 729 typedef void * OCRequestHandle;
 730
 731 /**
 732  * Unique identifier for each observation request. Used when observations are
 733  * registered or de-registered. Used by entity handler to signal specific
 734  * observers to be notified of resource changes.
 735  * There can be maximum of 256 observations per server.
 736  */
 737 typedef uint8_t OCObservationId;
 738
 739 /**
 740  * Action associated with observation.
 741  */
 742 typedef enum
 743 {
 744     /** To Register. */
 745     OC_OBSERVE_REGISTER = 0,
 746
 747     /** To Deregister. */
 748     OC_OBSERVE_DEREGISTER = 1,
 749
 750     /** Others. */
 751     OC_OBSERVE_NO_OPTION = 2
 752 } OCObserveAction;
 753
 754
 755 /**
 756  * Persistent storage handlers. An APP must provide OCPersistentStorage handler pointers
 757  * when it calls OCRegisterPersistentStorageHandler.
 758  * Persistent storage open handler points to default file path.
 759  * Application can point to appropriate SVR database path for it's IoTivity Server.
 760  */
 761 typedef struct {
 762     /** Persistent storage file path.*/
 763     FILE* (* open)(const char *path, const char *mode);
 764
 765     /** Persistent storage read handler.*/
 766     size_t (* read)(void *ptr, size_t size, size_t nmemb, FILE *stream);
 767
 768     /** Persistent storage write handler.*/
 769     size_t (* write)(const void *ptr, size_t size, size_t nmemb, FILE *stream);
 770
 771     /** Persistent storage close handler.*/
 772     int (* close)(FILE *fp);
 773
 774     /** Persistent storage unlink handler.*/
 775     int (* unlink)(const char *path);
 776 } OCPersistentStorage;
 777
 778 /**
 779  * Possible returned values from entity handler.
 780  */
 781 typedef struct
 782 {
 783     /** Action associated with observation request.*/
 784     OCObserveAction action;
 785
 786     /** Identifier for observation being registered/deregistered.*/
 787     OCObservationId obsId;
 788 } OCObservationInfo;
 789
 790 /**
 791  * Possible returned values from entity handler.
 792  */
 793 typedef enum
 794 {
 795     OC_EH_OK = 0,
 796     OC_EH_ERROR,
 797     OC_EH_RESOURCE_CREATED,
 798     OC_EH_RESOURCE_DELETED,
 799     OC_EH_SLOW,
 800     OC_EH_FORBIDDEN,
 801     OC_EH_RESOURCE_NOT_FOUND
 802 } OCEntityHandlerResult;
 803
 804 /**
 805  * This structure will be used to define the vendor specific header options to be included
 806  * in communication packets.
 807  */
 808 typedef struct OCHeaderOption
 809 {
 810     /** The protocol ID this option applies to.*/
 811     OCTransportProtocolID protocolID;
 812
 813     /** The header option ID which will be added to communication packets.*/
 814     uint16_t optionID;
 815
 816     /** its length 191.*/
 817     uint16_t optionLength;
 818
 819     /** pointer to its data.*/
 820     uint8_t optionData[MAX_HEADER_OPTION_DATA_LENGTH];
 821
 822 #ifdef SUPPORTS_DEFAULT_CTOR
 823     OCHeaderOption() = default;
 824     OCHeaderOption(OCTransportProtocolID pid,
 825                    uint16_t optId,
 826                    uint16_t optlen,
 827                    const uint8_t* optData)
 828         : protocolID(pid),
 829           optionID(optId),
 830           optionLength(optlen)
 831     {
 832
 833         // parameter includes the null terminator.
 834         optionLength = optionLength < MAX_HEADER_OPTION_DATA_LENGTH ?
 835                         optionLength : MAX_HEADER_OPTION_DATA_LENGTH;
 836         memcpy(optionData, optData, optionLength);
 837         optionData[optionLength - 1] = '\0';
 838     }
 839 #endif
 840 } OCHeaderOption;
 841
 842
 843 /**
 844  * This structure describes the platform properties. All non-Null properties will be
 845  * included in a platform discovery request.
 846  */
 847 typedef struct
 848 {
 849     /** Platform ID.*/
 850     char *platformID;
 851
 852     /** Manufacturer name.*/
 853     char *manufacturerName;
 854
 855     /** Manufacturer URL for platform property.*/
 856     char *manufacturerUrl;
 857
 858     /** Model number.*/
 859     char *modelNumber;
 860
 861     /** Manufacturer date.*/
 862     char *dateOfManufacture;
 863
 864     /** Platform version.*/
 865     char *platformVersion;
 866
 867     /** Operating system version.*/
 868     char *operatingSystemVersion;
 869
 870     /** HW version.*/
 871     char *hardwareVersion;
 872
 873     /** FW version.*/
 874     char *firmwareVersion;
 875
 876     /** Platform support URL.*/
 877     char *supportUrl;
 878
 879     /** System time.*/
 880     char *systemTime;
 881
 882 } OCPlatformInfo;
 883
 884 /**
 885  * This structure is expected as input for device properties.
 886  * device name is mandatory and expected from the application.
 887  * device id of type UUID will be generated by the stack.
 888  */
 889 typedef struct
 890 {
 891     /** Pointer to the device name.*/
 892     char *deviceName;
 893
 894 } OCDeviceInfo;
 895
 896 #ifdef RA_ADAPTER
 897 /**
 898  * callback for bound JID
 899  */
 900 typedef void (*jid_bound_cb)(char *jid);
 901
 902 /**
 903  * CA Remote Access information for XMPP Client
 904  *
 905  */
 906 typedef struct
 907 {
 908     char *hostname;     /**< XMPP server hostname */
 909     uint16_t   port;    /**< XMPP server serivce port */
 910     char *xmpp_domain;  /**< XMPP login domain */
 911     char *username;     /**< login username */
 912     char *password;     /**< login password */
 913     char *resource;     /**< specific resource for login */
 914     char *user_jid;     /**< specific JID for login */
 915     jid_bound_cb jidbound;  /**< callback when JID bound */
 916 } OCRAInfo_t;
 917 #endif  /* RA_ADAPTER */
 918
 919
 920 /** Enum to describe the type of object held by the OCPayload object.*/
 921 typedef enum
 922 {
 923     PAYLOAD_TYPE_INVALID,
 924     PAYLOAD_TYPE_DISCOVERY,
 925     PAYLOAD_TYPE_DEVICE,
 926     PAYLOAD_TYPE_PLATFORM,
 927     PAYLOAD_TYPE_REPRESENTATION,
 928     PAYLOAD_TYPE_SECURITY,
 929     PAYLOAD_TYPE_PRESENCE,
 930     PAYLOAD_TYPE_RD
 931 } OCPayloadType;
 932
 933 typedef struct
 934 {
 935     // The type of message that was received
 936     OCPayloadType type;
 937 } OCPayload;
 938
 939 typedef enum
 940 {
 941     OCREP_PROP_NULL,
 942     OCREP_PROP_INT,
 943     OCREP_PROP_DOUBLE,
 944     OCREP_PROP_BOOL,
 945     OCREP_PROP_STRING,
 946     OCREP_PROP_BYTE_STRING,
 947     OCREP_PROP_OBJECT,
 948     OCREP_PROP_ARRAY
 949 }OCRepPayloadPropType;
 950
 951 /** This structure will be used to represent a binary string for CBOR payloads.*/
 952 typedef struct
 953 {
 954     /** pointer to data bytes.*/
 955     uint8_t* bytes;
 956
 957     /** number of data bytes.*/
 958     size_t   len;
 959 } OCByteString;
 960
 961 #define MAX_REP_ARRAY_DEPTH 3
 962 typedef struct
 963 {
 964     OCRepPayloadPropType type;
 965     size_t dimensions[MAX_REP_ARRAY_DEPTH];
 966
 967     union
 968     {
 969         int64_t* iArray;
 970         double* dArray;
 971         bool* bArray;
 972         char** strArray;
 973
 974         /** pointer to ByteString array.*/
 975         OCByteString* ocByteStrArray;
 976
 977         struct OCRepPayload** objArray;
 978     };
 979 } OCRepPayloadValueArray;
 980
 981 typedef struct OCRepPayloadValue
 982 {
 983     char* name;
 984     OCRepPayloadPropType type;
 985     union
 986     {
 987         int64_t i;
 988         double d;
 989         bool b;
 990         char* str;
 991
 992         /** ByteString object.*/
 993         OCByteString ocByteStr;
 994
 995         struct OCRepPayload* obj;
 996         OCRepPayloadValueArray arr;
 997     };
 998     struct OCRepPayloadValue* next;
 999
1000 } OCRepPayloadValue;
1001
1002 typedef struct OCStringLL
1003 {
1004     struct OCStringLL *next;
1005     char* value;
1006 } OCStringLL;
1007
1008 // used for get/set/put/observe/etc representations
1009 typedef struct OCRepPayload
1010 {
1011     OCPayload base;
1012     char* uri;
1013     OCStringLL* types;
1014     OCStringLL* interfaces;
1015     OCRepPayloadValue* values;
1016     struct OCRepPayload* next;
1017 } OCRepPayload;
1018
1019 // used inside a discovery payload
1020 typedef struct OCResourcePayload
1021 {
1022     char* uri;
1023     uint8_t* sid;
1024     OCStringLL* types;
1025     OCStringLL* interfaces;
1026     uint8_t bitmap;
1027     bool secure;
1028     uint16_t port;
1029     struct OCResourcePayload* next;
1030 } OCResourcePayload;
1031
1032 /**
1033  * Structure holding Links Payload. It is a sub-structure used in
1034  * OCResourceCollectionPayload.
1035  */
1036 typedef struct OCLinksPayload
1037 {
1038     /** This is the target relative URI. */
1039     char *href;
1040     /** Resource Type - A standard OIC specified or vendor defined resource
1041      * type of the resource referenced by the target URI. */
1042     OCStringLL *rt;
1043     /** Interface - The interfaces supported by the resource referenced by the target URI. */
1044     OCStringLL *itf;
1045     /** The relation of the target URI referenced by the link to the context URI;
1046      * The default value is null. */
1047     char *rel;
1048     /** Specifies if the resource referenced by the target URIis observable or not. */
1049     bool obs;
1050     /** A title for the link relation. Can be used by the UI to provide a context. */
1051     char *title;
1052     /** This is used to override the context URI e.g. override the URI of the containing collection. */
1053     char *uri;
1054     /** The instance identifier for this web link in an array of web links - used in links. */
1055     union
1056     {
1057         /** An ordinal number that is not repeated - must be unique in the collection context. */
1058         uint8_t ins;
1059         /** Any unique string including a URI. */
1060         char *uniqueStr;
1061         /** Use UUID for universal uniqueness - used in /oic/res to identify the device. */
1062         OCIdentity uniqueUUID;
1063     };
1064     /** A hint of the media type of the representation of the resource referenced by the target URI. */
1065     OCStringLL *mt;
1066     /** Holding address of the next resource. */
1067     struct OCLinksPayload *next;
1068 } OCLinksPayload;
1069
1070 /** Structure holding tags value of the links payload. */
1071 typedef struct
1072 {
1073     /** Name of tags. */
1074     OCDeviceInfo n;
1075     /** Device identifier. */
1076     OCIdentity di;
1077     /** The base URI where the resources are hold. */
1078     char *baseURI;
1079     /** Bitmap holds observable, discoverable, secure option flag.*/
1080     uint8_t bitmap;
1081     /** Port set in case, the secure flag is set above. */
1082     uint16_t port;
1083     /** Id for each set of links i.e. tag. */
1084     union
1085     {
1086         /** An ordinal number that is not repeated - must be unique in the collection context. */
1087         uint8_t ins;
1088         /** Any unique string including a URI. */
1089         char *uniqueStr;
1090         /** Use UUID for universal uniqueness - used in /oic/res to identify the device. */
1091         OCIdentity uniqueUUID;
1092     };
1093     /** Defines the list of allowable resource types (for Target and anchors) in links included
1094      * in the collection; new links being created can only be from this list. */
1095     char *rts;
1096     /** When specified this is the default relationship to use when an OIC Link does not specify
1097      * an explicit relationship with *rel* parameter. */
1098     char *drel;
1099     /** Time to keep holding resource.*/
1100     uint32_t ttl;
1101 } OCTagsPayload;
1102
1103 /** Resource collection payload. */
1104 typedef struct OCResourceCollectionPayload
1105 {
1106     /** Collection tags payload.*/
1107     OCTagsPayload *tags;
1108     /** Array of links payload. */
1109     OCLinksPayload *setLinks;
1110     /** Holding address of the next resource. */
1111     struct OCResourceCollectionPayload *next;
1112 } OCResourceCollectionPayload;
1113
1114 typedef struct
1115 {
1116     OCPayload base;
1117     /** This structure holds the old /oic/res response. */
1118     OCResourcePayload *resources;
1119     /** This structure holds the collection response for the /oic/res. */
1120     OCResourceCollectionPayload *collectionResources;
1121 } OCDiscoveryPayload;
1122
1123 /**
1124  * Structure holding discovery payload.
1125  */
1126 typedef struct
1127 {
1128     /** Device Name. */
1129     OCDeviceInfo n;
1130     /** Device Identity. */
1131     OCIdentity di;
1132     /** Value holding the bias factor of the RD. */
1133     uint8_t sel;
1134 } OCRDDiscoveryPayload;
1135
1136 /**
1137  * RD Payload that will be transmitted over the wire.
1138  */
1139 typedef struct
1140 {
1141     OCPayload base;
1142     /** Pointer to the discovery response payload.*/
1143     OCRDDiscoveryPayload *rdDiscovery;
1144     /** Pointer to the publish payload.*/
1145     OCResourceCollectionPayload *rdPublish;
1146 } OCRDPayload;
1147
1148 typedef struct
1149 {
1150     OCPayload base;
1151     char* uri;
1152     uint8_t* sid;
1153     char* deviceName;
1154     char* specVersion;
1155     char* dataModelVersion;
1156 } OCDevicePayload;
1157
1158 typedef struct
1159 {
1160     OCPayload base;
1161     char* uri;
1162     OCPlatformInfo info;
1163 } OCPlatformPayload;
1164
1165 typedef struct
1166 {
1167     OCPayload base;
1168     char* securityData;
1169 } OCSecurityPayload;
1170 #ifdef WITH_PRESENCE
1171 typedef struct
1172 {
1173     OCPayload base;
1174     uint32_t sequenceNumber;
1175     uint32_t maxAge;
1176     OCPresenceTrigger trigger;
1177     char* resourceType;
1178 } OCPresencePayload;
1179 #endif
1180
1181 /**
1182  * Incoming requests handled by the server. Requests are passed in as a parameter to the
1183  * OCEntityHandler callback API.
1184  * The OCEntityHandler callback API must be implemented in the application in order
1185  * to receive these requests.
1186  */
1187 typedef struct
1188 {
1189     /** Associated resource.*/
1190     OCResourceHandle resource;
1191
1192     /** Associated request handle.*/
1193     OCRequestHandle requestHandle;
1194
1195     /** the REST method retrieved from received request PDU.*/
1196     OCMethod method;
1197
1198     /** description of endpoint that sent the request.*/
1199     OCDevAddr devAddr;
1200
1201     /** resource query send by client.*/
1202     char * query;
1203
1204     /** Information associated with observation - valid only when OCEntityHandler flag includes
1205      * ::OC_OBSERVE_FLAG.*/
1206     OCObservationInfo obsInfo;
1207
1208     /** Number of the received vendor specific header options.*/
1209     uint8_t numRcvdVendorSpecificHeaderOptions;
1210
1211     /** Pointer to the array of the received vendor specific header options.*/
1212     OCHeaderOption * rcvdVendorSpecificHeaderOptions;
1213
1214     /** the payload from the request PDU.*/
1215     OCPayload *payload;
1216
1217 } OCEntityHandlerRequest;
1218
1219
1220 /**
1221  * Response from queries to remote servers. Queries are made by calling the OCDoResource API.
1222  */
1223 typedef struct
1224 {
1225     /** Address of remote server.*/
1226     OCDevAddr devAddr;
1227
1228     /** backward compatibility (points to devAddr).*/
1229     OCDevAddr *addr;
1230
1231     /** backward compatibility.*/
1232     OCConnectivityType connType;
1233
1234     /** the security identity of the remote server.*/
1235     OCIdentity identity;
1236
1237     /** the is the result of our stack, OCStackResult should contain coap/other error codes.*/
1238     OCStackResult result;
1239
1240     /** If associated with observe, this will represent the sequence of notifications from server.*/
1241     uint32_t sequenceNumber;
1242
1243     /** resourceURI.*/
1244     const char * resourceUri;
1245
1246     /** the payload for the response PDU.*/
1247     OCPayload *payload;
1248
1249     /** Number of the received vendor specific header options.*/
1250     uint8_t numRcvdVendorSpecificHeaderOptions;
1251
1252     /** An array of the received vendor specific header options.*/
1253     OCHeaderOption rcvdVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1254 } OCClientResponse;
1255
1256 /**
1257  * Request handle is passed to server via the entity handler for each incoming request.
1258  * Stack assigns when request is received, server sets to indicate what request response is for.
1259  */
1260 typedef struct
1261 {
1262     /** Request handle.*/
1263     OCRequestHandle requestHandle;
1264
1265     /** Resource handle.*/
1266     OCResourceHandle resourceHandle;
1267
1268     /** Allow the entity handler to pass a result with the response.*/
1269     OCEntityHandlerResult  ehResult;
1270
1271     /** This is the pointer to server payload data to be transferred.*/
1272     OCPayload* payload;
1273
1274     /** number of the vendor specific header options .*/
1275     uint8_t numSendVendorSpecificHeaderOptions;
1276
1277     /** An array of the vendor specific header options the entity handler wishes to use in response.*/
1278     OCHeaderOption sendVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1279
1280     /** URI of new resource that entity handler might create.*/
1281     char resourceUri[MAX_URI_LENGTH];
1282
1283     /** Server sets to true for persistent response buffer,false for non-persistent response buffer*/
1284     uint8_t persistentBufferFlag;
1285 } OCEntityHandlerResponse;
1286
1287 /**
1288  * Entity's state
1289  */
1290 typedef enum
1291 {
1292     /** Request state.*/
1293     OC_REQUEST_FLAG = (1 << 1),
1294     /** Observe state.*/
1295     OC_OBSERVE_FLAG = (1 << 2)
1296 } OCEntityHandlerFlag;
1297
1298 /**
1299  * Possible returned values from client application.
1300  */
1301 typedef enum
1302 {
1303     OC_STACK_DELETE_TRANSACTION = 0,
1304     OC_STACK_KEEP_TRANSACTION
1305 } OCStackApplicationResult;
1306
1307
1308 /*
1309  * -------------------------------------------------------------------------------------------
1310  * Callback function definitions
1311  * -------------------------------------------------------------------------------------------
1312  */
1313
1314 /**
1315  * Client applications implement this callback to consume responses received from Servers.
1316  */
1317 typedef OCStackApplicationResult (* OCClientResponseHandler)(void *context, OCDoHandle handle,
1318     OCClientResponse * clientResponse);
1319
1320 /**
1321  * Client applications using a context pointer implement this callback to delete the
1322  * context upon removal of the callback/context pointer from the internal callback-list.
1323  */
1324 typedef void (* OCClientContextDeleter)(void *context);
1325
1326 /**
1327  * This info is passed from application to OC Stack when initiating a request to Server.
1328  */
1329 typedef struct OCCallbackData
1330 {
1331     /** Pointer to the context.*/
1332     void *context;
1333
1334     /** The pointer to a function the stack will call to handle the requests.*/
1335     OCClientResponseHandler cb;
1336
1337     /** A pointer to a function to delete the context when this callback is removed.*/
1338     OCClientContextDeleter cd;
1339
1340 #ifdef SUPPORTS_DEFAULT_CTOR
1341     OCCallbackData() = default;
1342     OCCallbackData(void* ctx, OCClientResponseHandler callback, OCClientContextDeleter deleter)
1343         :context(ctx), cb(callback), cd(deleter){}
1344 #endif
1345 } OCCallbackData;
1346
1347 /**
1348  * Application server implementations must implement this callback to consume requests OTA.
1349  * Entity handler callback needs to fill the resPayload of the entityHandlerRequest.
1350  */
1351 typedef OCEntityHandlerResult (*OCEntityHandler)
1352 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, void* callbackParam);
1353
1354 /**
1355  * Device Entity handler need to use this call back instead of OCEntityHandler.
1356  */
1357 typedef OCEntityHandlerResult (*OCDeviceEntityHandler)
1358 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, char* uri, void* callbackParam);
1359
1360 #ifdef __cplusplus
1361 }
1362 #endif // __cplusplus
1363
1364 #endif /* OCTYPES_H_ */