1 /* *****************************************************************
3 * Copyright 2015 Samsung Electronics All Rights Reserved.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
19 * *****************************************************************/
21 #ifndef _PM_UTILITY_H_
22 #define _PM_UTILITY_H_
33 #define DEFAULT_SECURE_PORT 5684
35 #define COAPS_PREFIX "coaps://"
36 #define COAP_PREFIX "coap://"
37 #define COAPS_QUERY "coaps://%s:%d%s"
38 #define COAP_QUERY "coap://%s:%d%s"
41 * Discover owned/unowned devices in the same IP subnet. .
43 * @param[in] waittime Timeout in seconds.
44 * @param[in] isOwned bool flag for owned / unowned discovery
45 * @param[in] ppList List of OCProvisionDev_t.
47 * @return OC_STACK_OK on success otherwise error.
49 OCStackResult PMDeviceDiscovery(unsigned short waittime, bool isOwned, OCProvisionDev_t **ppList);
52 * This function deletes list of provision target devices
54 * @param[in] pList List of OCProvisionDev_t.
56 void PMDeleteDeviceList(OCProvisionDev_t *pList);
59 * Timeout implementation for secure discovery. When performing secure discovery,
60 * we should wait a certain period of time for getting response of each devices.
62 * @param[in] waittime Timeout in seconds.
63 * @param[in] waitForStackResponse if true timeout function will call OCProcess while waiting.
64 * @return OC_STACK_OK on success otherwise error.
66 OCStackResult PMTimeout(unsigned short waittime, bool waitForStackResponse);
69 * Function to clone OCProvisionDev_t
71 * @param[in] src pointer of OCProvisionDev_t to be copied.
73 * @return copied OCProvisionDev_t on success otherwise NULL.
75 OCProvisionDev_t* PMCloneOCProvisionDev(const OCProvisionDev_t* src);
79 * Function to generate qurey for coap/coaps request.
81 * @param[in] isSeucre Choose whether to encrypt the payload.
82 * @param[in] address Network address of remote device
83 * @param[in] port Port number
84 * @param[in] connType Connectivity type of remote device
85 * @param[in,out] buffer A buffer to save the query.
86 * @param[in] bufferSize Size of buffer
87 * @param[in] uri The resource URI
89 * @return true on success
91 bool PMGenerateQuery(bool isSecure,
92 const char* address, uint16_t port,
93 OCConnectivityType connType,
94 char* buffer, size_t bufferSize, const char* uri);
97 * Function to print OCProvisionDev_t for debug purpose.
99 * @param[in] pDev Pointer to OCProvisionDev_t. It's information will be printed by OC_LOG_XX
102 void PMPrintOCProvisionDev(const OCProvisionDev_t* pDev);
104 /** Function to delete matched UUID from the UUIDlist.
106 * @param[in] pUuidList a pointer to UUID list.
107 * @param[in] targetId a pointer to UUID to be deleted in the list.
109 * @return true when deletion is happened, false when no deletion is occured. In case either of
110 * two arguments is null it will return false.
112 bool PMDeleteFromUUIDList(OCUuidList_t *pUuidList, OicUuid_t *targetId);
117 #endif //_PM_UTILITY_H_