Initial version of atomic measurement.
[iotivity.git] / resource / csdk / 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 definitions, types and APIs for resources to 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 //-----------------------------------------------------------------------------
47 // Defines
48 //-----------------------------------------------------------------------------
49
50 /** Version of IoTivity. */
51 #define IOTIVITY_VERSION                      "2.0.0"
52
53 /**
54  * OIC Virtual resources supported by every OIC device.
55  */
56 /**
57  *  Default discovery mechanism using '/oic/res' is supported by all OIC devices
58  *  That are Discoverable.
59  */
60 #define OC_RSRVD_WELL_KNOWN_URI               "/oic/res"
61
62 /** Device URI.*/
63 #define OC_RSRVD_DEVICE_URI                   "/oic/d"
64
65 /** Platform URI.*/
66 #define OC_RSRVD_PLATFORM_URI                 "/oic/p"
67
68 /** Resource Type.*/
69 #define OC_RSRVD_RESOURCE_TYPES_URI           "/oic/res/types/d"
70
71 /** Gateway URI.*/
72 #define OC_RSRVD_GATEWAY_URI                  "/oic/gateway"
73
74 /** MQ Broker URI.*/
75 #define OC_RSRVD_WELL_KNOWN_MQ_URI            "/oic/ps"
76
77 /** KeepAlive URI.*/
78 #define OC_RSRVD_KEEPALIVE_URI                "/oic/ping"
79
80 /** Cloudconf URI.*/
81 #define OC_RSRVD_CLOUDCONF_URI                "/CoapCloudConfResURI"
82
83 /** Presence */
84
85 /** Presence URI through which the OIC devices advertise their presence.*/
86 #define OC_RSRVD_PRESENCE_URI                 "/oic/ad"
87
88 /** Presence URI through which the OIC devices advertise their device presence.*/
89 #define OC_RSRVD_DEVICE_PRESENCE_URI         "/oic/prs"
90
91 /** Sets the default time to live (TTL) for presence.*/
92 #define OC_DEFAULT_PRESENCE_TTL_SECONDS       (60)
93
94 /** For multicast Discovery mechanism.*/
95 #define OC_MULTICAST_DISCOVERY_URI            "/oic/res"
96
97 /** Separator for multiple query string.*/
98 #define OC_QUERY_SEPARATOR                    "&;"
99
100 /** Delimeter for keys and values in query string.*/
101 #define OC_KEY_VALUE_DELIMITER                "="
102
103 /**
104  *  OC_DEFAULT_PRESENCE_TTL_SECONDS sets the default time to live (TTL) for presence.
105  */
106 #define OC_DEFAULT_PRESENCE_TTL_SECONDS (60)
107
108 /**
109  *  OC_MAX_PRESENCE_TTL_SECONDS sets the maximum time to live (TTL) for presence.
110  *  NOTE: Changing the setting to a longer duration may lead to unsupported and untested
111  *  operation.
112  *  60 sec/min * 60 min/hr * 24 hr/day
113  */
114 #define OC_MAX_PRESENCE_TTL_SECONDS     (60 * 60 * 24)
115
116
117 /**
118  *  Presence "Announcement Triggers".
119  */
120
121 /** To create.*/
122 #define OC_RSRVD_TRIGGER_CREATE         "create"
123
124 /** To change.*/
125 #define OC_RSRVD_TRIGGER_CHANGE         "change"
126
127 /** To delete.*/
128 #define OC_RSRVD_TRIGGER_DELETE         "delete"
129
130 /**
131  *  Attributes used to form a proper OIC conforming JSON message.
132  */
133
134 #define OC_RSRVD_OC                     "oic"
135
136
137 /** For payload. */
138
139 #define OC_RSRVD_PAYLOAD                "payload"
140
141 /** To represent href */
142 #define OC_RSRVD_HREF                   "href"
143
144 /** To represent property*/
145 #define OC_RSRVD_PROPERTY               "prop"
146
147 /** For representation.*/
148 #define OC_RSRVD_REPRESENTATION         "rep"
149
150 /** To represent content type.*/
151 #define OC_RSRVD_CONTENT_TYPE           "ct"
152
153 /** To represent resource type.*/
154 #define OC_RSRVD_RESOURCE_TYPE          "rt"
155
156 /** To represent resource type with presence.*/
157 #define OC_RSRVD_RESOURCE_TYPE_PRESENCE "oic.wk.ad"
158
159 /** To represent resource type with device.*/
160 #define OC_RSRVD_RESOURCE_TYPE_DEVICE   "oic.wk.d"
161
162 /** To represent resource type with platform.*/
163 #define OC_RSRVD_RESOURCE_TYPE_PLATFORM "oic.wk.p"
164
165 /** To represent resource type with maintenance.*/
166 #define OC_RSRVD_RESOURCE_TYPE_MAINTENANCE "oic.wk.mnt"
167
168 /** To represent resource type with collection.*/
169 #define OC_RSRVD_RESOURCE_TYPE_COLLECTION "oic.wk.col"
170
171 /** To represent resource type with atomic measurement.*/
172 #define OC_RSRVD_RESOURCE_TYPE_AM "oic.wk.atomicmeasurement"
173
174 /** To represent resource type with RES.*/
175 #define OC_RSRVD_RESOURCE_TYPE_RES      "oic.wk.res"
176
177 /** To represent content type with MQ Broker.*/
178 #define OC_RSRVD_RESOURCE_TYPE_MQ_BROKER "oic.wk.ps"
179
180 /** To represent content type with MQ Topic.*/
181 #define OC_RSRVD_RESOURCE_TYPE_MQ_TOPIC  "oic.wk.ps.topic"
182
183 /** To represent resource type with introspection.*/
184 #define OC_RSRVD_RESOURCE_TYPE_INTROSPECTION "oic.wk.introspection"
185
186 /** To represent resource type with introspection payload.*/
187 #define OC_RSRVD_RESOURCE_TYPE_INTROSPECTION_PAYLOAD "oic.wk.introspection.payload"
188
189 /** To represent interface.*/
190 #define OC_RSRVD_INTERFACE              "if"
191
192 /** To represent time to live.*/
193 #define OC_RSRVD_TTL                    "ttl"
194
195 /** To indicate how long RD should publish this item.*/
196 #define OC_RSRVD_DEVICE_TTL             OC_RSRVD_TTL
197
198 /** To represent non*/
199 #define OC_RSRVD_NONCE                  "non"
200
201 /** To represent trigger type.*/
202 #define OC_RSRVD_TRIGGER                "trg"
203
204 /** To represent links.*/
205 #define OC_RSRVD_LINKS                  "links"
206
207 /** To represent default interface.*/
208 #define OC_RSRVD_INTERFACE_DEFAULT      "oic.if.baseline"
209
210 /** To represent read-only interface.*/
211 #define OC_RSRVD_INTERFACE_READ         "oic.if.r"
212
213 /** To represent read-write interface.*/
214 #define OC_RSRVD_INTERFACE_READ_WRITE   "oic.if.rw"
215
216 /** To represent ll interface.*/
217 #define OC_RSRVD_INTERFACE_LL           "oic.if.ll"
218
219 /** To represent batch interface.*/
220 #define OC_RSRVD_INTERFACE_BATCH        "oic.if.b"
221
222 /** To represent actuator interface.*/
223 #define OC_RSRVD_INTERFACE_ACTUATOR     "oic.if.a"
224
225 /** To represent sensor interface.*/
226 #define OC_RSRVD_INTERFACE_SENSOR       "oic.if.s"
227
228 /** To represent interface group.*/
229 #define OC_RSRVD_INTERFACE_GROUP        "oic.mi.grp"
230
231 /** To represent FW version.*/
232 #define OC_RSRVD_FW_VERSION             "mnfv"
233
234 /** To represent host name.*/
235 #define OC_RSRVD_HOST_NAME              "hn"
236
237 /** To represent policy.*/
238 #define OC_RSRVD_POLICY                 "p"
239
240 /** To represent bitmap.*/
241 #define OC_RSRVD_BITMAP                 "bm"
242
243 /** For security.*/
244 #define OC_RSRVD_SECURE                 "sec"
245
246 /** Security Database persistent store name(json).*/
247 #define OC_SECURITY_DB_FILE_NAME        "oic_svr_db.json"
248
249 /** Security Database persistent store name(dat).*/
250 #define OC_SECURITY_DB_DAT_FILE_NAME    "oic_svr_db.dat"
251
252 /** Port. */
253 #define OC_RSRVD_HOSTING_PORT           "port"
254
255 /** TCP Port. */
256 #define OC_RSRVD_TCP_PORT               "x.org.iotivity.tcp"
257
258 /** TLS Port. */
259 #define OC_RSRVD_TLS_PORT               "x.org.iotivity.tls"
260
261 /** For Server instance ID.*/
262 #define OC_RSRVD_SERVER_INSTANCE_ID     "sid"
263
264 /** To represent endpoints.*/
265 #define OC_RSRVD_ENDPOINTS              "eps"
266
267 /** To represent endpoint.*/
268 #define OC_RSRVD_ENDPOINT               "ep"
269
270 /** To represent priority.*/
271 #define OC_RSRVD_PRIORITY               "pri"
272
273 /** For resource instance ID.*/
274 #define OC_RSRVD_INSTANCE_ID            "id"
275
276 /**
277  *  Platform.
278  */
279
280 /** Platform ID. */
281 #define OC_RSRVD_PLATFORM_ID            "pi"
282
283 /** Platform MFG NAME. */
284 #define OC_RSRVD_MFG_NAME               "mnmn"
285
286 /** Platform URL. */
287 #define OC_RSRVD_MFG_URL                "mnml"
288
289 /** Model Number.*/
290 #define OC_RSRVD_MODEL_NUM              "mnmo"
291
292 /** Platform MFG Date.*/
293 #define OC_RSRVD_MFG_DATE               "mndt"
294
295 /** Platform versio.n */
296 #define OC_RSRVD_PLATFORM_VERSION       "mnpv"
297
298 /** Platform Operating system version. */
299 #define OC_RSRVD_OS_VERSION             "mnos"
300
301 /** Platform Hardware version. */
302 #define OC_RSRVD_HARDWARE_VERSION       "mnhw"
303
304 /**Platform Firmware version. */
305 #define OC_RSRVD_FIRMWARE_VERSION       "mnfv"
306
307 /** Support URL for the platform. */
308 #define OC_RSRVD_SUPPORT_URL            "mnsl"
309
310 /** System time for the platform. */
311 #define OC_RSRVD_SYSTEM_TIME            "st"
312
313 /** VID for the platform. */
314 #define OC_RSRVD_VID                    "vid"
315
316 /**
317  *  Device.
318  */
319
320 /** Device ID.*/
321 #define OC_RSRVD_DEVICE_ID               "di"
322
323 /** Device Name.*/
324 #define OC_RSRVD_DEVICE_NAME             "n"
325
326 /** Device specification version.*/
327 #define OC_RSRVD_SPEC_VERSION            "icv"
328
329 /** Device data model.*/
330 #define OC_RSRVD_DATA_MODEL_VERSION      "dmv"
331
332 /** Device description, localized */
333 #define OC_RSRVD_DEVICE_DESCRIPTION      "ld"
334
335 /** Device software version */
336 #define OC_RSRVD_SOFTWARE_VERSION        "sv"
337
338 /** Device manufacturer name, localized */
339 #define OC_RSRVD_DEVICE_MFG_NAME         "dmn"
340
341 /** Device model number */
342 #define OC_RSRVD_DEVICE_MODEL_NUM        "dmno"
343
344 /** Protocol-Independent ID.*/
345 #define OC_RSRVD_PROTOCOL_INDEPENDENT_ID "piid"
346
347 /** Device specification version.*/
348 #define OC_SPEC_VERSION                  "ocf.1.1.0"
349
350 /** Integer value of spec version (OCF1.0 0b0000:1000:0000:0000).*/
351 #define OC_SPEC_VERSION_VALUE            2048
352
353 /** Device Data Model version.*/
354 #define OC_DATA_MODEL_VERSION            "ocf.res.1.1.0,ocf.sh.1.1.0"
355
356 /**
357  *  Introspection.
358  */
359 /** Name property name(n).*/
360 #define OC_RSRVD_INTROSPECTION_NAME     "n"
361
362 /** Value of name.*/
363 #define OC_RSRVD_INTROSPECTION_NAME_VALUE "Introspection"
364
365 /** Url info Object.*/
366 #define OC_RSRVD_INTROSPECTION_URL_INFO "urlInfo"
367
368 /** Url property.*/
369 #define OC_RSRVD_INTROSPECTION_URL      "url"
370
371 /** Protocol property.*/
372 #define OC_RSRVD_INTROSPECTION_PROTOCOL    "protocol"
373
374 /** Content-Type property.*/
375 #define OC_RSRVD_INTROSPECTION_CONTENT_TYPE "content-type"
376
377 /** Content-Type property value.*/
378 #define OC_RSRVD_INTROSPECTION_CONTENT_TYPE_VALUE "application/cbor"
379
380 /** Version property.*/
381 #define OC_RSRVD_INTROSPECTION_VERSION    "version"
382
383 /** Version property value.*/
384 #define OC_RSRVD_INTROSPECTION_VERSION_VALUE 1
385
386 /** Introspection persistent store name.*/
387 #define OC_INTROSPECTION_FILE_NAME      "introspection.dat"
388
389 /**
390  *  These provide backward compatibility - their use is deprecated.
391  */
392 #ifndef GOING_AWAY
393
394 /** Multicast Prefix.*/
395 #define OC_MULTICAST_PREFIX             "224.0.1.187:5683"
396
397 /** Multicast IP address.*/
398 #define OC_MULTICAST_IP                 "224.0.1.187"
399
400 /** Multicast Port.*/
401 #define OC_MULTICAST_PORT               (5683)
402 #endif // GOING_AWAY
403
404 /** Max Device address size. */
405 #ifdef RA_ADAPTER
406 #define MAX_ADDR_STR_SIZE (256)
407 #else
408 /** Max Address could be
409  * "coaps+tcp://[xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:yyy.yyy.yyy.yyy]:xxxxx"
410  * +1 for null terminator.
411  */
412 #define MAX_ADDR_STR_SIZE (66)
413 #endif
414
415 /** Length of MAC address */
416 #define MAC_ADDR_STR_SIZE (17)
417
418 /** Blocks of MAC address */
419 #define MAC_ADDR_BLOCKS (6)
420
421 /** Max identity size. */
422 #define MAX_IDENTITY_SIZE (37)
423
424 /** Universal unique identity size. */
425 #define UUID_IDENTITY_SIZE (128/8)
426
427 /** Resource Directory */
428
429 /** Resource Directory URI used to Discover RD and Publish resources.*/
430 #define OC_RSRVD_RD_URI                  "/oic/rd"
431
432 /** To represent resource type with rd.*/
433 #define OC_RSRVD_RESOURCE_TYPE_RD        "oic.wk.rd"
434
435 /** RD Discovery bias factor type. */
436 #define OC_RSRVD_RD_DISCOVERY_SEL        "sel"
437
438 /** Resource URI used to discover Proxy */
439 #define OC_RSRVD_PROXY_URI "/oic/chp"
440
441 /** Resource URI used to discover Proxy */
442 #define OC_RSRVD_PROXY_OPTION_ID 35
443
444 /** Unique value per collection/link. */
445 #define OC_RSRVD_INS                     "ins"
446
447 /** Allowable resource types in the links. */
448 #define OC_RSRVD_RTS                     "rts"
449
450 /** Mandatory resource types in the links [shall be a subset of rts]. */
451 #define OC_RSRVD_RTSM                    "rts-m"
452
453 /** Default relationship. */
454 #define OC_RSRVD_DREL                    "drel"
455
456 /** Defines relationship between links. */
457 #define OC_RSRVD_REL                     "rel"
458
459 /** Defines title. */
460 #define OC_RSRVD_TITLE                   "title"
461
462 /** Defines URI. */
463 #define OC_RSRVD_URI                     "anchor"
464
465 /** Defines media type. */
466 #define OC_RSRVD_MEDIA_TYPE              "type"
467
468 /** To represent resource type with Publish RD.*/
469 #define OC_RSRVD_RESOURCE_TYPE_RDPUBLISH "oic.wk.rdpub"
470
471 /** Cloud Account */
472
473 /** Account URI.*/
474 #define OC_RSRVD_ACCOUNT_URI               "/oic/sec/account"
475
476 /** Account user URI.*/
477 #define OC_RSRVD_ACCOUNT_SEARCH_URI        "/oic/account/search"
478
479 /** Account session URI.*/
480 #define OC_RSRVD_ACCOUNT_SESSION_URI       "/oic/sec/session"
481
482 /** Account token refresh URI.*/
483 #define OC_RSRVD_ACCOUNT_TOKEN_REFRESH_URI "/oic/sec/tokenrefresh"
484
485 /** ACL group URI.*/
486 #define OC_RSRVD_ACL_GROUP_URI             "/oic/acl/group"
487
488 /** ACL invite URI.*/
489 #define OC_RSRVD_ACL_INVITE_URI            "/oic/acl/invite"
490
491 /** Defines auth provider. */
492 #define OC_RSRVD_AUTHPROVIDER              "authprovider"
493
494 /** Defines auth code. */
495 #define OC_RSRVD_AUTHCODE                  "authcode"
496
497 /** Defines access token. */
498 #define OC_RSRVD_ACCESS_TOKEN              "accesstoken"
499
500 /** Defines login. */
501 #define OC_RSRVD_LOGIN                     "login"
502
503 /** Defines search. */
504 #define OC_RSRVD_SEARCH                    "search"
505
506 /** Defines grant type. */
507 #define OC_RSRVD_GRANT_TYPE                "granttype"
508
509 /** Defines refresh token. */
510 #define OC_RSRVD_REFRESH_TOKEN             "refreshtoken"
511
512 /** Defines user UUID. */
513 #define OC_RSRVD_USER_UUID                 "uid"
514
515 /** Defines group ID. */
516 #define OC_RSRVD_GROUP_ID                  "gid"
517
518 /** Defines member of group ID. */
519 #define OC_RSRVD_MEMBER_ID                 "mid"
520
521 /** Defines invite. */
522 #define OC_RSRVD_INVITE                    "invite"
523
524 /** Defines accept. */
525 #define OC_RSRVD_ACCEPT                    "accept"
526
527 /** Defines operation. */
528 #define OC_RSRVD_OPERATION                 "op"
529
530 /** Defines add. */
531 #define OC_RSRVD_ADD                       "add"
532
533 /** Defines delete. */
534 #define OC_RSRVD_DELETE                    "delete"
535
536 /** Defines owner. */
537 #define OC_RSRVD_OWNER                     "owner"
538
539 /** Defines members. */
540 #define OC_RSRVD_MEMBERS                   "members"
541
542 /** To represent grant type with refresh token. */
543 #define OC_RSRVD_GRANT_TYPE_REFRESH_TOKEN  "refresh_token"
544
545 /** Cloud CRL */
546 #define OC_RSRVD_PROV_CRL_URL              "/oic/credprov/crl"
547
548 #define OC_RSRVD_LAST_UPDATE              "lu"
549
550 #define OC_RSRVD_THIS_UPDATE              "thisupdate"
551
552 #define OC_RSRVD_NEXT_UPDATE              "nu"
553
554 #define OC_RSRVD_SERIAL_NUMBERS           "rcsn"
555
556 #define OC_RSRVD_CRL                      "crldata"
557
558 #define OC_RSRVD_CRL_ID                   "crlid"
559
560 /** Cloud ACL */
561 #define OC_RSRVD_GROUP_URL                "/oic/group"
562
563 #define OC_RSRVD_ACL_GROUP_URL            "/oic/acl/group"
564
565 #define OC_RSRVD_ACL_INVITE_URL           "/oic/acl/invite"
566
567 #define OC_RSRVD_ACL_VERIFY_URL           "/oic/acl/verify"
568
569 #define OC_RSRVD_ACL_ID_URL               "/oic/acl/id"
570
571 #define OC_RSRVD_MEMBER_ID                "mid"
572
573 #define OC_RSRVD_GROUP_ID                 "gid"
574
575 #define OC_RSRVD_OWNER_ID                 "oid"
576
577 #define OC_RSRVD_ACL_ID                   "aclid"
578
579 #define OC_RSRVD_ACE_ID                   "aceid"
580
581 #define OC_RSRVD_DEVICE_ID                "di"
582
583 #define OC_RSRVD_SUBJECT_ID               "sid"
584
585 #define OC_RSRVD_REQUEST_METHOD           "rm"
586
587 #define OC_RSRVD_REQUEST_URI              "uri"
588
589 #define OC_RSRVD_GROUP_MASTER_ID          "gmid"
590
591 #define OC_RSRVD_GROUP_TYPE               "gtype"
592
593 #define OC_RSRVD_SUBJECT_TYPE             "stype"
594
595 #define OC_RSRVD_GROUP_ID_LIST            "gidlist"
596
597 #define OC_RSRVD_MEMBER_ID_LIST           "midlist"
598
599 #define OC_RSRVD_DEVICE_ID_LIST           "dilist"
600
601 #define OC_RSRVD_ACCESS_CONTROL_LIST      "aclist"
602
603 #define OC_RSRVD_RESOURCES                "resources"
604
605 #define OC_RSRVD_VALIDITY                 "validity"
606
607 #define OC_RSRVD_PERIOD                   "period"
608
609 #define OC_RSRVD_RECURRENCE               "recurrence"
610
611 #define OC_RSRVD_INVITE                   "invite"
612
613 #define OC_RSRVD_INVITED                  "invited"
614
615 #define OC_RSRVD_ENCODING                 "encoding"
616
617 #define OC_OIC_SEC                        "oic.sec"
618
619 #define OC_RSRVD_BASE64                   "base64"
620
621 #define OC_RSRVD_DER                      "der"
622
623 #define OC_RSRVD_PEM                      "pem"
624
625 #define OC_RSRVD_RAW                      "raw"
626
627 #define OC_RSRVD_UNKNOWN                  "unknown"
628
629 #define OC_RSRVD_DATA                     "data"
630
631 #define OC_RSRVD_RESOURCE_OWNER_UUID      "rowneruuid"
632
633 #define OC_RSRVD_SUBJECT_UUID             "subjectuuid"
634
635 #define OC_RSRVD_PERMISSION_MASK          "permission"
636
637 #define OC_RSRVD_GROUP_PERMISSION         "gp"
638
639 #define OC_RSRVD_GROUP_ACL                "gacl"
640
641 /** Certificete Sign Request */
642 #define OC_RSRVD_PROV_CERT_URI            "/oic/credprov/cert"
643
644 #define OC_RSRVD_CSR                      "csr"
645
646 #define OC_RSRVD_CERT                     "cert"
647
648 #define OC_RSRVD_CACERT                   "certchain"
649
650 #define OC_RSRVD_TOKEN_TYPE               "tokentype"
651
652 #define OC_RSRVD_EXPIRES_IN               "expiresin"
653
654 #define OC_RSRVD_REDIRECT_URI             "redirecturi"
655
656 #define OC_RSRVD_CERTIFICATE              "certificate"
657
658 /**
659  * TODO: Move these COAP defines to CoAP lib once approved.
660  */
661 #define COAP_OPTION_ACCEPT_VERSION 2049
662 #define COAP_OPTION_CONTENT_VERSION 2053
663
664 /**
665  * These enums (OCTransportAdapter and OCTransportFlags) must
666  * be kept synchronized with OCConnectivityType (below) as well as
667  * CATransportAdapter and CATransportFlags (in CACommon.h).
668  */
669 typedef enum
670 {
671     /** value zero indicates discovery.*/
672     OC_DEFAULT_ADAPTER = 0,
673
674     /** IPv4 and IPv6, including 6LoWPAN.*/
675     OC_ADAPTER_IP           = (1 << 0),
676
677     /** GATT over Bluetooth LE.*/
678     OC_ADAPTER_GATT_BTLE    = (1 << 1),
679
680     /** RFCOMM over Bluetooth EDR.*/
681     OC_ADAPTER_RFCOMM_BTEDR = (1 << 2),
682 #ifdef RA_ADAPTER
683     /**Remote Access over XMPP.*/
684     OC_ADAPTER_REMOTE_ACCESS = (1 << 3),
685 #endif
686     /** CoAP over TCP.*/
687     OC_ADAPTER_TCP           = (1 << 4),
688
689     /** NFC Transport for Messaging.*/
690     OC_ADAPTER_NFC           = (1 << 5)
691 } OCTransportAdapter;
692
693 typedef enum
694 {
695     /** default flag is 0.*/
696     OC_DEFAULT_BT_FLAGS = 0,
697     /** disable BLE advertisement.*/
698     OC_LE_ADV_DISABLE   = 0x1,
699     /** enable BLE advertisement.*/
700     OC_LE_ADV_ENABLE    = 0x2,
701     /** disable gatt server.*/
702     OC_LE_SERVER_DISABLE = (1 << 4),
703     /** disable rfcomm server.*/
704     OC_EDR_SERVER_DISABLE = (1 << 7)
705 } OCTransportBTFlags_t;
706
707 /**
708  * Log level to print can be controlled through this enum.
709  * And privacy logs contained uid, Token, Device id, etc can also disable.
710  * This enum (OCLogLevel) must be kept synchronized with
711  * CAUtilLogLevel_t (in CACommon.h).
712  */
713 typedef enum
714 {
715     OC_LOG_LEVEL_ALL = 1,             // all logs.
716     OC_LOG_LEVEL_INFO,                // debug level is disabled.
717 } OCLogLevel;
718
719 /**
720  *  Enum layout assumes some targets have 16-bit integer (e.g., Arduino).
721  */
722 typedef enum
723 {
724     /** default flag is 0*/
725     OC_DEFAULT_FLAGS = 0,
726
727     /** Insecure transport is the default (subject to change).*/
728     /** secure the transport path*/
729     OC_FLAG_SECURE     = (1 << 4),
730
731     /** IPv4 & IPv6 auto-selection is the default.*/
732     /** IP & TCP adapter only.*/
733     OC_IP_USE_V6       = (1 << 5),
734
735     /** IP & TCP adapter only.*/
736     OC_IP_USE_V4       = (1 << 6),
737
738     /** Multicast only.*/
739     OC_MULTICAST       = (1 << 7),
740
741     /** Link-Local multicast is the default multicast scope for IPv6.
742      *  These are placed here to correspond to the IPv6 multicast address bits.*/
743
744     /** IPv6 Interface-Local scope (loopback).*/
745     OC_SCOPE_INTERFACE = 0x1,
746
747     /** IPv6 Link-Local scope (default).*/
748     OC_SCOPE_LINK      = 0x2,
749
750     /** IPv6 Realm-Local scope. */
751     OC_SCOPE_REALM     = 0x3,
752
753     /** IPv6 Admin-Local scope. */
754     OC_SCOPE_ADMIN     = 0x4,
755
756     /** IPv6 Site-Local scope. */
757     OC_SCOPE_SITE      = 0x5,
758
759     /** IPv6 Organization-Local scope. */
760     OC_SCOPE_ORG       = 0x8,
761
762     /**IPv6 Global scope. */
763     OC_SCOPE_GLOBAL    = 0xE,
764
765 } OCTransportFlags;
766
767 /** Bit mask for scope.*/
768 #define OC_MASK_SCOPE    (0x000F)
769
770 /** Bit mask for Mods.*/
771 #define OC_MASK_MODS     (0x0FF0)
772 #define OC_MASK_FAMS     (OC_IP_USE_V6|OC_IP_USE_V4)
773
774 typedef struct OCStringLL
775 {
776     struct OCStringLL *next;
777     char* value;
778 } OCStringLL;
779
780 /**
781  * End point identity.
782  */
783 typedef struct
784 {
785     /** Identity Length */
786     uint16_t id_length;
787
788     /** Array of end point identity.*/
789     unsigned char id[MAX_IDENTITY_SIZE];
790 } OCIdentity;
791
792 /**
793  * Universally unique identifier.
794  */
795 typedef struct
796 {
797     /** identitifier string.*/
798     unsigned char id[UUID_IDENTITY_SIZE];
799 } OCUUIdentity;
800
801 /**
802  * Data structure to encapsulate IPv4/IPv6/Contiki/lwIP device addresses.
803  * OCDevAddr must be the same as CAEndpoint (in CACommon.h).
804  */
805 typedef struct
806 {
807     /** adapter type.*/
808     OCTransportAdapter      adapter;
809
810     /** transport modifiers.*/
811     OCTransportFlags        flags;
812
813     /** for IP.*/
814     uint16_t                port;
815
816     /** address for all adapters.*/
817     char                    addr[MAX_ADDR_STR_SIZE];
818
819     /** usually zero for default interface.*/
820     uint32_t                ifindex;
821
822     /** destination GatewayID:ClientId.*/
823     char                    routeData[MAX_ADDR_STR_SIZE];
824
825     /** device ID of remote.*/
826     char                    remoteId[MAX_IDENTITY_SIZE];
827
828 } OCDevAddr;
829
830 /**
831  * This enum type includes elements of both ::OCTransportAdapter and ::OCTransportFlags.
832  * It is defined conditionally because the smaller definition limits expandability on 32/64 bit
833  * integer machines, and the larger definition won't fit into an enum on 16-bit integer machines
834  * like Arduino.
835  *
836  * This structure must directly correspond to ::OCTransportAdapter and ::OCTransportFlags.
837  */
838 typedef enum
839 {
840     /** use when defaults are ok. */
841     CT_DEFAULT = 0,
842
843     /** IPv4 and IPv6, including 6LoWPAN.*/
844     CT_ADAPTER_IP           = (1 << 16),
845
846     /** GATT over Bluetooth LE.*/
847     CT_ADAPTER_GATT_BTLE    = (1 << 17),
848
849     /** RFCOMM over Bluetooth EDR.*/
850     CT_ADAPTER_RFCOMM_BTEDR = (1 << 18),
851
852 #ifdef RA_ADAPTER
853     /** Remote Access over XMPP.*/
854     CT_ADAPTER_REMOTE_ACCESS = (1 << 19),
855 #endif
856     /** CoAP over TCP.*/
857     CT_ADAPTER_TCP     = (1 << 20),
858
859     /** NFC Transport.*/
860     CT_ADAPTER_NFC     = (1 << 21),
861
862     /** Insecure transport is the default (subject to change).*/
863
864     /** secure the transport path.*/
865     CT_FLAG_SECURE     = (1 << 4),
866
867     /** IPv4 & IPv6 autoselection is the default.*/
868
869     /** IP adapter only.*/
870     CT_IP_USE_V6       = (1 << 5),
871
872     /** IP adapter only.*/
873     CT_IP_USE_V4       = (1 << 6),
874
875     /** Link-Local multicast is the default multicast scope for IPv6.
876      * These are placed here to correspond to the IPv6 address bits.*/
877
878     /** IPv6 Interface-Local scope(loopback).*/
879     CT_SCOPE_INTERFACE = 0x1,
880
881     /** IPv6 Link-Local scope (default).*/
882     CT_SCOPE_LINK      = 0x2,
883
884     /** IPv6 Realm-Local scope.*/
885     CT_SCOPE_REALM     = 0x3,
886
887     /** IPv6 Admin-Local scope.*/
888     CT_SCOPE_ADMIN     = 0x4,
889
890     /** IPv6 Site-Local scope.*/
891     CT_SCOPE_SITE      = 0x5,
892
893     /** IPv6 Organization-Local scope.*/
894     CT_SCOPE_ORG       = 0x8,
895
896     /** IPv6 Global scope.*/
897     CT_SCOPE_GLOBAL    = 0xE,
898 } OCConnectivityType;
899
900 /** bit shift required for connectivity adapter.*/
901 #define CT_ADAPTER_SHIFT 16
902
903 /** Mask Flag.*/
904 #define CT_MASK_FLAGS 0xFFFF
905
906 /** Mask Adapter.*/
907 #define CT_MASK_ADAPTER 0xFFFF0000
908
909 /**
910  *  OCDoResource methods to dispatch the request
911  */
912 typedef enum
913 {
914     OC_REST_NOMETHOD       = 0,
915
916     /** Read.*/
917     OC_REST_GET            = (1 << 0),
918
919     /** Write.*/
920     OC_REST_PUT            = (1 << 1),
921
922     /** Update.*/
923     OC_REST_POST           = (1 << 2),
924
925     /** Delete.*/
926     OC_REST_DELETE         = (1 << 3),
927
928     /** Register observe request for most up date notifications ONLY.*/
929     OC_REST_OBSERVE        = (1 << 4),
930
931     /** Register observe request for all notifications, including stale notifications.*/
932     OC_REST_OBSERVE_ALL    = (1 << 5),
933
934 #ifdef WITH_PRESENCE
935     /** Subscribe for all presence notifications of a particular resource.*/
936     OC_REST_PRESENCE       = (1 << 7),
937
938 #endif
939     /** Allows OCDoResource caller to do discovery.*/
940     OC_REST_DISCOVER       = (1 << 8)
941 } OCMethod;
942
943 /**
944  *  Formats for payload encoding.
945  */
946 typedef enum
947 {
948     OC_FORMAT_CBOR,
949     OC_FORMAT_VND_OCF_CBOR,
950     OC_FORMAT_JSON,
951     OC_FORMAT_UNDEFINED,
952     OC_FORMAT_UNSUPPORTED,
953 } OCPayloadFormat;
954
955 /**
956  * Host Mode of Operation.
957  */
958 typedef enum
959 {
960     OC_CLIENT = 0,
961     OC_SERVER,
962     OC_CLIENT_SERVER,
963     OC_GATEWAY          /**< Client server mode along with routing capabilities.*/
964 } OCMode;
965
966 /**
967  * Quality of Service attempts to abstract the guarantees provided by the underlying transport
968  * protocol. The precise definitions of each quality of service level depend on the
969  * implementation. In descriptions below are for the current implementation and may changed
970  * over time.
971  */
972 typedef enum
973 {
974     /** Packet delivery is best effort.*/
975     OC_LOW_QOS = 0,
976
977     /** Packet delivery is best effort.*/
978     OC_MEDIUM_QOS,
979
980     /** Acknowledgments are used to confirm delivery.*/
981     OC_HIGH_QOS,
982
983     /** No Quality is defined, let the stack decide.*/
984     OC_NA_QOS
985 } OCQualityOfService;
986
987 /**
988  * Resource Properties.
989  * The value of a policy property is defined as bitmap.
990  * The LSB represents OC_DISCOVERABLE and Second LSB bit represents OC_OBSERVABLE and so on.
991  * Not including the policy property is equivalent to zero.
992  *
993  */
994 typedef enum
995 {
996     /** When none of the bits are set, the resource is non-secure, non-discoverable &
997      *  non-observable by the client.*/
998     OC_RES_PROP_NONE = (0),
999
1000     /** When this bit is set, the resource is allowed to be discovered by clients.*/
1001     OC_DISCOVERABLE  = (1 << 0),
1002
1003     /** When this bit is set, the resource is allowed to be observed by clients.*/
1004     OC_OBSERVABLE    = (1 << 1),
1005
1006     /** When this bit is set, the resource is initialized, otherwise the resource
1007      *  is 'inactive'. 'inactive' signifies that the resource has been marked for
1008      *  deletion or is already deleted.*/
1009     OC_ACTIVE        = (1 << 2),
1010
1011     /** When this bit is set, the resource has been marked as 'slow'.
1012      * 'slow' signifies that responses from this resource can expect delays in
1013      *  processing its requests from clients.*/
1014     OC_SLOW          = (1 << 3),
1015
1016     /** When this bit is set, the resource supports access via non-secure endpoints. */
1017     OC_NONSECURE     = (1 << 6),
1018
1019 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)
1020     /** When this bit is set, the resource is a secure resource.*/
1021     OC_SECURE        = (1 << 4),
1022 #else
1023     OC_SECURE        = (0),
1024 #endif
1025
1026     /** When this bit is set, the resource is allowed to be discovered only
1027      *  if discovery request contains an explicit querystring.
1028      *  Ex: GET /oic/res?rt=oic.sec.acl */
1029     OC_EXPLICIT_DISCOVERABLE   = (1 << 5)
1030
1031 #ifdef WITH_MQ
1032     /** When this bit is set, the resource is allowed to be published */
1033     // @todo
1034     // Since this property is not defined on OCF Spec. it should be set 0 until define it
1035     ,OC_MQ_PUBLISHER     = (0)
1036 #endif
1037
1038 #ifdef MQ_BROKER
1039     /** When this bit is set, the resource is allowed to be notified as MQ broker.*/
1040     // @todo
1041     // Since this property is not defined on OCF Spec. it should be set 0 until define it
1042     ,OC_MQ_BROKER        = (0)
1043 #endif
1044 } OCResourceProperty;
1045
1046 #define OC_MASK_RESOURCE_SECURE    (OC_NONSECURE | OC_SECURE)
1047
1048 /**
1049  * Transport Protocol IDs.
1050  */
1051 typedef enum
1052 {
1053     /** For invalid ID.*/
1054     OC_INVALID_ID   = (1 << 0),
1055
1056     /* For coap ID.*/
1057     OC_COAP_ID      = (1 << 1)
1058 } OCTransportProtocolID;
1059
1060 /**
1061  * Declares Stack Results & Errors.
1062  */
1063 typedef enum
1064 {
1065     /** Success status code - START HERE.*/
1066     OC_STACK_OK = 0,                /** 203, 205*/
1067     OC_STACK_RESOURCE_CREATED,      /** 201*/
1068     OC_STACK_RESOURCE_DELETED,      /** 202*/
1069     OC_STACK_CONTINUE,
1070     OC_STACK_RESOURCE_CHANGED,      /** 204*/
1071     /** Success status code - END HERE.*/
1072
1073     /** Error status code - START HERE.*/
1074     OC_STACK_INVALID_URI = 20,
1075     OC_STACK_INVALID_QUERY,         /** 400*/
1076     OC_STACK_INVALID_IP,
1077     OC_STACK_INVALID_PORT,
1078     OC_STACK_INVALID_CALLBACK,
1079     OC_STACK_INVALID_METHOD,        /** 405 */
1080
1081     /** Invalid parameter.*/
1082     OC_STACK_INVALID_PARAM,
1083     OC_STACK_INVALID_OBSERVE_PARAM,
1084     OC_STACK_NO_MEMORY,
1085     OC_STACK_COMM_ERROR,            /** 504*/
1086     OC_STACK_TIMEOUT,
1087     OC_STACK_ADAPTER_NOT_ENABLED,
1088     OC_STACK_NOTIMPL,
1089
1090     /** Resource not found.*/
1091     OC_STACK_NO_RESOURCE,           /** 404*/
1092
1093     /** e.g: not supported method or interface.*/
1094     OC_STACK_RESOURCE_ERROR,
1095     OC_STACK_SLOW_RESOURCE,
1096     OC_STACK_DUPLICATE_REQUEST,
1097
1098     /** Resource has no registered observers.*/
1099     OC_STACK_NO_OBSERVERS,
1100     OC_STACK_OBSERVER_NOT_FOUND,
1101     OC_STACK_VIRTUAL_DO_NOT_HANDLE,
1102     OC_STACK_INVALID_OPTION,        /** 402*/
1103
1104     /** The remote reply contained malformed data.*/
1105     OC_STACK_MALFORMED_RESPONSE,
1106     OC_STACK_PERSISTENT_BUFFER_REQUIRED,
1107     OC_STACK_INVALID_REQUEST_HANDLE,
1108     OC_STACK_INVALID_DEVICE_INFO,
1109     OC_STACK_INVALID_JSON,
1110
1111     /** Request is not authorized by Resource Server. */
1112     OC_STACK_UNAUTHORIZED_REQ,      /** 401*/
1113     OC_STACK_TOO_LARGE_REQ,         /** 413*/
1114
1115     /** Error code from PDM */
1116     OC_STACK_PDM_IS_NOT_INITIALIZED,
1117     OC_STACK_DUPLICATE_UUID,
1118     OC_STACK_INCONSISTENT_DB,
1119
1120     /**
1121      * Error code from OTM
1122      * This error is pushed from DTLS interface when handshake failure happens
1123      */
1124     OC_STACK_AUTHENTICATION_FAILURE,
1125     OC_STACK_NOT_ALLOWED_OXM,
1126     OC_STACK_CONTINUE_OPERATION,
1127
1128     /** Request come from endpoint which is not mapped to the resource. */
1129     OC_STACK_BAD_ENDPOINT,
1130
1131     /** Insert all new error codes here!.*/
1132 #ifdef WITH_PRESENCE
1133     OC_STACK_PRESENCE_STOPPED = 128,
1134     OC_STACK_PRESENCE_TIMEOUT,
1135     OC_STACK_PRESENCE_DO_NOT_HANDLE,
1136 #endif
1137
1138     /** Request is denied by the user*/
1139     OC_STACK_USER_DENIED_REQ,
1140     OC_STACK_NOT_ACCEPTABLE,         /** 406 */
1141
1142     /** ERROR code from server */
1143     OC_STACK_FORBIDDEN_REQ,          /** 403*/
1144     OC_STACK_INTERNAL_SERVER_ERROR,  /** 500*/
1145     OC_STACK_GATEWAY_TIMEOUT,        /** 504*/
1146     OC_STACK_SERVICE_UNAVAILABLE,    /** 503*/
1147
1148     /** ERROR in stack.*/
1149     OC_STACK_ERROR = 255
1150     /** Error status code - END HERE.*/
1151 } OCStackResult;
1152
1153 /**
1154  * Handle to an OCDoResource invocation.
1155  */
1156 typedef void * OCDoHandle;
1157
1158 /**
1159  * Handle to an OCResource object owned by the OCStack.
1160  */
1161 typedef void * OCResourceHandle;
1162
1163 /**
1164  * Handle to an OCRequest object owned by the OCStack.
1165  */
1166 typedef void * OCRequestHandle;
1167
1168 /**
1169  * Unique identifier for each observation request. Used when observations are
1170  * registered or de-registered. Used by entity handler to signal specific
1171  * observers to be notified of resource changes.
1172  * There can be maximum of 256 observations per server.
1173  */
1174 typedef uint8_t OCObservationId;
1175
1176 /**
1177  * Sequence number is a 24 bit field,
1178  * per https://tools.ietf.org/html/rfc7641.
1179  */
1180 #define MAX_SEQUENCE_NUMBER              (0xFFFFFF)
1181
1182 /**
1183  * Action associated with observation.
1184  */
1185 typedef enum
1186 {
1187     /** To Register. */
1188     OC_OBSERVE_REGISTER = 0,
1189
1190     /** To Deregister. */
1191     OC_OBSERVE_DEREGISTER = 1,
1192
1193     /** Others. */
1194     OC_OBSERVE_NO_OPTION = 2,
1195
1196 } OCObserveAction;
1197
1198
1199 /**
1200  * Persistent storage handlers. An APP must provide OCPersistentStorage handler pointers
1201  * when it calls OCRegisterPersistentStorageHandler.
1202  * Persistent storage open handler points to default file path.
1203  * It should check file path and whether the file is symbolic link or no.
1204  * Application can point to appropriate SVR database path for it's IoTivity Server.
1205  */
1206 typedef struct {
1207     /** Persistent storage file path.*/
1208     FILE* (* open)(const char *path, const char *mode);
1209
1210     /** Persistent storage read handler.*/
1211     size_t (* read)(void *ptr, size_t size, size_t nmemb, FILE *stream);
1212
1213     /** Persistent storage write handler.*/
1214     size_t (* write)(const void *ptr, size_t size, size_t nmemb, FILE *stream);
1215
1216     /** Persistent storage close handler.*/
1217     int (* close)(FILE *fp);
1218
1219     /** Persistent storage unlink handler.*/
1220     int (* unlink)(const char *path);
1221 } OCPersistentStorage;
1222
1223 /**
1224  * Possible returned values from entity handler.
1225  */
1226 typedef struct
1227 {
1228     /** Action associated with observation request.*/
1229     OCObserveAction action;
1230
1231     /** Identifier for observation being registered/deregistered.*/
1232     OCObservationId obsId;
1233 } OCObservationInfo;
1234
1235 /**
1236  * Possible returned values from entity handler.
1237  */
1238 typedef enum
1239 {
1240     OC_EH_OK = 0,
1241     OC_EH_ERROR,
1242     OC_EH_SLOW,
1243     OC_EH_RESOURCE_CREATED = 201,
1244     OC_EH_RESOURCE_DELETED = 202,
1245     OC_EH_VALID = 203,
1246     OC_EH_CHANGED = 204,
1247     OC_EH_CONTENT = 205,
1248     OC_EH_BAD_REQ = 400,
1249     OC_EH_UNAUTHORIZED_REQ = 401,
1250     OC_EH_BAD_OPT = 402,
1251     OC_EH_FORBIDDEN = 403,
1252     OC_EH_RESOURCE_NOT_FOUND = 404,
1253     OC_EH_METHOD_NOT_ALLOWED = 405,
1254     OC_EH_NOT_ACCEPTABLE = 406,
1255     OC_EH_TOO_LARGE = 413,
1256     OC_EH_UNSUPPORTED_MEDIA_TYPE = 415,
1257     OC_EH_INTERNAL_SERVER_ERROR = 500,
1258     OC_EH_BAD_GATEWAY = 502,
1259     OC_EH_SERVICE_UNAVAILABLE = 503,
1260     OC_EH_RETRANSMIT_TIMEOUT = 504
1261 } OCEntityHandlerResult;
1262
1263 /**
1264  * This structure will be used to define the vendor specific header options to be included
1265  * in communication packets.
1266  */
1267 typedef struct OCHeaderOption
1268 {
1269     /** The protocol ID this option applies to.*/
1270     OCTransportProtocolID protocolID;
1271
1272     /** The header option ID which will be added to communication packets.*/
1273     uint16_t optionID;
1274
1275     /** its length 191.*/
1276     uint16_t optionLength;
1277
1278     /** pointer to its data.*/
1279     uint8_t optionData[MAX_HEADER_OPTION_DATA_LENGTH];
1280
1281 #ifdef __cplusplus
1282     OCHeaderOption() = default;
1283     OCHeaderOption(OCTransportProtocolID pid,
1284                    uint16_t optId,
1285                    uint16_t optlen,
1286                    const uint8_t* optData)
1287         : protocolID(pid),
1288           optionID(optId),
1289           optionLength(optlen)
1290     {
1291
1292         // parameter includes the null terminator.
1293         optionLength = optionLength < MAX_HEADER_OPTION_DATA_LENGTH ?
1294                         optionLength : MAX_HEADER_OPTION_DATA_LENGTH;
1295         memcpy(optionData, optData, optionLength);
1296         optionData[optionLength - 1] = '\0';
1297     }
1298 #endif // __cplusplus
1299 } OCHeaderOption;
1300
1301 /**
1302  * This structure describes the platform properties. All non-Null properties will be
1303  * included in a platform discovery request.
1304  * @deprecated: Use OCSetPropertyValue  to set platform value.
1305  */
1306 typedef struct
1307 {
1308     /** Platform ID.*/
1309     char *platformID;
1310
1311     /** Manufacturer name.*/
1312     char *manufacturerName;
1313
1314     /** Manufacturer URL for platform property.*/
1315     char *manufacturerUrl;
1316
1317     /** Model number.*/
1318     char *modelNumber;
1319
1320     /** Manufacturer date.*/
1321     char *dateOfManufacture;
1322
1323     /** Platform version.*/
1324     char *platformVersion;
1325
1326     /** Operating system version.*/
1327     char *operatingSystemVersion;
1328
1329     /** HW version.*/
1330     char *hardwareVersion;
1331
1332     /** FW version.*/
1333     char *firmwareVersion;
1334
1335     /** Platform support URL.*/
1336     char *supportUrl;
1337
1338     /** System time.*/
1339     char *systemTime;
1340
1341 } OCPlatformInfo;
1342
1343 /**
1344  * This structure is expected as input for device properties.
1345  * device name is mandatory and expected from the application.
1346  * device id of type UUID will be generated by the stack.
1347  * @deprecated: Use OCSetPropertyValue  to set device value.
1348  */
1349 typedef struct
1350 {
1351     /** Pointer to the device name.*/
1352     char *deviceName;
1353     /** Pointer to the types.*/
1354     OCStringLL *types;
1355     /** Pointer to the device specification version.*/
1356     char *specVersion;
1357     /** Pointer to the device data model versions (in CSV format).*/
1358     OCStringLL *dataModelVersions;
1359 } OCDeviceInfo;
1360
1361 /**
1362  *  This enum type for indicate Transport Protocol Suites
1363  */
1364 typedef enum
1365 {
1366     /** For initialize */
1367     OC_NO_TPS         = 0,
1368
1369     /** coap + udp */
1370     OC_COAP           = 1,
1371
1372     /** coaps + udp */
1373     OC_COAPS          = (1 << 1),
1374
1375 #ifdef TCP_ADAPTER
1376     /** coap + tcp */
1377     OC_COAP_TCP       = (1 << 2),
1378
1379     /** coaps + tcp */
1380     OC_COAPS_TCP      = (1 << 3),
1381 #endif
1382 #ifdef HTTP_ADAPTER
1383     /** http + tcp */
1384     OC_HTTP           = (1 << 4),
1385
1386     /** https + tcp */
1387     OC_HTTPS          = (1 << 5),
1388 #endif
1389 #ifdef EDR_ADAPTER
1390     /** coap + rfcomm */
1391     OC_COAP_RFCOMM    = (1 << 6),
1392 #endif
1393 #ifdef LE_ADAPTER
1394     /** coap + gatt */
1395     OC_COAP_GATT      = (1 << 7),
1396 #endif
1397 #ifdef NFC_ADAPTER
1398     /** coap + nfc */
1399     OC_COAP_NFC       = (1 << 8),
1400 #endif
1401 #ifdef RA_ADAPTER
1402     /** coap + remote_access */
1403     OC_COAP_RA        = (1 << 9),
1404 #endif
1405     /** Allow all endpoint.*/
1406     OC_ALL       = 0xffff
1407 } OCTpsSchemeFlags;
1408
1409 #ifdef RA_ADAPTER
1410 /**
1411  * callback for bound JID
1412  */
1413 typedef void (*jid_bound_cb)(char *jid);
1414
1415 /**
1416  * CA Remote Access information for XMPP Client
1417  *
1418  */
1419 typedef struct
1420 {
1421     char *hostname;     /**< XMPP server hostname */
1422     uint16_t   port;    /**< XMPP server serivce port */
1423     char *xmpp_domain;  /**< XMPP login domain */
1424     char *username;     /**< login username */
1425     char *password;     /**< login password */
1426     char *resource;     /**< specific resource for login */
1427     char *user_jid;     /**< specific JID for login */
1428     jid_bound_cb jidbound;  /**< callback when JID bound */
1429 } OCRAInfo_t;
1430 #endif  /* RA_ADAPTER */
1431
1432
1433 /** Enum to describe the type of object held by the OCPayload object.*/
1434 typedef enum
1435 {
1436     /** Contents of the payload are invalid */
1437     PAYLOAD_TYPE_INVALID,
1438     /** The payload is an OCDiscoveryPayload */
1439     PAYLOAD_TYPE_DISCOVERY,
1440     /** The payload of the device */
1441     PAYLOAD_TYPE_DEVICE,
1442     /** The payload type of the platform */
1443     PAYLOAD_TYPE_PLATFORM,
1444     /** The payload is an OCRepPayload */
1445     PAYLOAD_TYPE_REPRESENTATION,
1446     /** The payload is an OCSecurityPayload */
1447     PAYLOAD_TYPE_SECURITY,
1448     /** The payload is an OCPresencePayload */
1449     PAYLOAD_TYPE_PRESENCE,
1450     /** The payload is an OCDiagnosticPayload */
1451     PAYLOAD_TYPE_DIAGNOSTIC,
1452     /** The payload is an OCIntrospectionPayload */
1453     PAYLOAD_TYPE_INTROSPECTION
1454 } OCPayloadType;
1455
1456 /** Enum to describe payload representation for collection and non collection resources.*/
1457 typedef enum
1458 {
1459     /** Used for collection resource when the payload to be created for representation
1460      *  with one or more resource representations should be created as an array of object/ objects
1461      *  1. Collection resource with Link list and Batch interface etc.
1462      */
1463     PAYLOAD_REP_ARRAY,
1464
1465     /** Used for Non Collection resources when payload to be created for the representation with
1466      *  zero or one child representation should be created as an Object and the payload with more
1467      *  than one representation should be created as an Array of Objects.
1468      *  1. Non Collection resource with Link list, Default interfaces etc.
1469      *  2. Collection resource with Default interface.
1470      */
1471     PAYLOAD_REP_OBJECT_ARRAY
1472 } OCPayloadRepresentationType;
1473
1474 /**
1475  * A generic struct representing a payload returned from a resource operation
1476  *
1477  * A pointer to OCPayLoad can be cast to a more specific struct to access members
1478  * for the its type.
1479  */
1480 typedef struct
1481 {
1482     /** The type of message that was received */
1483     OCPayloadType type;
1484 } OCPayload;
1485
1486 typedef enum
1487 {
1488     OCREP_PROP_NULL,
1489     OCREP_PROP_INT,
1490     OCREP_PROP_DOUBLE,
1491     OCREP_PROP_BOOL,
1492     OCREP_PROP_STRING,
1493     OCREP_PROP_BYTE_STRING,
1494     OCREP_PROP_OBJECT,
1495     OCREP_PROP_ARRAY
1496 }OCRepPayloadPropType;
1497
1498 /** This structure will be used to represent a binary string for CBOR payloads.*/
1499 typedef struct
1500 {
1501     /** pointer to data bytes.*/
1502     uint8_t* bytes;
1503
1504     /** number of data bytes.*/
1505     size_t   len;
1506 } OCByteString;
1507
1508 #define MAX_REP_ARRAY_DEPTH 3
1509 typedef struct
1510 {
1511     OCRepPayloadPropType type;
1512     size_t dimensions[MAX_REP_ARRAY_DEPTH];
1513
1514     union
1515     {
1516         int64_t* iArray;
1517         double* dArray;
1518         bool* bArray;
1519         char** strArray;
1520
1521         /** pointer to ByteString array.*/
1522         OCByteString* ocByteStrArray;
1523
1524         struct OCRepPayload** objArray;
1525     };
1526 } OCRepPayloadValueArray;
1527
1528 typedef struct OCRepPayloadValue
1529 {
1530     char* name;
1531     OCRepPayloadPropType type;
1532     union
1533     {
1534         int64_t i;
1535         double d;
1536         bool b;
1537         char* str;
1538
1539         /** ByteString object.*/
1540         OCByteString ocByteStr;
1541
1542         struct OCRepPayload* obj;
1543         OCRepPayloadValueArray arr;
1544     };
1545     struct OCRepPayloadValue* next;
1546
1547 } OCRepPayloadValue;
1548
1549 // used for get/set/put/observe/etc representations
1550 typedef struct OCRepPayload
1551 {
1552     OCPayload base;
1553     char* uri;
1554     OCStringLL* types;
1555     OCStringLL* interfaces;
1556     OCRepPayloadValue* values;
1557     OCPayloadRepresentationType repType;
1558     struct OCRepPayload* next;
1559 } OCRepPayload;
1560
1561 // used inside a resource payload
1562 typedef struct OCEndpointPayload
1563 {
1564     char* tps;
1565     char* addr;
1566     OCTransportFlags family;
1567     uint16_t port;
1568     uint16_t pri;
1569     struct OCEndpointPayload* next;
1570 } OCEndpointPayload;
1571
1572 // used inside a discovery payload
1573 typedef struct OCResourcePayload
1574 {
1575     char* uri;
1576     char* rel;
1577     char* anchor;
1578     OCStringLL* types;
1579     OCStringLL* interfaces;
1580     uint8_t bitmap;
1581     bool secure;
1582     uint16_t port;
1583 #ifdef TCP_ADAPTER
1584     uint16_t tcpPort;
1585 #endif
1586     struct OCResourcePayload* next;
1587     OCEndpointPayload* eps;
1588 } OCResourcePayload;
1589
1590 typedef struct OCDiscoveryPayload
1591 {
1592     OCPayload base;
1593
1594     /** Device Id */
1595     char *sid;
1596
1597     /** Name */
1598     char *name;
1599
1600     /** Resource Type */
1601     OCStringLL *type;
1602
1603     /** Interface */
1604     OCStringLL *iface;
1605
1606     /** This structure holds the old /oic/res response. */
1607     OCResourcePayload *resources;
1608
1609     /** Holding address of the next DiscoveryPayload. */
1610     struct OCDiscoveryPayload *next;
1611
1612 } OCDiscoveryPayload;
1613
1614 typedef struct
1615 {
1616     OCPayload base;
1617     uint8_t* securityData;
1618     size_t payloadSize;
1619 } OCSecurityPayload;
1620
1621 #ifdef WITH_PRESENCE
1622 typedef struct
1623 {
1624     OCPayload base;
1625     uint32_t sequenceNumber;
1626     uint32_t maxAge;
1627     OCPresenceTrigger trigger;
1628     char* resourceType;
1629 } OCPresencePayload;
1630 #endif
1631
1632 typedef struct
1633 {
1634     OCPayload base;
1635     char* message;
1636 } OCDiagnosticPayload;
1637
1638 typedef struct
1639 {
1640     OCPayload base;
1641     OCByteString cborPayload;
1642 } OCIntrospectionPayload;
1643
1644 /**
1645  * Incoming requests handled by the server. Requests are passed in as a parameter to the
1646  * OCEntityHandler callback API.
1647  * The OCEntityHandler callback API must be implemented in the application in order
1648  * to receive these requests.
1649  */
1650 typedef struct
1651 {
1652     /** Associated resource.*/
1653     OCResourceHandle resource;
1654
1655     /** Associated request handle.*/
1656     OCRequestHandle requestHandle;
1657
1658     /** the REST method retrieved from received request PDU.*/
1659     OCMethod method;
1660
1661     /** description of endpoint that sent the request.*/
1662     OCDevAddr devAddr;
1663
1664     /** resource query send by client.*/
1665     char * query;
1666
1667     /** Information associated with observation - valid only when OCEntityHandler flag includes
1668      * ::OC_OBSERVE_FLAG.*/
1669     OCObservationInfo obsInfo;
1670
1671     /** Number of the received vendor specific header options.*/
1672     uint8_t numRcvdVendorSpecificHeaderOptions;
1673
1674     /** Pointer to the array of the received vendor specific header options.*/
1675     OCHeaderOption * rcvdVendorSpecificHeaderOptions;
1676
1677     /** Message id.*/
1678     uint16_t messageID;
1679
1680     /** the payload from the request PDU.*/
1681     OCPayload *payload;
1682
1683 } OCEntityHandlerRequest;
1684
1685
1686 /**
1687  * Response from queries to remote servers. Queries are made by calling the OCDoResource API.
1688  */
1689 typedef struct
1690 {
1691     /** Address of remote server.*/
1692     OCDevAddr devAddr;
1693
1694     /** backward compatibility (points to devAddr).*/
1695     OCDevAddr *addr;
1696
1697     /** backward compatibility.*/
1698     OCConnectivityType connType;
1699
1700     /** the security identity of the remote server.*/
1701     OCIdentity identity;
1702
1703     /** the is the result of our stack, OCStackResult should contain coap/other error codes.*/
1704     OCStackResult result;
1705
1706     /** If associated with observe, this will represent the sequence of notifications from server.*/
1707     uint32_t sequenceNumber;
1708
1709     /** resourceURI.*/
1710     const char * resourceUri;
1711
1712     /** the payload for the response PDU.*/
1713     OCPayload *payload;
1714
1715     /** Number of the received vendor specific header options.*/
1716     uint8_t numRcvdVendorSpecificHeaderOptions;
1717
1718     /** An array of the received vendor specific header options.*/
1719     OCHeaderOption rcvdVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1720 } OCClientResponse;
1721
1722 /**
1723  * Request handle is passed to server via the entity handler for each incoming request.
1724  * Stack assigns when request is received, server sets to indicate what request response is for.
1725  */
1726 typedef struct
1727 {
1728     /** Request handle.*/
1729     OCRequestHandle requestHandle;
1730
1731     /** Resource handle. (@deprecated: This parameter is not used.) */
1732     OCResourceHandle resourceHandle;
1733
1734     /** Allow the entity handler to pass a result with the response.*/
1735     OCEntityHandlerResult  ehResult;
1736
1737     /** This is the pointer to server payload data to be transferred.*/
1738     OCPayload* payload;
1739
1740     /** number of the vendor specific header options .*/
1741     uint8_t numSendVendorSpecificHeaderOptions;
1742
1743     /** An array of the vendor specific header options the entity handler wishes to use in response.*/
1744     OCHeaderOption sendVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1745
1746     /** Resource path of new resource that entity handler might create.*/
1747     char resourceUri[MAX_URI_LENGTH];
1748
1749     /** Server sets to true for persistent response buffer,false for non-persistent response buffer*/
1750     uint8_t persistentBufferFlag;
1751 } OCEntityHandlerResponse;
1752
1753 /**
1754  * Entity's state
1755  */
1756 typedef enum
1757 {
1758     /** Request state.*/
1759     OC_REQUEST_FLAG = (1 << 1),
1760     /** Observe state.*/
1761     OC_OBSERVE_FLAG = (1 << 2)
1762 } OCEntityHandlerFlag;
1763
1764 /**
1765  * Possible return values from client application callback
1766  *
1767  * A client application callback returns an OCStackApplicationResult to indicate whether
1768  * the stack should continue to keep the callback registered.
1769  */
1770 typedef enum
1771 {
1772     /** Make no more calls to the callback and call the OCClientContextDeleter for this callback */
1773     OC_STACK_DELETE_TRANSACTION = 0,
1774     /** Keep this callback registered and call it if an apropriate event occurs */
1775     OC_STACK_KEEP_TRANSACTION
1776 } OCStackApplicationResult;
1777
1778
1779 //#ifdef DIRECT_PAIRING
1780 /**
1781  * @brief   direct pairing Method Type.
1782  *              0:  not allowed
1783  *              1:  pre-configured pin
1784  *              2:  random pin
1785  */
1786 typedef enum OCPrm
1787 {
1788     DP_NOT_ALLOWED             = 0x0,
1789     DP_PRE_CONFIGURED        = (0x1 << 0),
1790     DP_RANDOM_PIN               = (0x1 << 1),
1791 } OCPrm_t;
1792
1793 /**
1794  * Device Information of discoverd direct pairing device(s).
1795  */
1796 typedef struct OCDPDev
1797 {
1798     OCDevAddr               endpoint;
1799     OCConnectivityType   connType;
1800     uint16_t                     securePort;
1801     bool                  edp;
1802     OCPrm_t           *prm;
1803     size_t                prmLen;
1804     OCUUIdentity     deviceID;
1805     OCUUIdentity     rowner;
1806     struct OCDPDev *next;
1807 } OCDPDev_t;
1808 //#endif // DIRECT_PAIRING
1809
1810 /*
1811  * -------------------------------------------------------------------------------------------
1812  * Callback function definitions
1813  * -------------------------------------------------------------------------------------------
1814  */
1815
1816 /**
1817  * Client applications implement this callback to consume responses received from Servers.
1818  */
1819 typedef OCStackApplicationResult (* OCClientResponseHandler)(void *context, OCDoHandle handle,
1820     OCClientResponse * clientResponse);
1821
1822 /**
1823  * Client applications using a context pointer implement this callback to delete the
1824  * context upon removal of the callback/context pointer from the internal callback-list.
1825  */
1826 typedef void (* OCClientContextDeleter)(void *context);
1827
1828 /**
1829  * This info is passed from application to OC Stack when initiating a request to Server.
1830  */
1831 typedef struct OCCallbackData
1832 {
1833     /** Pointer to the context.*/
1834     void *context;
1835
1836     /** The pointer to a function the stack will call to handle the requests.*/
1837     OCClientResponseHandler cb;
1838
1839     /** A pointer to a function to delete the context when this callback is removed.*/
1840     OCClientContextDeleter cd;
1841
1842 #ifdef __cplusplus
1843     OCCallbackData() = default;
1844     OCCallbackData(void* ctx, OCClientResponseHandler callback, OCClientContextDeleter deleter)
1845         :context(ctx), cb(callback), cd(deleter){}
1846 #endif // __cplusplus
1847 } OCCallbackData;
1848
1849 /**
1850  * Application server implementations must implement this callback to consume requests OTA.
1851  * Entity handler callback needs to fill the resPayload of the entityHandlerRequest.
1852  *
1853  * When you set specific return value like OC_EH_CHANGED, OC_EH_CONTENT,
1854  * OC_EH_SLOW and etc in entity handler callback,
1855  * ocstack will be not send response automatically to client
1856  * except for error return value like OC_EH_ERROR.
1857  *
1858  * If you want to send response to client with specific result,
1859  * OCDoResponse API should be called with the result value.
1860  *
1861  * e.g)
1862  *
1863  * OCEntityHandlerResponse response;
1864  *
1865  * ..
1866  *
1867  * response.ehResult = OC_EH_CHANGED;
1868  *
1869  * ..
1870  *
1871  * OCDoResponse(&response)
1872  *
1873  * ..
1874  *
1875  * return OC_EH_OK;
1876  */
1877 typedef OCEntityHandlerResult (*OCEntityHandler)
1878 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, void* callbackParam);
1879
1880 /**
1881  * Device Entity handler need to use this call back instead of OCEntityHandler.
1882  *
1883  * When you set specific return value like OC_EH_CHANGED, OC_EH_CONTENT,
1884  * OC_EH_SLOW and etc in entity handler callback,
1885  * ocstack will be not send response automatically to client
1886  * except for error return value like OC_EH_ERROR.
1887  *
1888  * If you want to send response to client with specific result,
1889  * OCDoResponse API should be called with the result value.
1890  *
1891  * e.g)
1892  *
1893  * OCEntityHandlerResponse response;
1894  *
1895  * ..
1896  *
1897  * response.ehResult = OC_EH_CHANGED;
1898  *
1899  * ..
1900  *
1901  * OCDoResponse(&response)
1902  *
1903  * ..
1904  *
1905  * return OC_EH_OK;
1906  */
1907 typedef OCEntityHandlerResult (*OCDeviceEntityHandler)
1908 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, char* uri, void* callbackParam);
1909
1910 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)
1911 /**
1912  * Callback function definition for Change in TrustCertChain
1913  *
1914  * @param[in] ctx - user context returned in the callback.
1915  * @param[in] credId - trustCertChain changed for this ID
1916  * @param[in] trustCertChain - trustcertchain binary blob.
1917  * @param[in] chainSize - size of trustchain
1918  */
1919 typedef void (*TrustCertChainChangeCB)(void *ctx, uint16_t credId, uint8_t *trustCertChain,
1920         size_t chainSize);
1921
1922 /**
1923  * certChain context structure.
1924  */
1925 typedef struct trustCertChainContext
1926 {
1927     TrustCertChainChangeCB callback;
1928     void *context;
1929 } trustCertChainContext_t;
1930 #endif
1931
1932 #if defined(TCP_ADAPTER) && defined(WITH_CLOUD)
1933 /**
1934  * User Preference of connectivity channel
1935  */
1936 typedef enum
1937 {
1938     /** Cloud TCP */
1939     OC_USER_PREF_CLOUD = 0,
1940     /** local UDP */
1941     OC_USER_PREF_LOCAL_UDP = 1,
1942     /** local TCP */
1943     OC_USER_PREF_LOCAL_TCP =2
1944 } OCConnectUserPref_t;
1945
1946 #endif
1947
1948 #ifdef __cplusplus
1949 }
1950 #endif // __cplusplus
1951
1952 #endif /* OCTYPES_H_ */