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