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