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 "ocstackconfig.h"
  32 #include <stdbool.h>
  33 #include <stdint.h>
  34 #include <stdio.h>
  35 #ifdef __cplusplus
  36 #include <string.h>
  37
  38 extern "C" {
  39 #endif // __cplusplus
  40
  41 /** For the feature presence.*/
  42 #define WITH_PRESENCE
  43
  44 #include "ocpresence.h"
  45 //-----------------------------------------------------------------------------
  46 // Defines
  47 //-----------------------------------------------------------------------------
  48
  49 /**
  50  * OIC Virtual resources supported by every OIC device.
  51  */
  52 /**
  53  *  Default discovery mechanism using '/oic/res' is supported by all OIC devices
  54  *  That are Discoverable.
  55  */
  56 #define OC_RSRVD_WELL_KNOWN_URI               "/oic/res"
  57
  58 /** Device URI.*/
  59 #define OC_RSRVD_DEVICE_URI                   "/oic/d"
  60
  61 /** Platform URI.*/
  62 #define OC_RSRVD_PLATFORM_URI                 "/oic/p"
  63
  64 /** Resource Type.*/
  65 #define OC_RSRVD_RESOURCE_TYPES_URI           "/oic/res/types/d"
  66
  67 #ifdef WITH_PRESENCE
  68
  69 /** Presence URI through which the OIC devices advertise their presence.*/
  70 #define OC_RSRVD_PRESENCE_URI                 "/oic/ad"
  71
  72 /** Sets the default time to live (TTL) for presence.*/
  73 #define OC_DEFAULT_PRESENCE_TTL_SECONDS (60)
  74
  75 /** For multicast Discovery mechanism.*/
  76 #define OC_MULTICAST_DISCOVERY_URI           "/oic/res"
  77
  78 /** Separator for multiple query string.*/
  79 #define OC_QUERY_SEPARATOR                "&;"
  80
  81 /**
  82  *  OC_DEFAULT_PRESENCE_TTL_SECONDS sets the default time to live (TTL) for presence.
  83  */
  84 #define OC_DEFAULT_PRESENCE_TTL_SECONDS (60)
  85
  86 /**
  87  *  OC_MAX_PRESENCE_TTL_SECONDS sets the maximum time to live (TTL) for presence.
  88  *  NOTE: Changing the setting to a longer duration may lead to unsupported and untested
  89  *  operation.
  90  *  60 sec/min * 60 min/hr * 24 hr/day
  91  */
  92 #define OC_MAX_PRESENCE_TTL_SECONDS     (60 * 60 * 24)
  93 #endif
  94
  95 /**
  96  *  Presence "Announcement Triggers".
  97  */
  98
  99 /** To create.*/
 100 #define OC_RSRVD_TRIGGER_CREATE         "create"
 101
 102 /** To change.*/
 103 #define OC_RSRVD_TRIGGER_CHANGE         "change"
 104
 105 /** To delete.*/
 106 #define OC_RSRVD_TRIGGER_DELETE         "delete"
 107
 108 /**
 109  *  Attributes used to form a proper OIC conforming JSON message.
 110  */
 111
 112 #define OC_RSRVD_OC                     "oic"
 113
 114 /** For payload. */
 115
 116 #define OC_RSRVD_PAYLOAD                "payload"
 117
 118 /** To represent href */
 119 #define OC_RSRVD_HREF                   "href"
 120
 121 /** To represent property*/
 122 #define OC_RSRVD_PROPERTY               "prop"
 123
 124 /** For representation.*/
 125 #define OC_RSRVD_REPRESENTATION         "rep"
 126
 127 /** To represent content type.*/
 128 #define OC_RSRVD_CONTENT_TYPE           "ct"
 129
 130 /** To represent resource type.*/
 131 #define OC_RSRVD_RESOURCE_TYPE          "rt"
 132
 133 /** To represent resource type with presence.*/
 134 #define OC_RSRVD_RESOURCE_TYPE_PRESENCE "oic.wk.ad"
 135
 136 /** To represent interface.*/
 137 #define OC_RSRVD_INTERFACE              "if"
 138
 139 /** To represent time to live.*/
 140 #define OC_RSRVD_TTL                    "ttl"
 141
 142 /** To represent non*/
 143 #define OC_RSRVD_NONCE                  "non"
 144
 145 /** To represent trigger type.*/
 146 #define OC_RSRVD_TRIGGER                "trg"
 147
 148 /** To represent links.*/
 149 #define OC_RSRVD_LINKS                  "links"
 150
 151 /** To represent default interface.*/
 152 #define OC_RSRVD_INTERFACE_DEFAULT      "oic.if.baseline"
 153
 154 /** To represent ll interface.*/
 155 #define OC_RSRVD_INTERFACE_LL           "oic.if.ll"
 156
 157 /** To represent batch interface.*/
 158 #define OC_RSRVD_INTERFACE_BATCH        "oic.if.b"
 159
 160 /** To represent interface group.*/
 161 #define OC_RSRVD_INTERFACE_GROUP        "oic.mi.grp"
 162
 163 /** To represent MFG date.*/
 164 #define OC_RSRVD_MFG_DATE               "mndt"
 165
 166 /** To represent FW version.*/
 167 #define OC_RSRVD_FW_VERSION             "mnfv"
 168
 169 /** To represent host name.*/
 170 #define OC_RSRVD_HOST_NAME              "hn"
 171
 172 /** To represent version.*/
 173 #define OC_RSRVD_VERSION                "icv"
 174
 175 /** To represent policy.*/
 176 #define OC_RSRVD_POLICY                 "p"
 177
 178 /** To represent bitmap.*/
 179 #define OC_RSRVD_BITMAP                 "bm"
 180
 181 /** For security.*/
 182 #define OC_RSRVD_SECURE                 "sec"
 183
 184 /** Port. */
 185 #define OC_RSRVD_HOSTING_PORT           "port"
 186
 187 /** For Server instance ID.*/
 188 #define OC_RSRVD_SERVER_INSTANCE_ID     "sid"
 189
 190 /**
 191  *  Platform.
 192  */
 193
 194 /** Platform ID. */
 195 #define OC_RSRVD_PLATFORM_ID            "pi"
 196
 197 /** Platform MFG NAME. */
 198 #define OC_RSRVD_MFG_NAME               "mnmn"
 199
 200 /** Platform URL. */
 201 #define OC_RSRVD_MFG_URL                "mnml"
 202
 203 /** Model Number.*/
 204 #define OC_RSRVD_MODEL_NUM              "mnmo"
 205
 206 /** Platform MFG Date.*/
 207 #define OC_RSRVD_MFG_DATE               "mndt"
 208
 209 /** Platform versio.n */
 210 #define OC_RSRVD_PLATFORM_VERSION       "mnpv"
 211
 212 /** Platform Operating system version. */
 213 #define OC_RSRVD_OS_VERSION             "mnos"
 214
 215 /** Platform Hardware version. */
 216 #define OC_RSRVD_HARDWARE_VERSION       "mnhw"
 217
 218 /**Platform Firmware version. */
 219 #define OC_RSRVD_FIRMWARE_VERSION       "mnfv"
 220
 221 /** Support URL for the platform. */
 222 #define OC_RSRVD_SUPPORT_URL            "mnsl"
 223
 224 /** System time for the platform. */
 225 #define OC_RSRVD_SYSTEM_TIME             "st"
 226
 227 /**
 228  *  Device.
 229  */
 230
 231 /** Device ID.*/
 232 #define OC_RSRVD_DEVICE_ID              "di"
 233
 234 /** Device Name.*/
 235 #define OC_RSRVD_DEVICE_NAME            "n"
 236
 237 /** Device specification version.*/
 238 #define OC_RSRVD_SPEC_VERSION           "lcv"
 239
 240 /** Device data model.*/
 241 #define OC_RSRVD_DATA_MODEL_VERSION     "dmv"
 242
 243 /** Device specification version.*/
 244 #define OC_SPEC_VERSION                "0.9.0"
 245
 246 /** Device Data Model version.*/
 247 #define OC_DATA_MODEL_VERSION          "sec.0.95"
 248
 249 /**
 250  *  These provide backward compatibility - their use is deprecated.
 251  */
 252 #ifndef GOING_AWAY
 253
 254 /** Multicast Prefix.*/
 255 #define OC_MULTICAST_PREFIX                  "224.0.1.187:5683"
 256
 257 /** Multicast IP address.*/
 258 #define OC_MULTICAST_IP                      "224.0.1.187"
 259
 260 /** Multicast Port.*/
 261 #define OC_MULTICAST_PORT                    5683
 262 #endif // GOING_AWAY
 263
 264 /** Max Device address size. */
 265 #ifdef RA_ADAPTER
 266 #define MAX_ADDR_STR_SIZE (256)
 267 #else
 268 #define MAX_ADDR_STR_SIZE (40)
 269 #endif
 270
 271 /** Max identity size. */
 272 #define MAX_IDENTITY_SIZE (32)
 273
 274 /**
 275  * These enums (OCTransportAdapter and OCTransportFlags) must
 276  * be kept synchronized with OCConnectivityType (below) as well as
 277  * CATransportAdapter and CATransportFlags (in CACommon.h).
 278  */
 279 typedef enum
 280 {
 281     /** value zero indicates discovery.*/
 282     OC_DEFAULT_ADAPTER = 0,
 283
 284     /** IPv4 and IPv6, including 6LoWPAN.*/
 285     OC_ADAPTER_IP           = (1 << 0),
 286
 287     /** GATT over Bluetooth LE.*/
 288     OC_ADAPTER_GATT_BTLE    = (1 << 1),
 289
 290     /** RFCOMM over Bluetooth EDR.*/
 291     OC_ADAPTER_RFCOMM_BTEDR = (1 << 2),
 292
 293 #ifdef RA_ADAPTER
 294     /**Remote Access over XMPP.*/
 295    OC_ADAPTER_REMOTE_ACCESS = (1 << 3)
 296 #endif
 297
 298 } OCTransportAdapter;
 299
 300 /**
 301  *  Enum layout assumes some targets have 16-bit integer (e.g., Arduino).
 302  */
 303 typedef enum
 304 {
 305     /** default flag is 0*/
 306     OC_DEFAULT_FLAGS = 0,
 307
 308     /** Insecure transport is the default (subject to change).*/
 309     /** secure the transport path*/
 310     OC_FLAG_SECURE     = (1 << 4),
 311
 312     /** IPv4 & IPv6 auto-selection is the default.*/
 313     /** IP adapter only.*/
 314     OC_IP_USE_V6       = (1 << 5),
 315
 316     /** IP adapter only.*/
 317     OC_IP_USE_V4       = (1 << 6),
 318
 319     /** internal use only.*/
 320     OC_RESERVED1       = (1 << 7),   // internal use only
 321
 322     /** Link-Local multicast is the default multicast scope for IPv6.
 323      *  These are placed here to correspond to the IPv6 multicast address bits.*/
 324
 325     /** IPv6 Interface-Local scope (loopback).*/
 326     OC_SCOPE_INTERFACE = 0x1,
 327
 328     /** IPv6 Link-Local scope (default).*/
 329     OC_SCOPE_LINK      = 0x2,
 330
 331     /** IPv6 Realm-Local scope. */
 332     OC_SCOPE_REALM     = 0x3,
 333
 334     /** IPv6 Admin-Local scope. */
 335     OC_SCOPE_ADMIN     = 0x4,
 336
 337     /** IPv6 Site-Local scope. */
 338     OC_SCOPE_SITE      = 0x5,
 339
 340     /** IPv6 Organization-Local scope. */
 341     OC_SCOPE_ORG       = 0x8,
 342
 343     /**IPv6 Global scope. */
 344     OC_SCOPE_GLOBAL    = 0xE,
 345
 346 } OCTransportFlags;
 347
 348 /** Bit mask for scope.*/
 349 #define OC_MASK_SCOPE    (0x000F)
 350
 351 /** Bit mask for Mods.*/
 352 #define OC_MASK_MODS     (0x0FF0)
 353 #define OC_MASK_FAMS     (OC_IP_USE_V6|OC_IP_USE_V4)
 354
 355 /**
 356  * End point identity.
 357  */
 358 typedef struct
 359 {
 360     /** Identity Length */
 361     uint16_t id_length;
 362
 363     /** Array of end point identity.*/
 364     unsigned char id[MAX_IDENTITY_SIZE];
 365 } OCIdentity;
 366
 367 /**
 368  * Data structure to encapsulate IPv4/IPv6/Contiki/lwIP device addresses.
 369  * OCDevAddr must be the same as CAEndpoint (in CACommon.h).
 370  */
 371 typedef struct
 372 {
 373     /** adapter type.*/
 374     OCTransportAdapter      adapter;
 375
 376     /** transport modifiers.*/
 377     OCTransportFlags        flags;
 378
 379     /** address for all adapters.*/
 380     char                    addr[MAX_ADDR_STR_SIZE];
 381
 382     /** usually zero for default interface.*/
 383     uint32_t                interface;
 384
 385     /** for IP.*/
 386     uint16_t                port;
 387
 388     /** secure node identity.*/
 389     OCIdentity              identity;
 390 } OCDevAddr;
 391
 392 /**
 393  * This enum type includes elements of both ::OCTransportAdapter and ::OCTransportFlags.
 394  * It is defined conditionally because the smaller definition limits expandability on 32/64 bit
 395  * integer machines, and the larger definition won't fit into an enum on 16-bit integer machines
 396  * like Arduino.
 397  *
 398  * This structure must directly correspond to ::OCTransportAdapter and ::OCTransportFlags.
 399  */
 400 typedef enum
 401 {
 402     /** use when defaults are ok. */
 403     CT_DEFAULT = 0,
 404
 405     /** 16-bit int. */
 406     #if defined (__UINT32_MAX__) && (__UINT32_MAX__ == 65535)
 407
 408     /** IPv4 and IPv6, including 6LoWPAN.*/
 409     CT_ADAPTER_IP           = (1 << 10),
 410
 411     /** GATT over Bluetooth LE.*/
 412     CT_ADAPTER_GATT_BTLE    = (1 << 11),
 413
 414     /** RFCOMM over Bluetooth EDR.*/
 415     CT_ADAPTER_RFCOMM_BTEDR = (1 << 12),
 416
 417     /** assume 32-bit int. */
 418     #else
 419
 420     /** IPv4 and IPv6, including 6LoWPAN.*/
 421     CT_ADAPTER_IP           = (1 << 16),
 422
 423     /** GATT over Bluetooth LE.*/
 424     CT_ADAPTER_GATT_BTLE    = (1 << 17),
 425
 426     /** RFCOMM over Bluetooth EDR.*/
 427     CT_ADAPTER_RFCOMM_BTEDR = (1 << 18),
 428
 429     #ifdef RA_ADAPTER
 430     /** Remote Access over XMPP.*/
 431     CT_ADAPTER_REMOTE_ACCESS = (1 << 19),
 432     #endif
 433
 434     /** bit shift required for connectivity adapter.*/
 435     #define CT_ADAPTER_SHIFT 10
 436
 437     /** Mask Flag.*/
 438     #define CT_MASK_FLAGS 0x03FF
 439
 440     /** Mask Adapter.*/
 441     #define CT_MASK_ADAPTER 0xFC00
 442
 443     #endif
 444
 445     /** Insecure transport is the default (subject to change).*/
 446
 447     /** secure the transport path.*/
 448     CT_FLAG_SECURE     = (1 << 4),
 449
 450     /** IPv4 & IPv6 autoselection is the default.*/
 451
 452     /** IP adapter only.*/
 453     CT_IP_USE_V6       = (1 << 5),
 454
 455     /** IP adapter only.*/
 456     CT_IP_USE_V4       = (1 << 6),
 457
 458     /** Link-Local multicast is the default multicast scope for IPv6.
 459      * These are placed here to correspond to the IPv6 address bits.*/
 460
 461     /** IPv6 Interface-Local scope(loopback).*/
 462     CT_SCOPE_INTERFACE = 0x1,
 463
 464     /** IPv6 Link-Local scope (default).*/
 465     CT_SCOPE_LINK      = 0x2,
 466
 467     /** IPv6 Realm-Local scope.*/
 468     CT_SCOPE_REALM     = 0x3,
 469
 470     /** IPv6 Admin-Local scope.*/
 471     CT_SCOPE_ADMIN     = 0x4,
 472
 473     /** IPv6 Site-Local scope.*/
 474     CT_SCOPE_SITE      = 0x5,
 475
 476     /** IPv6 Organization-Local scope.*/
 477     CT_SCOPE_ORG       = 0x8,
 478
 479     /** IPv6 Global scope.*/
 480     CT_SCOPE_GLOBAL    = 0xE,
 481 } OCConnectivityType;
 482
 483 /**
 484  *  OCDoResource methods to dispatch the request
 485  */
 486 typedef enum
 487 {
 488     OC_REST_NOMETHOD       = 0,
 489
 490     /** Read.*/
 491     OC_REST_GET            = (1 << 0),
 492
 493     /** Write.*/
 494     OC_REST_PUT            = (1 << 1),
 495
 496     /** Update.*/
 497     OC_REST_POST           = (1 << 2),
 498
 499     /** Delete.*/
 500     OC_REST_DELETE         = (1 << 3),
 501
 502     /** Register observe request for most up date notifications ONLY.*/
 503     OC_REST_OBSERVE        = (1 << 4),
 504
 505     /** Register observe request for all notifications, including stale notifications.*/
 506     OC_REST_OBSERVE_ALL    = (1 << 5),
 507
 508     /** De-register observation, intended for internal use.*/
 509     OC_REST_CANCEL_OBSERVE = (1 << 6),
 510
 511     #ifdef WITH_PRESENCE
 512     /** Subscribe for all presence notifications of a particular resource.*/
 513     OC_REST_PRESENCE       = (1 << 7),
 514
 515     #endif
 516     /** Allows OCDoResource caller to do discovery.*/
 517     OC_REST_DISCOVER       = (1 << 8)
 518 } OCMethod;
 519
 520 /**
 521  * Host Mode of Operation.
 522  */
 523 typedef enum
 524 {
 525     OC_CLIENT = 0,
 526     OC_SERVER,
 527     OC_CLIENT_SERVER
 528 } OCMode;
 529
 530 /**
 531  * Quality of Service attempts to abstract the guarantees provided by the underlying transport
 532  * protocol. The precise definitions of each quality of service level depend on the
 533  * implementation. In descriptions below are for the current implementation and may changed
 534  * over time.
 535  */
 536 typedef enum
 537 {
 538     /** Packet delivery is best effort.*/
 539     OC_LOW_QOS = 0,
 540
 541     /** Packet delivery is best effort.*/
 542     OC_MEDIUM_QOS,
 543
 544     /** Acknowledgments are used to confirm delivery.*/
 545     OC_HIGH_QOS,
 546
 547     /** No Quality is defined, let the stack decide.*/
 548     OC_NA_QOS
 549 } OCQualityOfService;
 550
 551 /**
 552  * Resource Properties.
 553  * The value of a policy property is defined as bitmap.
 554  * The LSB represents OC_DISCOVERABLE and Second LSB bit represents OC_OBSERVABLE and so on.
 555  * Not including the policy property is equivalent to zero.
 556  *
 557  * ::OC_RES_PROP_NONE When none of the bits are set, the resource is non-discoverable &
 558  *                    non-observable by the client.
 559  * ::OC_DISCOVERABLE  When this bit is set, the resource is allowed to be discovered by clients.
 560  * ::OC_OBSERVABLE    When this bit is set, the resource is allowed to be observed by clients.
 561
 562  */
 563 typedef enum
 564 {
 565     /** When none of the bits are set, the resource is non-discoverable &
 566      *  non-observable by the client.*/
 567     OC_RES_PROP_NONE = (0),
 568
 569     /** When this bit is set, the resource is allowed to be discovered by clients.*/
 570     OC_DISCOVERABLE  = (1 << 0),
 571
 572     /** When this bit is set, the resource is allowed to be observed by clients.*/
 573     OC_OBSERVABLE    = (1 << 1),
 574
 575     /** When this bit is set, the resource is initialized, otherwise the resource
 576      *  is 'inactive'. 'inactive' signifies that the resource has been marked for
 577      *  deletion or is already deleted.*/
 578     OC_ACTIVE        = (1 << 2),
 579
 580     /** When this bit is set, the resource has been marked as 'slow'.
 581      * 'slow' signifies that responses from this resource can expect delays in
 582      *  processing its requests from clients.*/
 583     OC_SLOW          = (1 << 3),
 584
 585     /** When this bit is set, the resource is a secure resource.*/
 586     OC_SECURE        = (1 << 4)
 587 } OCResourceProperty;
 588
 589 /**
 590  * Transport Protocol IDs.
 591  */
 592 typedef enum
 593 {
 594     /** For invalid ID.*/
 595     OC_INVALID_ID   = (1 << 0),
 596
 597     /* For coap ID.*/
 598     OC_COAP_ID      = (1 << 1)
 599 } OCTransportProtocolID;
 600
 601 /**
 602  * Declares Stack Results & Errors.
 603  */
 604 typedef enum
 605 {
 606     /** Success status code - START HERE.*/
 607     OC_STACK_OK = 0,
 608     OC_STACK_RESOURCE_CREATED,
 609     OC_STACK_RESOURCE_DELETED,
 610     OC_STACK_CONTINUE,
 611     /** Success status code - END HERE.*/
 612
 613     /** Error status code - START HERE.*/
 614     OC_STACK_INVALID_URI = 20,
 615     OC_STACK_INVALID_QUERY,
 616     OC_STACK_INVALID_IP,
 617     OC_STACK_INVALID_PORT,
 618     OC_STACK_INVALID_CALLBACK,
 619     OC_STACK_INVALID_METHOD,
 620
 621     /** Invalid parameter.*/
 622     OC_STACK_INVALID_PARAM,
 623     OC_STACK_INVALID_OBSERVE_PARAM,
 624     OC_STACK_NO_MEMORY,
 625     OC_STACK_COMM_ERROR,
 626     OC_STACK_TIMEOUT,
 627     OC_STACK_ADAPTER_NOT_ENABLED,
 628     OC_STACK_NOTIMPL,
 629
 630     /** Resource not found.*/
 631     OC_STACK_NO_RESOURCE,
 632
 633     /** e.g: not supported method or interface.*/
 634     OC_STACK_RESOURCE_ERROR,
 635     OC_STACK_SLOW_RESOURCE,
 636     OC_STACK_DUPLICATE_REQUEST,
 637
 638     /** Resource has no registered observers.*/
 639     OC_STACK_NO_OBSERVERS,
 640     OC_STACK_OBSERVER_NOT_FOUND,
 641     OC_STACK_VIRTUAL_DO_NOT_HANDLE,
 642     OC_STACK_INVALID_OPTION,
 643
 644     /** The remote reply contained malformed data.*/
 645     OC_STACK_MALFORMED_RESPONSE,
 646     OC_STACK_PERSISTENT_BUFFER_REQUIRED,
 647     OC_STACK_INVALID_REQUEST_HANDLE,
 648     OC_STACK_INVALID_DEVICE_INFO,
 649     OC_STACK_INVALID_JSON,
 650
 651     /** Request is not authorized by Resource Server. */
 652     OC_STACK_UNAUTHORIZED_REQ,
 653
 654     /** Insert all new error codes here!.*/
 655     #ifdef WITH_PRESENCE
 656     OC_STACK_PRESENCE_STOPPED = 128,
 657     OC_STACK_PRESENCE_TIMEOUT,
 658     OC_STACK_PRESENCE_DO_NOT_HANDLE,
 659     #endif
 660     /** ERROR in stack.*/
 661     OC_STACK_ERROR = 255
 662     /** Error status code - END HERE.*/
 663 } OCStackResult;
 664
 665 /**
 666  * Handle to an OCDoResource invocation.
 667  */
 668 typedef void * OCDoHandle;
 669
 670 /**
 671  * Handle to an OCResource object owned by the OCStack.
 672  */
 673 typedef void * OCResourceHandle;
 674
 675 /**
 676  * Handle to an OCRequest object owned by the OCStack.
 677  */
 678 typedef void * OCRequestHandle;
 679
 680 /**
 681  * Unique identifier for each observation request. Used when observations are
 682  * registered or de-registered. Used by entity handler to signal specific
 683  * observers to be notified of resource changes.
 684  * There can be maximum of 256 observations per server.
 685  */
 686 typedef uint8_t OCObservationId;
 687
 688 /**
 689  * Action associated with observation.
 690  */
 691 typedef enum
 692 {
 693     /** To Register. */
 694     OC_OBSERVE_REGISTER = 0,
 695
 696     /** To Deregister. */
 697     OC_OBSERVE_DEREGISTER = 1,
 698
 699     /** Others. */
 700     OC_OBSERVE_NO_OPTION = 2
 701 } OCObserveAction;
 702
 703
 704 /**
 705  * Persistent storage handlers. An APP must provide OCPersistentStorage handler pointers
 706  * when it calls OCRegisterPersistentStorageHandler.
 707  * Persistent storage open handler points to default file path.
 708  * Application can point to appropriate SVR database path for it's IoTivity Server.
 709  */
 710 typedef struct {
 711     /** Persistent storage file path.*/
 712     FILE* (* open)(const char *path, const char *mode);
 713
 714     /** Persistent storage read handler.*/
 715     size_t (* read)(void *ptr, size_t size, size_t nmemb, FILE *stream);
 716
 717     /** Persistent storage write handler.*/
 718     size_t (* write)(const void *ptr, size_t size, size_t nmemb, FILE *stream);
 719
 720     /** Persistent storage close handler.*/
 721     int (* close)(FILE *fp);
 722
 723     /** Persistent storage unlink handler.*/
 724     int (* unlink)(const char *path);
 725 } OCPersistentStorage;
 726
 727 /**
 728  * Possible returned values from entity handler.
 729  */
 730 typedef struct
 731 {
 732     /** Action associated with observation request.*/
 733     OCObserveAction action;
 734
 735     /** Identifier for observation being registered/deregistered.*/
 736     OCObservationId obsId;
 737 } OCObservationInfo;
 738
 739 /**
 740  * Possible returned values from entity handler.
 741  */
 742 typedef enum
 743 {
 744     OC_EH_OK = 0,
 745     OC_EH_ERROR,
 746     OC_EH_RESOURCE_CREATED,
 747     OC_EH_RESOURCE_DELETED,
 748     OC_EH_SLOW,
 749     OC_EH_FORBIDDEN,
 750     OC_EH_RESOURCE_NOT_FOUND
 751 } OCEntityHandlerResult;
 752
 753 /**
 754  * This structure will be used to define the vendor specific header options to be included
 755  * in communication packets.
 756  */
 757 typedef struct OCHeaderOption
 758 {
 759     /** The protocol ID this option applies to.*/
 760     OCTransportProtocolID protocolID;
 761
 762     /** The header option ID which will be added to communication packets.*/
 763     uint16_t optionID;
 764
 765     /** its length 191.*/
 766     uint16_t optionLength;
 767
 768     /** pointer to its data.*/
 769     uint8_t optionData[MAX_HEADER_OPTION_DATA_LENGTH];
 770
 771 #ifdef __cplusplus
 772     OCHeaderOption() = default;
 773     OCHeaderOption(OCTransportProtocolID pid,
 774                    uint16_t optId,
 775                    uint16_t optlen,
 776                    const uint8_t* optData)
 777         : protocolID(pid),
 778           optionID(optId),
 779           optionLength(optlen)
 780     {
 781
 782         // parameter includes the null terminator.
 783         optionLength = optionLength < MAX_HEADER_OPTION_DATA_LENGTH ?
 784                         optionLength : MAX_HEADER_OPTION_DATA_LENGTH;
 785         memcpy(optionData, optData, optionLength);
 786         optionData[optionLength - 1] = '\0';
 787     }
 788 #endif
 789 } OCHeaderOption;
 790
 791
 792 /**
 793  * This structure describes the platform properties. All non-Null properties will be
 794  * included in a platform discovery request.
 795  */
 796 typedef struct
 797 {
 798     /** Platform ID.*/
 799     char *platformID;
 800
 801     /** Manufacturer name.*/
 802     char *manufacturerName;
 803
 804     /** Manufacturer URL for platform property.*/
 805     char *manufacturerUrl;
 806
 807     /** Model number.*/
 808     char *modelNumber;
 809
 810     /** Manufacturer date.*/
 811     char *dateOfManufacture;
 812
 813     /** Platform version.*/
 814     char *platformVersion;
 815
 816     /** Operating system version.*/
 817     char *operatingSystemVersion;
 818
 819     /** HW version.*/
 820     char *hardwareVersion;
 821
 822     /** FW version.*/
 823     char *firmwareVersion;
 824
 825     /** Platform support URL.*/
 826     char *supportUrl;
 827
 828     /** System time.*/
 829     char *systemTime;
 830
 831 } OCPlatformInfo;
 832
 833 /**
 834  * This structure is expected as input for device properties.
 835  * device name is mandatory and expected from the application.
 836  * device id of type UUID will be generated by the stack.
 837  */
 838 typedef struct
 839 {
 840     /** Pointer to the device name.*/
 841     char *deviceName;
 842
 843 } OCDeviceInfo;
 844
 845 #ifdef RA_ADAPTER
 846 /**
 847  * CA Remote Access information for XMPP Client
 848  *
 849  */
 850 typedef struct
 851 {
 852     char *hostname;     /**< XMPP server hostname */
 853     uint16_t   port;    /**< XMPP server serivce port */
 854     char *xmpp_domain;  /**< XMPP login domain */
 855     char *username;     /**< login username */
 856     char *password;     /**< login password */
 857     char *resource;     /**< specific resource for login */
 858     char *user_jid;     /**< specific JID for login */
 859 } OCRAInfo_t;
 860 #endif  /* RA_ADAPTER */
 861
 862
 863 /** Enum to describe the type of object held by the OCPayload object.*/
 864 typedef enum
 865 {
 866     PAYLOAD_TYPE_INVALID,
 867     PAYLOAD_TYPE_DISCOVERY,
 868     PAYLOAD_TYPE_DEVICE,
 869     PAYLOAD_TYPE_PLATFORM,
 870     PAYLOAD_TYPE_REPRESENTATION,
 871     PAYLOAD_TYPE_SECURITY,
 872     PAYLOAD_TYPE_PRESENCE
 873 } OCPayloadType;
 874
 875 typedef struct
 876 {
 877     // The type of message that was received
 878     OCPayloadType type;
 879 } OCPayload;
 880
 881 typedef enum
 882 {
 883     OCREP_PROP_NULL,
 884     OCREP_PROP_INT,
 885     OCREP_PROP_DOUBLE,
 886     OCREP_PROP_BOOL,
 887     OCREP_PROP_STRING,
 888     OCREP_PROP_OBJECT,
 889     OCREP_PROP_ARRAY
 890 }OCRepPayloadPropType;
 891
 892 #define MAX_REP_ARRAY_DEPTH 3
 893 typedef struct
 894 {
 895     OCRepPayloadPropType type;
 896     size_t dimensions[MAX_REP_ARRAY_DEPTH];
 897
 898     union
 899     {
 900         int64_t* iArray;
 901         double* dArray;
 902         bool* bArray;
 903         char** strArray;
 904         struct OCRepPayload** objArray;
 905     };
 906 } OCRepPayloadValueArray;
 907
 908 typedef struct OCRepPayloadValue
 909 {
 910     char* name;
 911     OCRepPayloadPropType type;
 912     union
 913     {
 914         int64_t i;
 915         double d;
 916         bool b;
 917         char* str;
 918         struct OCRepPayload* obj;
 919         OCRepPayloadValueArray arr;
 920     };
 921     struct OCRepPayloadValue* next;
 922
 923 } OCRepPayloadValue;
 924
 925 typedef struct OCStringLL
 926 {
 927     struct OCStringLL *next;
 928     char* value;
 929 } OCStringLL;
 930
 931 // used for get/set/put/observe/etc representations
 932 typedef struct OCRepPayload
 933 {
 934     OCPayload base;
 935     char* uri;
 936     OCStringLL* types;
 937     OCStringLL* interfaces;
 938     OCRepPayloadValue* values;
 939     struct OCRepPayload* next;
 940 } OCRepPayload;
 941
 942 // used inside a discovery payload
 943 typedef struct OCResourcePayload
 944 {
 945     char* uri;
 946     uint8_t* sid;
 947     OCStringLL* types;
 948     OCStringLL* interfaces;
 949     uint8_t bitmap;
 950     bool secure;
 951     uint16_t port;
 952     struct OCResourcePayload* next;
 953 } OCResourcePayload;
 954
 955 typedef struct
 956 {
 957     OCPayload base;
 958     OCResourcePayload* resources;
 959 } OCDiscoveryPayload;
 960
 961 typedef struct
 962 {
 963     OCPayload base;
 964     char* uri;
 965     uint8_t* sid;
 966     char* deviceName;
 967     char* specVersion;
 968     char* dataModelVersion;
 969 } OCDevicePayload;
 970
 971 typedef struct
 972 {
 973     OCPayload base;
 974     char* uri;
 975     OCPlatformInfo info;
 976 } OCPlatformPayload;
 977
 978 typedef struct
 979 {
 980     OCPayload base;
 981     char* securityData;
 982 } OCSecurityPayload;
 983 #ifdef WITH_PRESENCE
 984 typedef struct
 985 {
 986     OCPayload base;
 987     uint32_t sequenceNumber;
 988     uint32_t maxAge;
 989     OCPresenceTrigger trigger;
 990     char* resourceType;
 991 } OCPresencePayload;
 992 #endif
 993
 994 /**
 995  * Incoming requests handled by the server. Requests are passed in as a parameter to the
 996  * OCEntityHandler callback API.
 997  * The OCEntityHandler callback API must be implemented in the application in order
 998  * to receive these requests.
 999  */
1000 typedef struct
1001 {
1002     /** Associated resource.*/
1003     OCResourceHandle resource;
1004
1005     /** Associated request handle.*/
1006     OCRequestHandle requestHandle;
1007
1008     /** the REST method retrieved from received request PDU.*/
1009     OCMethod method;
1010
1011     /** description of endpoint that sent the request.*/
1012     OCDevAddr devAddr;
1013
1014     /** resource query send by client.*/
1015     char * query;
1016
1017     /** Information associated with observation - valid only when OCEntityHandler flag includes
1018      * ::OC_OBSERVE_FLAG.*/
1019     OCObservationInfo obsInfo;
1020
1021     /** Number of the received vendor specific header options.*/
1022     uint8_t numRcvdVendorSpecificHeaderOptions;
1023
1024     /** Pointer to the array of the received vendor specific header options.*/
1025     OCHeaderOption * rcvdVendorSpecificHeaderOptions;
1026
1027     /** the payload from the request PDU.*/
1028     OCPayload *payload;
1029
1030
1031 } OCEntityHandlerRequest;
1032
1033
1034 /**
1035  * Response from queries to remote servers. Queries are made by calling the OCDoResource API.
1036  */
1037 typedef struct
1038 {
1039     /** Address of remote server.*/
1040     OCDevAddr devAddr;
1041
1042     /** backward compatibility (points to devAddr).*/
1043     OCDevAddr *addr;
1044
1045     /** backward compatibility.*/
1046     OCConnectivityType connType;
1047
1048     /** the is the result of our stack, OCStackResult should contain coap/other error codes.*/
1049     OCStackResult result;
1050
1051     /** If associated with observe, this will represent the sequence of notifications from server.*/
1052     uint32_t sequenceNumber;
1053
1054     /** resourceURI.*/
1055     const char * resourceUri;
1056
1057     /** the payload for the response PDU.*/
1058     OCPayload *payload;
1059
1060     /** Number of the received vendor specific header options.*/
1061     uint8_t numRcvdVendorSpecificHeaderOptions;
1062
1063     /** An array of the received vendor specific header options.*/
1064     OCHeaderOption rcvdVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1065 } OCClientResponse;
1066
1067 /**
1068  * Request handle is passed to server via the entity handler for each incoming request.
1069  * Stack assigns when request is received, server sets to indicate what request response is for.
1070  */
1071 typedef struct
1072 {
1073     /** Request handle.*/
1074     OCRequestHandle requestHandle;
1075
1076     /** Resource handle.*/
1077     OCResourceHandle resourceHandle;
1078
1079     /** Allow the entity handler to pass a result with the response.*/
1080     OCEntityHandlerResult  ehResult;
1081
1082     /** This is the pointer to server payload data to be transferred.*/
1083     OCPayload* payload;
1084
1085     /** number of the vendor specific header options .*/
1086     uint8_t numSendVendorSpecificHeaderOptions;
1087
1088     /** An array of the vendor specific header options the entity handler wishes to use in response.*/
1089     OCHeaderOption sendVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1090
1091     /** URI of new resource that entity handler might create.*/
1092     char resourceUri[MAX_URI_LENGTH];
1093
1094     /** Server sets to true for persistent response buffer,false for non-persistent response buffer*/
1095     uint8_t persistentBufferFlag;
1096 } OCEntityHandlerResponse;
1097
1098 /**
1099  * Entity's state
1100  */
1101 typedef enum
1102 {
1103     /** Request state.*/
1104     OC_REQUEST_FLAG = (1 << 1),
1105     /** Observe state.*/
1106     OC_OBSERVE_FLAG = (1 << 2)
1107 } OCEntityHandlerFlag;
1108
1109 /**
1110  * Possible returned values from client application.
1111  */
1112 typedef enum
1113 {
1114     OC_STACK_DELETE_TRANSACTION = 0,
1115     OC_STACK_KEEP_TRANSACTION
1116 } OCStackApplicationResult;
1117
1118
1119 /*
1120  * -------------------------------------------------------------------------------------------
1121  * Callback function definitions
1122  * -------------------------------------------------------------------------------------------
1123  */
1124
1125 /**
1126  * Client applications implement this callback to consume responses received from Servers.
1127  */
1128 typedef OCStackApplicationResult (* OCClientResponseHandler)(void *context, OCDoHandle handle,
1129     OCClientResponse * clientResponse);
1130
1131 /**
1132  * Client applications using a context pointer implement this callback to delete the
1133  * context upon removal of the callback/context pointer from the internal callback-list.
1134  */
1135 typedef void (* OCClientContextDeleter)(void *context);
1136
1137 /**
1138  * This info is passed from application to OC Stack when initiating a request to Server.
1139  */
1140 typedef struct OCCallbackData
1141 {
1142     /** Pointer to the context.*/
1143     void *context;
1144
1145     /** The pointer to a function the stack will call to handle the requests.*/
1146     OCClientResponseHandler cb;
1147
1148     /** A pointer to a function to delete the context when this callback is removed.*/
1149     OCClientContextDeleter cd;
1150
1151 #ifdef __cplusplus
1152     OCCallbackData() = default;
1153     OCCallbackData(void* ctx, OCClientResponseHandler callback, OCClientContextDeleter deleter)
1154         :context(ctx), cb(callback), cd(deleter){}
1155 #endif
1156 } OCCallbackData;
1157
1158 /**
1159  * Application server implementations must implement this callback to consume requests OTA.
1160  * Entity handler callback needs to fill the resPayload of the entityHandlerRequest.
1161  */
1162 typedef OCEntityHandlerResult (*OCEntityHandler)
1163 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, void* callbackParam);
1164
1165 /**
1166  * Device Entity handler need to use this call back instead of OCEntityHandler.
1167  */
1168 typedef OCEntityHandlerResult (*OCDeviceEntityHandler)
1169 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, char* uri, void* callbackParam);
1170
1171 #ifdef __cplusplus
1172 }
1173 #endif // __cplusplus
1174
1175 #endif /* OCTYPES_H_ */