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