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