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