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