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