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