Merge remote branch '1.3-rel' (80e11aa)
[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 represent time to live.*/
187 #define OC_RSRVD_TTL                    "ttl"
188
189 /** To indicate how long RD should publish this item.*/
190 #define OC_RSRVD_DEVICE_TTL             OC_RSRVD_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              "thisupdate"
542
543 #define OC_RSRVD_NEXT_UPDATE              "nu"
544
545 #define OC_RSRVD_SERIAL_NUMBERS           "rcsn"
546
547 #define OC_RSRVD_CRL                      "crldata"
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  * TODO: Move these COAP defines to CoAP lib once approved.
651  */
652 #define COAP_OPTION_ACCEPT_VERSION 2049
653 #define COAP_OPTION_CONTENT_VERSION 2053
654
655 /**
656  * These enums (OCTransportAdapter and OCTransportFlags) must
657  * be kept synchronized with OCConnectivityType (below) as well as
658  * CATransportAdapter and CATransportFlags (in CACommon.h).
659  */
660 typedef enum
661 {
662     /** value zero indicates discovery.*/
663     OC_DEFAULT_ADAPTER = 0,
664
665     /** IPv4 and IPv6, including 6LoWPAN.*/
666     OC_ADAPTER_IP           = (1 << 0),
667
668     /** GATT over Bluetooth LE.*/
669     OC_ADAPTER_GATT_BTLE    = (1 << 1),
670
671     /** RFCOMM over Bluetooth EDR.*/
672     OC_ADAPTER_RFCOMM_BTEDR = (1 << 2),
673 #ifdef RA_ADAPTER
674     /**Remote Access over XMPP.*/
675     OC_ADAPTER_REMOTE_ACCESS = (1 << 3),
676 #endif
677     /** CoAP over TCP.*/
678     OC_ADAPTER_TCP           = (1 << 4),
679
680     /** NFC Transport for Messaging.*/
681     OC_ADAPTER_NFC           = (1 << 5)
682 } OCTransportAdapter;
683
684 typedef enum
685 {
686     /** default flag is 0.*/
687     OC_DEFAULT_BT_FLAGS = 0,
688     /** disable BLE advertisement.*/
689     OC_LE_ADV_DISABLE   = 0x1,
690     /** enable BLE advertisement.*/
691     OC_LE_ADV_ENABLE    = 0x2,
692     /** disable gatt server.*/
693     OC_LE_SERVER_DISABLE = (1 << 4),
694     /** disable rfcomm server.*/
695     OC_EDR_SERVER_DISABLE = (1 << 7)
696 } OCTransportBTFlags_t;
697
698 /**
699  * Log level to print can be controlled through this enum.
700  * And privacy logs contained uid, Token, Device id, etc can also disable.
701  * This enum (OCLogLevel) must be kept synchronized with
702  * CAUtilLogLevel_t (in CACommon.h).
703  */
704 typedef enum
705 {
706     OC_LOG_LEVEL_ALL = 1,             // all logs.
707     OC_LOG_LEVEL_INFO,                // debug level is disabled.
708 } OCLogLevel;
709
710 /**
711  *  Enum layout assumes some targets have 16-bit integer (e.g., Arduino).
712  */
713 typedef enum
714 {
715     /** default flag is 0*/
716     OC_DEFAULT_FLAGS = 0,
717
718     /** Insecure transport is the default (subject to change).*/
719     /** secure the transport path*/
720     OC_FLAG_SECURE     = (1 << 4),
721
722     /** IPv4 & IPv6 auto-selection is the default.*/
723     /** IP & TCP adapter only.*/
724     OC_IP_USE_V6       = (1 << 5),
725
726     /** IP & TCP adapter only.*/
727     OC_IP_USE_V4       = (1 << 6),
728
729     /** Multicast only.*/
730     OC_MULTICAST       = (1 << 7),
731
732     /** Link-Local multicast is the default multicast scope for IPv6.
733      *  These are placed here to correspond to the IPv6 multicast address bits.*/
734
735     /** IPv6 Interface-Local scope (loopback).*/
736     OC_SCOPE_INTERFACE = 0x1,
737
738     /** IPv6 Link-Local scope (default).*/
739     OC_SCOPE_LINK      = 0x2,
740
741     /** IPv6 Realm-Local scope. */
742     OC_SCOPE_REALM     = 0x3,
743
744     /** IPv6 Admin-Local scope. */
745     OC_SCOPE_ADMIN     = 0x4,
746
747     /** IPv6 Site-Local scope. */
748     OC_SCOPE_SITE      = 0x5,
749
750     /** IPv6 Organization-Local scope. */
751     OC_SCOPE_ORG       = 0x8,
752
753     /**IPv6 Global scope. */
754     OC_SCOPE_GLOBAL    = 0xE,
755
756 } OCTransportFlags;
757
758 /** Bit mask for scope.*/
759 #define OC_MASK_SCOPE    (0x000F)
760
761 /** Bit mask for Mods.*/
762 #define OC_MASK_MODS     (0x0FF0)
763 #define OC_MASK_FAMS     (OC_IP_USE_V6|OC_IP_USE_V4)
764
765 typedef struct OCStringLL
766 {
767     struct OCStringLL *next;
768     char* value;
769 } OCStringLL;
770
771 /**
772  * End point identity.
773  */
774 typedef struct
775 {
776     /** Identity Length */
777     uint16_t id_length;
778
779     /** Array of end point identity.*/
780     unsigned char id[MAX_IDENTITY_SIZE];
781 } OCIdentity;
782
783 /**
784  * Universally unique identifier.
785  */
786 typedef struct
787 {
788     /** identitifier string.*/
789     unsigned char id[UUID_IDENTITY_SIZE];
790 } OCUUIdentity;
791
792 /**
793  * Data structure to encapsulate IPv4/IPv6/Contiki/lwIP device addresses.
794  * OCDevAddr must be the same as CAEndpoint (in CACommon.h).
795  */
796 typedef struct
797 {
798     /** adapter type.*/
799     OCTransportAdapter      adapter;
800
801     /** transport modifiers.*/
802     OCTransportFlags        flags;
803
804     /** for IP.*/
805     uint16_t                port;
806
807     /** address for all adapters.*/
808     char                    addr[MAX_ADDR_STR_SIZE];
809
810     /** usually zero for default interface.*/
811     uint32_t                ifindex;
812
813     /** destination GatewayID:ClientId.*/
814     char                    routeData[MAX_ADDR_STR_SIZE];
815
816     /** device ID of remote.*/
817     char                    remoteId[MAX_IDENTITY_SIZE];
818
819 } OCDevAddr;
820
821 /**
822  * This enum type includes elements of both ::OCTransportAdapter and ::OCTransportFlags.
823  * It is defined conditionally because the smaller definition limits expandability on 32/64 bit
824  * integer machines, and the larger definition won't fit into an enum on 16-bit integer machines
825  * like Arduino.
826  *
827  * This structure must directly correspond to ::OCTransportAdapter and ::OCTransportFlags.
828  */
829 typedef enum
830 {
831     /** use when defaults are ok. */
832     CT_DEFAULT = 0,
833
834     /** IPv4 and IPv6, including 6LoWPAN.*/
835     CT_ADAPTER_IP           = (1 << 16),
836
837     /** GATT over Bluetooth LE.*/
838     CT_ADAPTER_GATT_BTLE    = (1 << 17),
839
840     /** RFCOMM over Bluetooth EDR.*/
841     CT_ADAPTER_RFCOMM_BTEDR = (1 << 18),
842
843 #ifdef RA_ADAPTER
844     /** Remote Access over XMPP.*/
845     CT_ADAPTER_REMOTE_ACCESS = (1 << 19),
846 #endif
847     /** CoAP over TCP.*/
848     CT_ADAPTER_TCP     = (1 << 20),
849
850     /** NFC Transport.*/
851     CT_ADAPTER_NFC     = (1 << 21),
852
853     /** Insecure transport is the default (subject to change).*/
854
855     /** secure the transport path.*/
856     CT_FLAG_SECURE     = (1 << 4),
857
858     /** IPv4 & IPv6 autoselection is the default.*/
859
860     /** IP adapter only.*/
861     CT_IP_USE_V6       = (1 << 5),
862
863     /** IP adapter only.*/
864     CT_IP_USE_V4       = (1 << 6),
865
866     /** Link-Local multicast is the default multicast scope for IPv6.
867      * These are placed here to correspond to the IPv6 address bits.*/
868
869     /** IPv6 Interface-Local scope(loopback).*/
870     CT_SCOPE_INTERFACE = 0x1,
871
872     /** IPv6 Link-Local scope (default).*/
873     CT_SCOPE_LINK      = 0x2,
874
875     /** IPv6 Realm-Local scope.*/
876     CT_SCOPE_REALM     = 0x3,
877
878     /** IPv6 Admin-Local scope.*/
879     CT_SCOPE_ADMIN     = 0x4,
880
881     /** IPv6 Site-Local scope.*/
882     CT_SCOPE_SITE      = 0x5,
883
884     /** IPv6 Organization-Local scope.*/
885     CT_SCOPE_ORG       = 0x8,
886
887     /** IPv6 Global scope.*/
888     CT_SCOPE_GLOBAL    = 0xE,
889 } OCConnectivityType;
890
891 /** bit shift required for connectivity adapter.*/
892 #define CT_ADAPTER_SHIFT 16
893
894 /** Mask Flag.*/
895 #define CT_MASK_FLAGS 0xFFFF
896
897 /** Mask Adapter.*/
898 #define CT_MASK_ADAPTER 0xFFFF0000
899
900 /**
901  *  OCDoResource methods to dispatch the request
902  */
903 typedef enum
904 {
905     OC_REST_NOMETHOD       = 0,
906
907     /** Read.*/
908     OC_REST_GET            = (1 << 0),
909
910     /** Write.*/
911     OC_REST_PUT            = (1 << 1),
912
913     /** Update.*/
914     OC_REST_POST           = (1 << 2),
915
916     /** Delete.*/
917     OC_REST_DELETE         = (1 << 3),
918
919     /** Register observe request for most up date notifications ONLY.*/
920     OC_REST_OBSERVE        = (1 << 4),
921
922     /** Register observe request for all notifications, including stale notifications.*/
923     OC_REST_OBSERVE_ALL    = (1 << 5),
924
925 #ifdef WITH_PRESENCE
926     /** Subscribe for all presence notifications of a particular resource.*/
927     OC_REST_PRESENCE       = (1 << 7),
928
929 #endif
930     /** Allows OCDoResource caller to do discovery.*/
931     OC_REST_DISCOVER       = (1 << 8)
932 } OCMethod;
933
934 /**
935  *  Formats for payload encoding.
936  */
937 typedef enum
938 {
939     OC_FORMAT_CBOR,
940     OC_FORMAT_VND_OCF_CBOR,
941     OC_FORMAT_JSON,
942     OC_FORMAT_UNDEFINED,
943     OC_FORMAT_UNSUPPORTED,
944 } OCPayloadFormat;
945
946 /**
947  * Host Mode of Operation.
948  */
949 typedef enum
950 {
951     OC_CLIENT = 0,
952     OC_SERVER,
953     OC_CLIENT_SERVER,
954     OC_GATEWAY          /**< Client server mode along with routing capabilities.*/
955 } OCMode;
956
957 /**
958  * Quality of Service attempts to abstract the guarantees provided by the underlying transport
959  * protocol. The precise definitions of each quality of service level depend on the
960  * implementation. In descriptions below are for the current implementation and may changed
961  * over time.
962  */
963 typedef enum
964 {
965     /** Packet delivery is best effort.*/
966     OC_LOW_QOS = 0,
967
968     /** Packet delivery is best effort.*/
969     OC_MEDIUM_QOS,
970
971     /** Acknowledgments are used to confirm delivery.*/
972     OC_HIGH_QOS,
973
974     /** No Quality is defined, let the stack decide.*/
975     OC_NA_QOS
976 } OCQualityOfService;
977
978 /**
979  * Resource Properties.
980  * The value of a policy property is defined as bitmap.
981  * The LSB represents OC_DISCOVERABLE and Second LSB bit represents OC_OBSERVABLE and so on.
982  * Not including the policy property is equivalent to zero.
983  *
984  */
985 typedef enum
986 {
987     /** When none of the bits are set, the resource is non-secure, non-discoverable &
988      *  non-observable by the client.*/
989     OC_RES_PROP_NONE = (0),
990
991     /** When this bit is set, the resource is allowed to be discovered by clients.*/
992     OC_DISCOVERABLE  = (1 << 0),
993
994     /** When this bit is set, the resource is allowed to be observed by clients.*/
995     OC_OBSERVABLE    = (1 << 1),
996
997     /** When this bit is set, the resource is initialized, otherwise the resource
998      *  is 'inactive'. 'inactive' signifies that the resource has been marked for
999      *  deletion or is already deleted.*/
1000     OC_ACTIVE        = (1 << 2),
1001
1002     /** When this bit is set, the resource has been marked as 'slow'.
1003      * 'slow' signifies that responses from this resource can expect delays in
1004      *  processing its requests from clients.*/
1005     OC_SLOW          = (1 << 3),
1006
1007     /** When this bit is set, the resource supports access via non-secure endpoints. */
1008     OC_NONSECURE     = (1 << 6),
1009
1010 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)
1011     /** When this bit is set, the resource is a secure resource.*/
1012     OC_SECURE        = (1 << 4),
1013 #else
1014     OC_SECURE        = (0),
1015 #endif
1016
1017     /** When this bit is set, the resource is allowed to be discovered only
1018      *  if discovery request contains an explicit querystring.
1019      *  Ex: GET /oic/res?rt=oic.sec.acl */
1020     OC_EXPLICIT_DISCOVERABLE   = (1 << 5)
1021
1022 #ifdef WITH_MQ
1023     /** When this bit is set, the resource is allowed to be published */
1024     // @todo
1025     // Since this property is not defined on OCF Spec. it should be set 0 until define it
1026     ,OC_MQ_PUBLISHER     = (0)
1027 #endif
1028
1029 #ifdef MQ_BROKER
1030     /** When this bit is set, the resource is allowed to be notified as MQ broker.*/
1031     // @todo
1032     // Since this property is not defined on OCF Spec. it should be set 0 until define it
1033     ,OC_MQ_BROKER        = (0)
1034 #endif
1035 } OCResourceProperty;
1036
1037 #define OC_MASK_RESOURCE_SECURE    (OC_NONSECURE | OC_SECURE)
1038
1039 /**
1040  * Transport Protocol IDs.
1041  */
1042 typedef enum
1043 {
1044     /** For invalid ID.*/
1045     OC_INVALID_ID   = (1 << 0),
1046
1047     /* For coap ID.*/
1048     OC_COAP_ID      = (1 << 1)
1049 } OCTransportProtocolID;
1050
1051 /**
1052  * Declares Stack Results & Errors.
1053  */
1054 typedef enum
1055 {
1056     /** Success status code - START HERE.*/
1057     OC_STACK_OK = 0,                /** 203, 205*/
1058     OC_STACK_RESOURCE_CREATED,      /** 201*/
1059     OC_STACK_RESOURCE_DELETED,      /** 202*/
1060     OC_STACK_CONTINUE,
1061     OC_STACK_RESOURCE_CHANGED,      /** 204*/
1062     /** Success status code - END HERE.*/
1063
1064     /** Error status code - START HERE.*/
1065     OC_STACK_INVALID_URI = 20,
1066     OC_STACK_INVALID_QUERY,         /** 400*/
1067     OC_STACK_INVALID_IP,
1068     OC_STACK_INVALID_PORT,
1069     OC_STACK_INVALID_CALLBACK,
1070     OC_STACK_INVALID_METHOD,
1071
1072     /** Invalid parameter.*/
1073     OC_STACK_INVALID_PARAM,
1074     OC_STACK_INVALID_OBSERVE_PARAM,
1075     OC_STACK_NO_MEMORY,
1076     OC_STACK_COMM_ERROR,            /** 504*/
1077     OC_STACK_TIMEOUT,
1078     OC_STACK_ADAPTER_NOT_ENABLED,
1079     OC_STACK_NOTIMPL,
1080
1081     /** Resource not found.*/
1082     OC_STACK_NO_RESOURCE,           /** 404*/
1083
1084     /** e.g: not supported method or interface.*/
1085     OC_STACK_RESOURCE_ERROR,
1086     OC_STACK_SLOW_RESOURCE,
1087     OC_STACK_DUPLICATE_REQUEST,
1088
1089     /** Resource has no registered observers.*/
1090     OC_STACK_NO_OBSERVERS,
1091     OC_STACK_OBSERVER_NOT_FOUND,
1092     OC_STACK_VIRTUAL_DO_NOT_HANDLE,
1093     OC_STACK_INVALID_OPTION,        /** 402*/
1094
1095     /** The remote reply contained malformed data.*/
1096     OC_STACK_MALFORMED_RESPONSE,
1097     OC_STACK_PERSISTENT_BUFFER_REQUIRED,
1098     OC_STACK_INVALID_REQUEST_HANDLE,
1099     OC_STACK_INVALID_DEVICE_INFO,
1100     OC_STACK_INVALID_JSON,
1101
1102     /** Request is not authorized by Resource Server. */
1103     OC_STACK_UNAUTHORIZED_REQ,      /** 401*/
1104     OC_STACK_TOO_LARGE_REQ,         /** 413*/
1105
1106     /** Error code from PDM */
1107     OC_STACK_PDM_IS_NOT_INITIALIZED,
1108     OC_STACK_DUPLICATE_UUID,
1109     OC_STACK_INCONSISTENT_DB,
1110
1111     /**
1112      * Error code from OTM
1113      * This error is pushed from DTLS interface when handshake failure happens
1114      */
1115     OC_STACK_AUTHENTICATION_FAILURE,
1116     OC_STACK_NOT_ALLOWED_OXM,
1117     OC_STACK_CONTINUE_OPERATION,
1118
1119     /** Request come from endpoint which is not mapped to the resource. */
1120     OC_STACK_BAD_ENDPOINT,
1121
1122     /** Insert all new error codes here!.*/
1123 #ifdef WITH_PRESENCE
1124     OC_STACK_PRESENCE_STOPPED = 128,
1125     OC_STACK_PRESENCE_TIMEOUT,
1126     OC_STACK_PRESENCE_DO_NOT_HANDLE,
1127 #endif
1128
1129     /** Request is denied by the user*/
1130     OC_STACK_USER_DENIED_REQ,
1131     OC_STACK_NOT_ACCEPTABLE,
1132
1133     /** ERROR code from server */
1134     OC_STACK_FORBIDDEN_REQ,          /** 403*/
1135     OC_STACK_INTERNAL_SERVER_ERROR,  /** 500*/
1136     OC_STACK_GATEWAY_TIMEOUT,        /** 504*/
1137     OC_STACK_SERVICE_UNAVAILABLE,    /** 503*/
1138
1139     /** ERROR in stack.*/
1140     OC_STACK_ERROR = 255
1141     /** Error status code - END HERE.*/
1142 } OCStackResult;
1143
1144 /**
1145  * Handle to an OCDoResource invocation.
1146  */
1147 typedef void * OCDoHandle;
1148
1149 /**
1150  * Handle to an OCResource object owned by the OCStack.
1151  */
1152 typedef void * OCResourceHandle;
1153
1154 /**
1155  * Handle to an OCRequest object owned by the OCStack.
1156  */
1157 typedef void * OCRequestHandle;
1158
1159 /**
1160  * Unique identifier for each observation request. Used when observations are
1161  * registered or de-registered. Used by entity handler to signal specific
1162  * observers to be notified of resource changes.
1163  * There can be maximum of 256 observations per server.
1164  */
1165 typedef uint8_t OCObservationId;
1166
1167 /**
1168  * Sequence number is a 24 bit field,
1169  * per https://tools.ietf.org/html/rfc7641.
1170  */
1171 #define MAX_SEQUENCE_NUMBER              (0xFFFFFF)
1172
1173 /**
1174  * Action associated with observation.
1175  */
1176 typedef enum
1177 {
1178     /** To Register. */
1179     OC_OBSERVE_REGISTER = 0,
1180
1181     /** To Deregister. */
1182     OC_OBSERVE_DEREGISTER = 1,
1183
1184     /** Others. */
1185     OC_OBSERVE_NO_OPTION = 2,
1186
1187 } OCObserveAction;
1188
1189
1190 /**
1191  * Persistent storage handlers. An APP must provide OCPersistentStorage handler pointers
1192  * when it calls OCRegisterPersistentStorageHandler.
1193  * Persistent storage open handler points to default file path.
1194  * It should check file path and whether the file is symbolic link or no.
1195  * Application can point to appropriate SVR database path for it's IoTivity Server.
1196  */
1197 typedef struct {
1198     /** Persistent storage file path.*/
1199     FILE* (* open)(const char *path, const char *mode);
1200
1201     /** Persistent storage read handler.*/
1202     size_t (* read)(void *ptr, size_t size, size_t nmemb, FILE *stream);
1203
1204     /** Persistent storage write handler.*/
1205     size_t (* write)(const void *ptr, size_t size, size_t nmemb, FILE *stream);
1206
1207     /** Persistent storage close handler.*/
1208     int (* close)(FILE *fp);
1209
1210     /** Persistent storage unlink handler.*/
1211     int (* unlink)(const char *path);
1212 } OCPersistentStorage;
1213
1214 /**
1215  * Possible returned values from entity handler.
1216  */
1217 typedef struct
1218 {
1219     /** Action associated with observation request.*/
1220     OCObserveAction action;
1221
1222     /** Identifier for observation being registered/deregistered.*/
1223     OCObservationId obsId;
1224 } OCObservationInfo;
1225
1226 /**
1227  * Possible returned values from entity handler.
1228  */
1229 typedef enum
1230 {
1231     OC_EH_OK = 0,
1232     OC_EH_ERROR,
1233     OC_EH_SLOW,
1234     OC_EH_RESOURCE_CREATED = 201,
1235     OC_EH_RESOURCE_DELETED = 202,
1236     OC_EH_VALID = 203,
1237     OC_EH_CHANGED = 204,
1238     OC_EH_CONTENT = 205,
1239     OC_EH_BAD_REQ = 400,
1240     OC_EH_UNAUTHORIZED_REQ = 401,
1241     OC_EH_BAD_OPT = 402,
1242     OC_EH_FORBIDDEN = 403,
1243     OC_EH_RESOURCE_NOT_FOUND = 404,
1244     OC_EH_METHOD_NOT_ALLOWED = 405,
1245     OC_EH_NOT_ACCEPTABLE = 406,
1246     OC_EH_TOO_LARGE = 413,
1247     OC_EH_UNSUPPORTED_MEDIA_TYPE = 415,
1248     OC_EH_INTERNAL_SERVER_ERROR = 500,
1249     OC_EH_BAD_GATEWAY = 502,
1250     OC_EH_SERVICE_UNAVAILABLE = 503,
1251     OC_EH_RETRANSMIT_TIMEOUT = 504
1252 } OCEntityHandlerResult;
1253
1254 /**
1255  * This structure will be used to define the vendor specific header options to be included
1256  * in communication packets.
1257  */
1258 typedef struct OCHeaderOption
1259 {
1260     /** The protocol ID this option applies to.*/
1261     OCTransportProtocolID protocolID;
1262
1263     /** The header option ID which will be added to communication packets.*/
1264     uint16_t optionID;
1265
1266     /** its length 191.*/
1267     uint16_t optionLength;
1268
1269     /** pointer to its data.*/
1270     uint8_t optionData[MAX_HEADER_OPTION_DATA_LENGTH];
1271
1272 #ifdef __cplusplus
1273     OCHeaderOption() = default;
1274     OCHeaderOption(OCTransportProtocolID pid,
1275                    uint16_t optId,
1276                    uint16_t optlen,
1277                    const uint8_t* optData)
1278         : protocolID(pid),
1279           optionID(optId),
1280           optionLength(optlen)
1281     {
1282
1283         // parameter includes the null terminator.
1284         optionLength = optionLength < MAX_HEADER_OPTION_DATA_LENGTH ?
1285                         optionLength : MAX_HEADER_OPTION_DATA_LENGTH;
1286         memcpy(optionData, optData, optionLength);
1287         optionData[optionLength - 1] = '\0';
1288     }
1289 #endif // __cplusplus
1290 } OCHeaderOption;
1291
1292 /**
1293  * This structure describes the platform properties. All non-Null properties will be
1294  * included in a platform discovery request.
1295  * @deprecated: Use OCSetPropertyValue  to set platform value.
1296  */
1297 typedef struct
1298 {
1299     /** Platform ID.*/
1300     char *platformID;
1301
1302     /** Manufacturer name.*/
1303     char *manufacturerName;
1304
1305     /** Manufacturer URL for platform property.*/
1306     char *manufacturerUrl;
1307
1308     /** Model number.*/
1309     char *modelNumber;
1310
1311     /** Manufacturer date.*/
1312     char *dateOfManufacture;
1313
1314     /** Platform version.*/
1315     char *platformVersion;
1316
1317     /** Operating system version.*/
1318     char *operatingSystemVersion;
1319
1320     /** HW version.*/
1321     char *hardwareVersion;
1322
1323     /** FW version.*/
1324     char *firmwareVersion;
1325
1326     /** Platform support URL.*/
1327     char *supportUrl;
1328
1329     /** System time.*/
1330     char *systemTime;
1331
1332 } OCPlatformInfo;
1333
1334 /**
1335  * This structure is expected as input for device properties.
1336  * device name is mandatory and expected from the application.
1337  * device id of type UUID will be generated by the stack.
1338  * @deprecated: Use OCSetPropertyValue  to set device value.
1339  */
1340 typedef struct
1341 {
1342     /** Pointer to the device name.*/
1343     char *deviceName;
1344     /** Pointer to the types.*/
1345     OCStringLL *types;
1346     /** Pointer to the device specification version.*/
1347     char *specVersion;
1348     /** Pointer to the device data model versions (in CSV format).*/
1349     OCStringLL *dataModelVersions;
1350 } OCDeviceInfo;
1351
1352 /**
1353  *  This enum type for indicate Transport Protocol Suites
1354  */
1355 typedef enum
1356 {
1357     /** For initialize */
1358     OC_NO_TPS         = 0,
1359
1360     /** coap + udp */
1361     OC_COAP           = 1,
1362
1363     /** coaps + udp */
1364     OC_COAPS          = (1 << 1),
1365
1366 #ifdef TCP_ADAPTER
1367     /** coap + tcp */
1368     OC_COAP_TCP       = (1 << 2),
1369
1370     /** coaps + tcp */
1371     OC_COAPS_TCP      = (1 << 3),
1372 #endif
1373 #ifdef HTTP_ADAPTER
1374     /** http + tcp */
1375     OC_HTTP           = (1 << 4),
1376
1377     /** https + tcp */
1378     OC_HTTPS          = (1 << 5),
1379 #endif
1380 #ifdef EDR_ADAPTER
1381     /** coap + rfcomm */
1382     OC_COAP_RFCOMM    = (1 << 6),
1383 #endif
1384 #ifdef LE_ADAPTER
1385     /** coap + gatt */
1386     OC_COAP_GATT      = (1 << 7),
1387 #endif
1388 #ifdef NFC_ADAPTER
1389     /** coap + nfc */
1390     OC_COAP_NFC       = (1 << 8),
1391 #endif
1392 #ifdef RA_ADAPTER
1393     /** coap + remote_access */
1394     OC_COAP_RA        = (1 << 9),
1395 #endif
1396     /** Allow all endpoint.*/
1397     OC_ALL       = 0xffff
1398 } OCTpsSchemeFlags;
1399
1400 #ifdef RA_ADAPTER
1401 /**
1402  * callback for bound JID
1403  */
1404 typedef void (*jid_bound_cb)(char *jid);
1405
1406 /**
1407  * CA Remote Access information for XMPP Client
1408  *
1409  */
1410 typedef struct
1411 {
1412     char *hostname;     /**< XMPP server hostname */
1413     uint16_t   port;    /**< XMPP server serivce port */
1414     char *xmpp_domain;  /**< XMPP login domain */
1415     char *username;     /**< login username */
1416     char *password;     /**< login password */
1417     char *resource;     /**< specific resource for login */
1418     char *user_jid;     /**< specific JID for login */
1419     jid_bound_cb jidbound;  /**< callback when JID bound */
1420 } OCRAInfo_t;
1421 #endif  /* RA_ADAPTER */
1422
1423
1424 /** Enum to describe the type of object held by the OCPayload object.*/
1425 typedef enum
1426 {
1427     /** Contents of the payload are invalid */
1428     PAYLOAD_TYPE_INVALID,
1429     /** The payload is an OCDiscoveryPayload */
1430     PAYLOAD_TYPE_DISCOVERY,
1431     /** The payload of the device */
1432     PAYLOAD_TYPE_DEVICE,
1433     /** The payload type of the platform */
1434     PAYLOAD_TYPE_PLATFORM,
1435     /** The payload is an OCRepPayload */
1436     PAYLOAD_TYPE_REPRESENTATION,
1437     /** The payload is an OCSecurityPayload */
1438     PAYLOAD_TYPE_SECURITY,
1439     /** The payload is an OCPresencePayload */
1440     PAYLOAD_TYPE_PRESENCE,
1441     /** The payload is an OCDiagnosticPayload */
1442     PAYLOAD_TYPE_DIAGNOSTIC,
1443     /** The payload is an OCIntrospectionPayload */
1444     PAYLOAD_TYPE_INTROSPECTION
1445 } OCPayloadType;
1446
1447 /**
1448  * A generic struct representing a payload returned from a resource operation
1449  *
1450  * A pointer to OCPayLoad can be cast to a more specific struct to access members
1451  * for the its type.
1452  */
1453 typedef struct
1454 {
1455     /** The type of message that was received */
1456     OCPayloadType type;
1457 } OCPayload;
1458
1459 typedef enum
1460 {
1461     OCREP_PROP_NULL,
1462     OCREP_PROP_INT,
1463     OCREP_PROP_DOUBLE,
1464     OCREP_PROP_BOOL,
1465     OCREP_PROP_STRING,
1466     OCREP_PROP_BYTE_STRING,
1467     OCREP_PROP_OBJECT,
1468     OCREP_PROP_ARRAY
1469 }OCRepPayloadPropType;
1470
1471 /** This structure will be used to represent a binary string for CBOR payloads.*/
1472 typedef struct
1473 {
1474     /** pointer to data bytes.*/
1475     uint8_t* bytes;
1476
1477     /** number of data bytes.*/
1478     size_t   len;
1479 } OCByteString;
1480
1481 #define MAX_REP_ARRAY_DEPTH 3
1482 typedef struct
1483 {
1484     OCRepPayloadPropType type;
1485     size_t dimensions[MAX_REP_ARRAY_DEPTH];
1486
1487     union
1488     {
1489         int64_t* iArray;
1490         double* dArray;
1491         bool* bArray;
1492         char** strArray;
1493
1494         /** pointer to ByteString array.*/
1495         OCByteString* ocByteStrArray;
1496
1497         struct OCRepPayload** objArray;
1498     };
1499 } OCRepPayloadValueArray;
1500
1501 typedef struct OCRepPayloadValue
1502 {
1503     char* name;
1504     OCRepPayloadPropType type;
1505     union
1506     {
1507         int64_t i;
1508         double d;
1509         bool b;
1510         char* str;
1511
1512         /** ByteString object.*/
1513         OCByteString ocByteStr;
1514
1515         struct OCRepPayload* obj;
1516         OCRepPayloadValueArray arr;
1517     };
1518     struct OCRepPayloadValue* next;
1519
1520 } OCRepPayloadValue;
1521
1522 // used for get/set/put/observe/etc representations
1523 typedef struct OCRepPayload
1524 {
1525     OCPayload base;
1526     char* uri;
1527     OCStringLL* types;
1528     OCStringLL* interfaces;
1529     OCRepPayloadValue* values;
1530     struct OCRepPayload* next;
1531 } OCRepPayload;
1532
1533 // used inside a resource payload
1534 typedef struct OCEndpointPayload
1535 {
1536     char* tps;
1537     char* addr;
1538     OCTransportFlags family;
1539     uint16_t port;
1540     uint16_t pri;
1541     struct OCEndpointPayload* next;
1542 } OCEndpointPayload;
1543
1544 // used inside a discovery payload
1545 typedef struct OCResourcePayload
1546 {
1547     char* uri;
1548     char* rel;
1549     char* anchor;
1550     OCStringLL* types;
1551     OCStringLL* interfaces;
1552     uint8_t bitmap;
1553     bool secure;
1554     uint16_t port;
1555 #ifdef TCP_ADAPTER
1556     uint16_t tcpPort;
1557 #endif
1558     struct OCResourcePayload* next;
1559     OCEndpointPayload* eps;
1560 } OCResourcePayload;
1561
1562 typedef struct OCDiscoveryPayload
1563 {
1564     OCPayload base;
1565
1566     /** Device Id */
1567     char *sid;
1568
1569     /** Name */
1570     char *name;
1571
1572     /** Resource Type */
1573     OCStringLL *type;
1574
1575     /** Interface */
1576     OCStringLL *iface;
1577
1578     /** This structure holds the old /oic/res response. */
1579     OCResourcePayload *resources;
1580
1581     /** Holding address of the next DiscoveryPayload. */
1582     struct OCDiscoveryPayload *next;
1583
1584 } OCDiscoveryPayload;
1585
1586 typedef struct
1587 {
1588     OCPayload base;
1589     uint8_t* securityData;
1590     size_t payloadSize;
1591 } OCSecurityPayload;
1592
1593 #ifdef WITH_PRESENCE
1594 typedef struct
1595 {
1596     OCPayload base;
1597     uint32_t sequenceNumber;
1598     uint32_t maxAge;
1599     OCPresenceTrigger trigger;
1600     char* resourceType;
1601 } OCPresencePayload;
1602 #endif
1603
1604 typedef struct
1605 {
1606     OCPayload base;
1607     char* message;
1608 } OCDiagnosticPayload;
1609
1610 typedef struct
1611 {
1612     OCPayload base;
1613     OCByteString cborPayload;
1614 } OCIntrospectionPayload;
1615
1616 /**
1617  * Incoming requests handled by the server. Requests are passed in as a parameter to the
1618  * OCEntityHandler callback API.
1619  * The OCEntityHandler callback API must be implemented in the application in order
1620  * to receive these requests.
1621  */
1622 typedef struct
1623 {
1624     /** Associated resource.*/
1625     OCResourceHandle resource;
1626
1627     /** Associated request handle.*/
1628     OCRequestHandle requestHandle;
1629
1630     /** the REST method retrieved from received request PDU.*/
1631     OCMethod method;
1632
1633     /** description of endpoint that sent the request.*/
1634     OCDevAddr devAddr;
1635
1636     /** resource query send by client.*/
1637     char * query;
1638
1639     /** Information associated with observation - valid only when OCEntityHandler flag includes
1640      * ::OC_OBSERVE_FLAG.*/
1641     OCObservationInfo obsInfo;
1642
1643     /** Number of the received vendor specific header options.*/
1644     uint8_t numRcvdVendorSpecificHeaderOptions;
1645
1646     /** Pointer to the array of the received vendor specific header options.*/
1647     OCHeaderOption * rcvdVendorSpecificHeaderOptions;
1648
1649     /** Message id.*/
1650     uint16_t messageID;
1651
1652     /** the payload from the request PDU.*/
1653     OCPayload *payload;
1654
1655 } OCEntityHandlerRequest;
1656
1657
1658 /**
1659  * Response from queries to remote servers. Queries are made by calling the OCDoResource API.
1660  */
1661 typedef struct
1662 {
1663     /** Address of remote server.*/
1664     OCDevAddr devAddr;
1665
1666     /** backward compatibility (points to devAddr).*/
1667     OCDevAddr *addr;
1668
1669     /** backward compatibility.*/
1670     OCConnectivityType connType;
1671
1672     /** the security identity of the remote server.*/
1673     OCIdentity identity;
1674
1675     /** the is the result of our stack, OCStackResult should contain coap/other error codes.*/
1676     OCStackResult result;
1677
1678     /** If associated with observe, this will represent the sequence of notifications from server.*/
1679     uint32_t sequenceNumber;
1680
1681     /** resourceURI.*/
1682     const char * resourceUri;
1683
1684     /** the payload for the response PDU.*/
1685     OCPayload *payload;
1686
1687     /** Number of the received vendor specific header options.*/
1688     uint8_t numRcvdVendorSpecificHeaderOptions;
1689
1690     /** An array of the received vendor specific header options.*/
1691     OCHeaderOption rcvdVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1692 } OCClientResponse;
1693
1694 /**
1695  * Request handle is passed to server via the entity handler for each incoming request.
1696  * Stack assigns when request is received, server sets to indicate what request response is for.
1697  */
1698 typedef struct
1699 {
1700     /** Request handle.*/
1701     OCRequestHandle requestHandle;
1702
1703     /** Resource handle. (@deprecated: This parameter is not used.) */
1704     OCResourceHandle resourceHandle;
1705
1706     /** Allow the entity handler to pass a result with the response.*/
1707     OCEntityHandlerResult  ehResult;
1708
1709     /** This is the pointer to server payload data to be transferred.*/
1710     OCPayload* payload;
1711
1712     /** number of the vendor specific header options .*/
1713     uint8_t numSendVendorSpecificHeaderOptions;
1714
1715     /** An array of the vendor specific header options the entity handler wishes to use in response.*/
1716     OCHeaderOption sendVendorSpecificHeaderOptions[MAX_HEADER_OPTIONS];
1717
1718     /** Resource path of new resource that entity handler might create.*/
1719     char resourceUri[MAX_URI_LENGTH];
1720
1721     /** Server sets to true for persistent response buffer,false for non-persistent response buffer*/
1722     uint8_t persistentBufferFlag;
1723 } OCEntityHandlerResponse;
1724
1725 /**
1726  * Entity's state
1727  */
1728 typedef enum
1729 {
1730     /** Request state.*/
1731     OC_REQUEST_FLAG = (1 << 1),
1732     /** Observe state.*/
1733     OC_OBSERVE_FLAG = (1 << 2)
1734 } OCEntityHandlerFlag;
1735
1736 /**
1737  * Possible return values from client application callback
1738  *
1739  * A client application callback returns an OCStackApplicationResult to indicate whether
1740  * the stack should continue to keep the callback registered.
1741  */
1742 typedef enum
1743 {
1744     /** Make no more calls to the callback and call the OCClientContextDeleter for this callback */
1745     OC_STACK_DELETE_TRANSACTION = 0,
1746     /** Keep this callback registered and call it if an apropriate event occurs */
1747     OC_STACK_KEEP_TRANSACTION
1748 } OCStackApplicationResult;
1749
1750
1751 //#ifdef DIRECT_PAIRING
1752 /**
1753  * @brief   direct pairing Method Type.
1754  *              0:  not allowed
1755  *              1:  pre-configured pin
1756  *              2:  random pin
1757  */
1758 typedef enum OCPrm
1759 {
1760     DP_NOT_ALLOWED             = 0x0,
1761     DP_PRE_CONFIGURED        = (0x1 << 0),
1762     DP_RANDOM_PIN               = (0x1 << 1),
1763 } OCPrm_t;
1764
1765 /**
1766  * Device Information of discoverd direct pairing device(s).
1767  */
1768 typedef struct OCDPDev
1769 {
1770     OCDevAddr               endpoint;
1771     OCConnectivityType   connType;
1772     uint16_t                     securePort;
1773     bool                  edp;
1774     OCPrm_t           *prm;
1775     size_t                prmLen;
1776     OCUUIdentity     deviceID;
1777     OCUUIdentity     rowner;
1778     struct OCDPDev *next;
1779 } OCDPDev_t;
1780 //#endif // DIRECT_PAIRING
1781
1782 /*
1783  * -------------------------------------------------------------------------------------------
1784  * Callback function definitions
1785  * -------------------------------------------------------------------------------------------
1786  */
1787
1788 /**
1789  * Client applications implement this callback to consume responses received from Servers.
1790  */
1791 typedef OCStackApplicationResult (* OCClientResponseHandler)(void *context, OCDoHandle handle,
1792     OCClientResponse * clientResponse);
1793
1794 /**
1795  * Client applications using a context pointer implement this callback to delete the
1796  * context upon removal of the callback/context pointer from the internal callback-list.
1797  */
1798 typedef void (* OCClientContextDeleter)(void *context);
1799
1800 /**
1801  * This info is passed from application to OC Stack when initiating a request to Server.
1802  */
1803 typedef struct OCCallbackData
1804 {
1805     /** Pointer to the context.*/
1806     void *context;
1807
1808     /** The pointer to a function the stack will call to handle the requests.*/
1809     OCClientResponseHandler cb;
1810
1811     /** A pointer to a function to delete the context when this callback is removed.*/
1812     OCClientContextDeleter cd;
1813
1814 #ifdef __cplusplus
1815     OCCallbackData() = default;
1816     OCCallbackData(void* ctx, OCClientResponseHandler callback, OCClientContextDeleter deleter)
1817         :context(ctx), cb(callback), cd(deleter){}
1818 #endif // __cplusplus
1819 } OCCallbackData;
1820
1821 /**
1822  * Application server implementations must implement this callback to consume requests OTA.
1823  * Entity handler callback needs to fill the resPayload of the entityHandlerRequest.
1824  *
1825  * When you set specific return value like OC_EH_CHANGED, OC_EH_CONTENT,
1826  * OC_EH_SLOW and etc in entity handler callback,
1827  * ocstack will be not send response automatically to client
1828  * except for error return value like OC_EH_ERROR.
1829  *
1830  * If you want to send response to client with specific result,
1831  * OCDoResponse API should be called with the result value.
1832  *
1833  * e.g)
1834  *
1835  * OCEntityHandlerResponse response;
1836  *
1837  * ..
1838  *
1839  * response.ehResult = OC_EH_CHANGED;
1840  *
1841  * ..
1842  *
1843  * OCDoResponse(&response)
1844  *
1845  * ..
1846  *
1847  * return OC_EH_OK;
1848  */
1849 typedef OCEntityHandlerResult (*OCEntityHandler)
1850 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, void* callbackParam);
1851
1852 /**
1853  * Device Entity handler need to use this call back instead of OCEntityHandler.
1854  *
1855  * When you set specific return value like OC_EH_CHANGED, OC_EH_CONTENT,
1856  * OC_EH_SLOW and etc in entity handler callback,
1857  * ocstack will be not send response automatically to client
1858  * except for error return value like OC_EH_ERROR.
1859  *
1860  * If you want to send response to client with specific result,
1861  * OCDoResponse API should be called with the result value.
1862  *
1863  * e.g)
1864  *
1865  * OCEntityHandlerResponse response;
1866  *
1867  * ..
1868  *
1869  * response.ehResult = OC_EH_CHANGED;
1870  *
1871  * ..
1872  *
1873  * OCDoResponse(&response)
1874  *
1875  * ..
1876  *
1877  * return OC_EH_OK;
1878  */
1879 typedef OCEntityHandlerResult (*OCDeviceEntityHandler)
1880 (OCEntityHandlerFlag flag, OCEntityHandlerRequest * entityHandlerRequest, char* uri, void* callbackParam);
1881
1882 #if defined(__WITH_DTLS__) || defined(__WITH_TLS__)
1883 /**
1884  * Callback function definition for Change in TrustCertChain
1885  *
1886  * @param[IN] ctx - user context returned in the callback.
1887  * @param[IN] credId - trustCertChain changed for this ID
1888  * @param[IN] trustCertChain - trustcertchain binary blob.
1889  * @param[IN] chainSize - size of trustchain
1890  */
1891 typedef void (*TrustCertChainChangeCB)(void *ctx, uint16_t credId, uint8_t *trustCertChain,
1892         size_t chainSize);
1893
1894 /**
1895  * certChain context structure.
1896  */
1897 typedef struct trustCertChainContext
1898 {
1899     TrustCertChainChangeCB callback;
1900     void *context;
1901 } trustCertChainContext_t;
1902 #endif
1903
1904 #if defined(TCP_ADAPTER) && defined(WITH_CLOUD)
1905 /**
1906  * User Preference of connectivity channel
1907  */
1908 typedef enum
1909 {
1910     /** Cloud TCP */
1911     OC_USER_PREF_CLOUD = 0,
1912     /** local UDP */
1913     OC_USER_PREF_LOCAL_UDP = 1,
1914     /** local TCP */
1915     OC_USER_PREF_LOCAL_TCP =2
1916 } OCConnectUserPref_t;
1917
1918 #endif
1919
1920 #ifdef __cplusplus
1921 }
1922 #endif // __cplusplus
1923
1924 #endif /* OCTYPES_H_ */