RD client features in base layer
[platform/upstream/iotivity.git] / resource / csdk / stack / include / ocstack.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 APIs for OIC Stack to be implemented.
26  */
27
28 #ifndef OCSTACK_H_
29 #define OCSTACK_H_
30
31 #include <stdio.h>
32 #include <stdint.h>
33 #include "octypes.h"
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif // __cplusplus
38
39 /** Macro to use Random port.*/
40 #define USE_RANDOM_PORT (0)
41
42 /*
43  * Function prototypes
44  */
45
46 /**
47  * This function Initializes the OC Stack.  Must be called prior to starting the stack.
48  *
49  * @param mode            OCMode Host device is client, server, or client-server.
50  * @param serverFlags     OCTransportFlags Default server transport flags.
51  * @param clientFlags     OCTransportFlags Default client transport flags.
52  *
53  * @return ::OC_STACK_OK on success, some other value upon failure.
54  */
55 OC_EXPORT OCStackResult OCInit1(OCMode mode, OCTransportFlags serverFlags, OCTransportFlags clientFlags);
56
57 /**
58  * This function Initializes the OC Stack.  Must be called prior to starting the stack.
59  *
60  * @param ipAddr      IP Address of host device. Deprecated parameter.
61  * @param port        Port of host device. Deprecated parameter.
62  * @param mode        OCMode Host device is client, server, or client-server.
63  *
64  * @return ::OC_STACK_OK on success, some other value upon failure.
65  */
66 OC_EXPORT OCStackResult OCInit(const char *ipAddr, uint16_t port, OCMode mode);
67
68 #ifdef RA_ADAPTER
69 /**
70  * @brief   Set Remote Access information for XMPP Client.
71  * @param   raInfo            [IN] remote access info.
72  *
73  * @return  ::OC_STACK_OK on success, some other value upon failure.
74  */
75 OCStackResult OCSetRAInfo(const OCRAInfo_t *raInfo);
76 #endif
77
78 /**
79  * This function Stops the OC stack.  Use for a controlled shutdown.
80  *
81  * @note: OCStop() performs operations similar to OCStopPresence(), as well as OCDeleteResource() on
82  * all resources this server is hosting. OCDeleteResource() performs operations similar to
83  * OCNotifyAllObservers() to notify all client observers that the respective resource is being
84  * deleted.
85  *
86  * @return ::OC_STACK_OK on success, some other value upon failure.
87  */
88 OC_EXPORT OCStackResult OCStop();
89
90 /**
91  * This function starts receiving the multicast traffic. This can be only called
92  * when stack is in OC_STACK_INITIALIZED state but device is not receiving multicast
93  * traffic.
94  *
95  * @return ::OC_STACK_OK on success, some other value upon failure.
96  */
97 OCStackResult OCStartMulticastServer();
98
99 /**
100  * This function stops receiving the multicast traffic. The rest of the stack
101  * keeps working and no resource are deleted. Device can still receive the unicast
102  * traffic. Once this is set, no response to multicast /oic/res will be sent by the
103  * device. This is to be used for devices that uses other entity to push resources.
104  *
105  * @return ::OC_STACK_OK on success, some other value upon failure.
106  */
107 OCStackResult OCStopMulticastServer();
108
109 /**
110  * This function is Called in main loop of OC client or server.
111  * Allows low-level processing of stack services.
112  *
113  * @return ::OC_STACK_OK on success, some other value upon failure.
114  */
115 OC_EXPORT OCStackResult OCProcess();
116
117 /**
118  * This function discovers or Perform requests on a specified resource
119  * (specified by that Resource's respective URI).
120  *
121  * @param handle            To refer to the request sent out on behalf of
122  *                          calling this API. This handle can be used to cancel this operation
123  *                          via the OCCancel API.
124  *                          @note: This reference is handled internally, and should not be free'd by
125  *                          the consumer.  A NULL handle is permitted in the event where the caller
126  *                          has no use for the return value.
127  * @param method            To perform on the resource.
128  * @param requestUri       URI of the resource to interact with. (Address prefix is deprecated in
129  *                          favor of destination.)
130  * @param destination       Complete description of destination.
131  * @param payload           Encoded request payload.
132  * @param connectivityType  Modifier flags when destination is not given.
133  * @param qos               Quality of service. Note that if this API is called on a uri with the
134  *                          well-known multicast IP address, the qos will be forced to ::OC_LOW_QOS
135  *                          since it is impractical to send other QOS levels on such addresses.
136  * @param cbData            Asynchronous callback function that is invoked by the stack when
137  *                          discovery or resource interaction is received. The discovery could be
138  *                          related to filtered/scoped/particular resource. The callback is
139  *                          generated for each response received.
140  * @param options           The address of an array containing the vendor specific header options
141  *                          to be sent with the request.
142  * @param numOptions        Number of header options to be included.
143  *
144  * @note: Presence subscription amendments (i.e. adding additional resource type filters by calling
145  * this API again) require the use of the same base URI as the original request to successfully
146  * amend the presence filters.
147  *
148  * @return ::OC_STACK_OK on success, some other value upon failure.
149  */
150 OC_EXPORT OCStackResult OCDoResource(OCDoHandle *handle,
151                                      OCMethod method,
152                                      const char *requestUri,
153                                      const OCDevAddr *destination,
154                                      OCPayload* payload,
155                                      OCConnectivityType connectivityType,
156                                      OCQualityOfService qos,
157                                      OCCallbackData *cbData,
158                                      OCHeaderOption *options,
159                                      uint8_t numOptions);
160 /**
161  * This function cancels a request associated with a specific @ref OCDoResource invocation.
162  *
163  * @param handle       Used to identify a specific OCDoResource invocation.
164  * @param qos          Used to specify Quality of Service(read below).
165  * @param options      Used to specify vendor specific header options when sending
166  *                     explicit observe cancellation.
167  * @param numOptions   Number of header options to be included.
168  *
169  * @return ::OC_STACK_OK on success, some other value upon failure.
170  */
171 OC_EXPORT OCStackResult OCCancel(OCDoHandle handle,
172                                  OCQualityOfService qos,
173                                  OCHeaderOption * options,
174                                  uint8_t numOptions);
175
176 /**
177  * Register Persistent storage callback.
178  * @param   persistentStorageHandler  Pointers to open, read, write, close & unlink handlers.
179  *
180  * @return
181  *     OC_STACK_OK                    No errors; Success.
182  *     OC_STACK_INVALID_PARAM         Invalid parameter.
183  */
184 OC_EXPORT OCStackResult OCRegisterPersistentStorageHandler(OCPersistentStorage* persistentStorageHandler);
185
186 #ifdef WITH_PRESENCE
187 /**
188  * When operating in  OCServer or  OCClientServer mode,
189  * this API will start sending out presence notifications to clients via multicast.
190  * Once this API has been called with a success, clients may query for this server's presence and
191  * this server's stack will respond via multicast.
192  *
193  * Server can call this function when it comes online for the first time, or when it comes back
194  * online from offline mode, or when it re enters network.
195  *
196  * @param ttl         Time To Live in seconds.
197  *                    @note: If ttl is '0', then the default stack value will be used (60 Seconds).
198  *                    If ttl is greater than ::OC_MAX_PRESENCE_TTL_SECONDS, then the ttl will be
199  *                    set to ::OC_MAX_PRESENCE_TTL_SECONDS.
200  *
201  * @return ::OC_STACK_OK on success, some other value upon failure.
202  */
203 OC_EXPORT OCStackResult OCStartPresence(const uint32_t ttl);
204
205 /**
206  * When operating in OCServer or OCClientServer mode, this API will stop sending
207  * out presence notifications to clients via multicast.
208  * Once this API has been called with a success this server's stack will not respond to clients
209  * querying for this server's presence.
210  *
211  * Server can call this function when it is terminating, going offline, or when going
212  * away from network.
213  *
214  * @return ::OC_STACK_OK on success, some other value upon failure.
215  */
216
217 OC_EXPORT OCStackResult OCStopPresence();
218 #endif
219
220
221 /**
222  * This function sets default device entity handler.
223  *
224  * @param entityHandler      Entity handler function that is called by ocstack to handle requests
225  *                           for any undefined resources or default actions.If NULL is passed it
226  *                           removes the device default entity handler.
227  * @param callbackParameter  Parameter passed back when entityHandler is called.
228  *
229  * @return ::OC_STACK_OK on success, some other value upon failure.
230  */
231 OC_EXPORT OCStackResult OCSetDefaultDeviceEntityHandler(OCDeviceEntityHandler entityHandler, void* callbackParameter);
232
233 /**
234  * This function sets device information.
235  *
236  * Upon call to OCInit, the default Device Type (i.e. "rt") has already been set to the default
237  * Device Type "oic.wk.d". You do not have to specify "oic.wk.d" in the OCDeviceInfo.types linked
238  * list. The default Device Type is mandatory and always specified by this Device as the first
239  * Device Type.
240  *
241  * @param deviceInfo   Structure passed by the server application containing the device
242  *                     information.
243  *
244  * @return
245  *     ::OC_STACK_OK               no errors.
246  *     ::OC_STACK_INVALID_PARAM    invalid parameter.
247  *     ::OC_STACK_ERROR            stack process error.
248  */
249 OC_EXPORT OCStackResult OCSetDeviceInfo(OCDeviceInfo deviceInfo);
250
251 /**
252  * This function sets platform information.
253  *
254  * @param platformInfo   Structure passed by the server application containing
255  *                       the platform information.
256  *
257  *
258  * @return
259  *     ::OC_STACK_OK               no errors.
260  *     ::OC_STACK_INVALID_PARAM    invalid parameter.
261  *     ::OC_STACK_ERROR            stack process error.
262  */
263 OC_EXPORT OCStackResult OCSetPlatformInfo(OCPlatformInfo platformInfo);
264
265 /**
266  * This function creates a resource.
267  *
268  * @param handle                Pointer to handle to newly created resource. Set by ocstack and
269  *                              used to refer to resource.
270  * @param resourceTypeName      Name of resource type.  Example: "core.led".
271  * @param resourceInterfaceName Name of resource interface.  Example: "core.rw".
272  * @param uri                   URI of the resource.  Example:  "/a/led".
273  * @param entityHandler         Entity handler function that is called by ocstack to handle
274  *                              requests, etc.
275  *                              NULL for default entity handler.
276  * @param callbackParam     parameter passed back when entityHandler is called.
277  * @param resourceProperties    Properties supported by resource.
278  *                              Example: ::OC_DISCOVERABLE|::OC_OBSERVABLE.
279  *
280  * @return ::OC_STACK_OK on success, some other value upon failure.
281  */
282 OC_EXPORT OCStackResult OCCreateResource(OCResourceHandle *handle,
283                                          const char *resourceTypeName,
284                                          const char *resourceInterfaceName,
285                                          const char *uri,
286                                          OCEntityHandler entityHandler,
287                                          void* callbackParam,
288                                          uint8_t resourceProperties);
289
290
291 /**
292  * This function adds a resource to a collection resource.
293  *
294  * @param collectionHandle    Handle to the collection resource.
295  * @param resourceHandle      Handle to resource to be added to the collection resource.
296  *
297  * @return ::OC_STACK_OK on success, some other value upon failure.
298  */
299 OC_EXPORT OCStackResult OCBindResource(OCResourceHandle collectionHandle, OCResourceHandle resourceHandle);
300
301 /**
302  * This function removes a resource from a collection resource.
303  *
304  * @param collectionHandle   Handle to the collection resource.
305  * @param resourceHandle     Handle to resource to be removed from the collection resource.
306  *
307  * @return ::OC_STACK_OK on success, some other value upon failure.
308  */
309 OC_EXPORT OCStackResult OCUnBindResource(OCResourceHandle collectionHandle, OCResourceHandle resourceHandle);
310
311 /**
312  * This function binds a resource type to a resource.
313  *
314  * @param handle            Handle to the resource.
315  * @param resourceTypeName  Name of resource type.  Example: "core.led".
316  *
317  * @return ::OC_STACK_OK on success, some other value upon failure.
318  */
319 OC_EXPORT OCStackResult OCBindResourceTypeToResource(OCResourceHandle handle,
320                                                      const char *resourceTypeName);
321 /**
322  * This function binds a resource interface to a resource.
323  *
324  * @param handle                  Handle to the resource.
325  * @param resourceInterfaceName   Name of resource interface.  Example: "core.rw".
326  *
327  * @return ::OC_STACK_OK on success, some other value upon failure.
328  */
329 OC_EXPORT OCStackResult OCBindResourceInterfaceToResource(OCResourceHandle handle,
330                                                           const char *resourceInterfaceName);
331
332 /**
333  * This function binds an entity handler to the resource.
334  *
335  * @param handle            Handle to the resource that the contained resource is to be bound.
336  * @param entityHandler     Entity handler function that is called by ocstack to handle requests.
337  * @param callbackParameter Context parameter that will be passed to entityHandler.
338  *
339  * @return ::OC_STACK_OK on success, some other value upon failure.
340  */
341 OC_EXPORT OCStackResult OCBindResourceHandler(OCResourceHandle handle,
342                                               OCEntityHandler entityHandler,
343                                               void *callbackParameter);
344
345 /**
346  * This function gets the number of resources that have been created in the stack.
347  *
348  * @param numResources    Pointer to count variable.
349  *
350  * @return ::OC_STACK_OK on success, some other value upon failure.
351  */
352 OC_EXPORT OCStackResult OCGetNumberOfResources(uint8_t *numResources);
353
354 /**
355  * This function gets a resource handle by index.
356  *
357  * @param index   Index of resource, 0 to Count - 1.
358  *
359  * @return Found  resource handle or NULL if not found.
360  */
361 OC_EXPORT OCResourceHandle OCGetResourceHandle(uint8_t index);
362
363 /**
364  * This function deletes resource specified by handle.  Deletes resource and all
365  * resource type and resource interface linked lists.
366  *
367  * @note: OCDeleteResource() performs operations similar to OCNotifyAllObservers() to notify all
368  * client observers that "this" resource is being deleted.
369  *
370  * @param handle          Handle of resource to be deleted.
371  *
372  * @return ::OC_STACK_OK on success, some other value upon failure.
373  */
374 OC_EXPORT OCStackResult OCDeleteResource(OCResourceHandle handle);
375
376 /**
377  * Get a string representation the server instance ID.
378  * The memory is managed internal to this function, so freeing externally will result
379  * in a runtime error.
380  * Note: This will NOT seed the RNG, so it must be called after the RNG is seeded.
381  * This is done automatically during the OCInit process,
382  * so ensure that this call is done after that.
383  *
384  * @return A string representation  the server instance ID.
385  */
386 OC_EXPORT const char* OCGetServerInstanceIDString(void);
387
388 /**
389  * This function gets the URI of the resource specified by handle.
390  *
391  * @param handle     Handle of resource.
392  *
393  * @return URI string if resource found or NULL if not found.
394  */
395 OC_EXPORT const char *OCGetResourceUri(OCResourceHandle handle);
396
397 /**
398  * This function gets the properties of the resource specified by handle.
399  *
400  * @param handle                Handle of resource.
401  *
402  * @return OCResourceProperty   Bitmask or -1 if resource is not found.
403  *
404  * @note that after a resource is created, the OC_ACTIVE property is set for the resource by the
405  * stack.
406  */
407 OC_EXPORT OCResourceProperty OCGetResourceProperties(OCResourceHandle handle);
408
409 /**
410  * This function gets the number of resource types of the resource.
411  *
412  * @param handle            Handle of resource.
413  * @param numResourceTypes  Pointer to count variable.
414  *
415  * @return ::OC_STACK_OK on success, some other value upon failure.
416  */
417 OC_EXPORT OCStackResult OCGetNumberOfResourceTypes(OCResourceHandle handle, uint8_t *numResourceTypes);
418
419 /**
420  * This function gets name of resource type of the resource.
421  *
422  * @param handle       Handle of resource.
423  * @param index        Index of resource, 0 to Count - 1.
424  *
425  * @return Resource type name if resource found or NULL if resource not found.
426  */
427 OC_EXPORT const char *OCGetResourceTypeName(OCResourceHandle handle, uint8_t index);
428
429 /**
430  * This function gets the number of resource interfaces of the resource.
431  *
432  * @param handle                 Handle of resource.
433  * @param numResourceInterfaces  Pointer to count variable.
434  *
435  * @return ::OC_STACK_OK on success, some other value upon failure.
436  */
437 OC_EXPORT OCStackResult OCGetNumberOfResourceInterfaces(OCResourceHandle handle,
438         uint8_t *numResourceInterfaces);
439
440 /**
441  * This function gets name of resource interface of the resource.
442  *
443  * @param handle      Handle of resource.
444  * @param index       Index of resource, 0 to Count - 1.
445  *
446  * @return Resource interface name if resource found or NULL if resource not found.
447  */
448 OC_EXPORT const char *OCGetResourceInterfaceName(OCResourceHandle handle, uint8_t index);
449
450 /**
451  * This function gets methods of resource interface of the resource.
452  *
453  * @param handle      Handle of resource.
454  * @param index       Index of resource, 0 to Count - 1.
455  *
456  * @return Allowed methods if resource found or NULL if resource not found.
457  */
458 OC_EXPORT uint8_t OCGetResourceInterfaceAllowedMethods(OCResourceHandle handle, uint8_t index);
459
460 /**
461  * This function gets resource handle from the collection resource by index.
462  *
463  * @param collectionHandle   Handle of collection resource.
464  * @param index              Index of contained resource, 0 to Count - 1.
465  *
466  * @return Handle to contained resource if resource found or NULL if resource not found.
467  */
468 OC_EXPORT OCResourceHandle OCGetResourceHandleFromCollection(OCResourceHandle collectionHandle,
469         uint8_t index);
470
471 /**
472  * This function gets the entity handler for a resource.
473  *
474  * @param handle            Handle of resource.
475  *
476  * @return Entity handler if resource found or NULL resource not found.
477  */
478 OC_EXPORT OCEntityHandler OCGetResourceHandler(OCResourceHandle handle);
479
480 /**
481  * This function notify all registered observers that the resource representation has
482  * changed. If observation includes a query the client is notified only if the query is valid after
483  * the resource representation has changed.
484  *
485  * @param handle   Handle of resource.
486  * @param qos      Desired quality of service for the observation notifications.
487  *
488  * @return ::OC_STACK_OK on success, some other value upon failure.
489  */
490 OC_EXPORT OCStackResult OCNotifyAllObservers(OCResourceHandle handle, OCQualityOfService qos);
491
492 /**
493  * Notify specific observers with updated value of representation.
494  * Before this API is invoked by entity handler it has finished processing
495  * queries for the associated observers.
496  *
497  * @param handle                    Handle of resource.
498  * @param obsIdList                 List of observation IDs that need to be notified.
499  * @param numberOfIds               Number of observation IDs included in obsIdList.
500  * @param payload                   Object representing the notification
501  * @param qos                       Desired quality of service of the observation notifications.
502  *
503  * @note: The memory for obsIdList and payload is managed by the entity invoking the API.
504  * The maximum size of the notification is 1015 bytes for non-Arduino platforms. For Arduino
505  * the maximum size is 247 bytes.
506  *
507  * @return ::OC_STACK_OK on success, some other value upon failure.
508  */
509 OC_EXPORT OCStackResult
510 OCNotifyListOfObservers (OCResourceHandle handle,
511                             OCObservationId  *obsIdList,
512                             uint8_t          numberOfIds,
513                             const OCRepPayload *payload,
514                             OCQualityOfService qos);
515
516
517 /**
518  * This function sends a response to a request.
519  * The response can be a normal, slow, or block (i.e. a response that
520  * is too large to be sent in a single PDU and must span multiple transmissions).
521  *
522  * @param response   Pointer to structure that contains response parameters.
523  *
524  * @return ::OC_STACK_OK on success, some other value upon failure.
525  */
526 OC_EXPORT OCStackResult OCDoResponse(OCEntityHandlerResponse *response);
527
528 //#ifdef DIRECT_PAIRING
529 /**
530  * The function is responsible for discovery of direct-pairing device is current subnet. It will list
531  * all the device in subnet which support direct-pairing.
532  * Caller must NOT free returned constant pointer
533  *
534  * @param[in] timeout Timeout in seconds, value till which function will listen to responses from
535  *                    client before returning the list of devices.
536  * @return OCDirectPairingDev_t pointer in case of success and NULL otherwise.
537  */
538 OC_EXPORT const OCDPDev_t* OCDiscoverDirectPairingDevices(unsigned short waittime);
539
540 /**
541  * The function is responsible for return of paired device list via direct-pairing. It will list
542  * all the device which is previousely paired with client.
543  * Caller must NOT free returned constant pointer
544  *
545  * @return OCDirectPairingDev_t pointer in case of success and NULL otherwise.
546  */
547 OC_EXPORT const OCDPDev_t* OCGetDirectPairedDevices();
548
549 /**
550  * The function is responsible for establishment of direct-pairing. It will proceed mode negotiation
551  * and connect PIN based dtls session.
552  *
553  * @param[in] peer Target device to establish direct-pairing.
554  * @param[in] pmSel Selected mode of pairing.
555  * @param[in] pinNumber PIN number for authentication, pin lenght is defined DP_PIN_LENGTH(8).
556  * @param[in] resultCallback Callback fucntion to event status of process.
557  * @return OTM_SUCCESS in case of success and other value otherwise.
558  */
559 OC_EXPORT OCStackResult OCDoDirectPairing(void *ctx, OCDPDev_t* peer, OCPrm_t pmSel, char *pinNumber,
560                                                      OCDirectPairingCB resultCallback);
561
562 #if defined(RD_CLIENT) || defined(RD_SERVER)
563 /**
564  * This function binds an resource unique id to the resource.
565  *
566  * @param handle            Handle to the resource that the contained resource is to be bound.
567  * @param ins               Unique ID for resource.
568  *
569  * @return ::OC_STACK_OK on success, some other value upon failure.
570  */
571 OC_EXPORT OCStackResult OCBindResourceInsToResource(OCResourceHandle handle, uint8_t ins);
572
573 /**
574  * This function gets the resource unique id for a resource.
575  *
576  * @param handle            Handle of resource.
577  * @param ins               Unique ID for resource.
578  *
579  * @return Ins if resource found or 0 resource not found.
580  */
581 OC_EXPORT OCStackResult OCGetResourceIns(OCResourceHandle handle, uint8_t *ins);
582
583 /**
584  * This function gets a resource handle by resource uri.
585  *
586  * @param uri   Uri of Resource to get Resource handle.
587  *
588  * @return Found  resource handle or NULL if not found.
589  */
590 OC_EXPORT OCResourceHandle OCGetResourceHandleAtUri(const char *uri);
591 #endif
592 //#endif // DIRECT_PAIRING
593
594 #ifdef __cplusplus
595 }
596 #endif // __cplusplus
597
598 #endif /* OCSTACK_H_ */