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