resource/csdk/stack/include/octypes.h

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