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