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