-/******************************************************************
+/* ****************************************************************
*
* Copyright 2014 Samsung Electronics All Rights Reserved.
*
******************************************************************/
/**
- * @file cainterface.h
- * @brief This file contains the APIs for Resource Model to use
+ * @file
+ *
+ * This file contains the APIs for Resource Model to use.
*/
-#ifndef __CA_INTERFACE_H_
-#define __CA_INTERFACE_H_
+#ifndef CA_INTERFACE_H_
+#define CA_INTERFACE_H_
/**
- * Connectivity Abstraction Interface Description APIs.
+ * Connectivity Abstraction Interface APIs.
*/
#include "cacommon.h"
+#ifdef __WITH_DTLS__
+#include "ocsecurityconfig.h"
+#endif
+
#ifdef __cplusplus
extern "C"
{
/**
* @brief Callback function type for request delivery.
- * requestInfo contains different parameters for resource model to understand about the request.
- * @param object [OUT] Endpoint object from which the request is received. It contains endpoint
- * address based on the connectivity type.
- * @param requestInfo [OUT] Identifier which needs to be sent with request.
+ * @param object [OUT] Endpoint object from which the request is received. It contains
+ * endpoint address based on the connectivity type.
+ * @param requestInfo [OUT] Info for resource model to understand about the request.
+ * @return NONE
*/
-typedef void (*CARequestCallback)(CARemoteEndpoint_t* object, CARequestInfo_t* requestInfo);
+typedef void (*CARequestCallback)(const CARemoteEndpoint_t *object,
+ const CARequestInfo_t *requestInfo);
/**
* @brief Callback function type for response delivery.
- * responseInfor contains different parameters for resource model to understand about the request.
- * @param object [OUT] Endpoint object from which the response is received.
- * @param responseInfo [OUT] Identifier which needs to be mapped with response.
+ * @param object [OUT] Endpoint object from which the response is received.
+ * @param responseInfo [OUT] Identifier which needs to be mapped with response.
+ * @return NONE
+ */
+typedef void (*CAResponseCallback)(const CARemoteEndpoint_t *object,
+ const CAResponseInfo_t *responseInfo);
+
+#ifdef __WITH_DTLS__
+
+/**
+ * Binary blob containing device identity and the credentials for all devices
+ * trusted by this device.
*/
-typedef void (*CAResponseCallback)(CARemoteEndpoint_t* object, CAResponseInfo_t* responseInfo);
+typedef struct
+{
+ unsigned char identity[DTLS_PSK_ID_LEN]; /** identity of self */
+ uint32_t num; /** number of credentials in this blob */
+ OCDtlsPskCreds *creds; /** list of credentials. Size of this
+ array is determined by 'num' variable. */
+} CADtlsPskCredsBlob_t;
+
+/**
+ * @brief Callback function type for getting DTLS credentials.
+ * @param credInfo [OUT] DTLS credentials info. Handler has to allocate new memory for
+ * both credInfo and credInfo->creds which is then freed by CA
+ * @return NONE
+ */
+typedef void (*CAGetDTLSCredentialsHandler)(CADtlsPskCredsBlob_t **credInfo);
+#endif //__WITH_DTLS__
/**
* @brief Initialize the connectivity abstraction module.
- * It will initialize adapters, thread pool and other modules based on the platform compilation options.
+ * It will initialize adapters, thread pool and other modules based on the platform
+ * compilation options.
*
- * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * @return #CA_STATUS_OK or #CA_STATUS_FAILED or #CA_MEMORY_ALLOC_FAILED
*/
CAResult_t CAInitialize();
/**
* @brief Terminate the connectivity abstraction module.
* All threads, data structures are destroyed for next initializations.
+ * @return NONE
*/
void CATerminate();
/**
* @brief Starts listening servers.
* This API is used by resource hosting server for listening multicast requests.
- * based on the adapters configurations , different kinds of servers are started.
- * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * Based on the adapters configurations, different kinds of servers are started.
+ * @return #CA_STATUS_OK or #CA_STATUS_FAILED
*/
CAResult_t CAStartListeningServer();
/**
* @brief Starts discovery servers.
* This API is used by resource required clients for listening multicast requests.
- * based on the adapters configurations , different kinds of servers are started.
- * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * Based on the adapters configurations, different kinds of servers are started.
+ * @return #CA_STATUS_OK or #CA_STATUS_FAILED
*/
CAResult_t CAStartDiscoveryServer();
/**
* @brief Register request callbacks and response callbacks.
- * requests and responses are delivered these callbacks .
- * @see CARequestCallback CAResponseCallback
- * @param ReqHandler [IN] Request callback ( for GET,PUT ..etc)
- * @param RespHandler [IN] Response Handler Callback
- * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * Requests and responses are delivered these callbacks .
+ * @param ReqHandler [IN] Request callback ( for GET,PUT ..etc)
+ * @param RespHandler [IN] Response Handler Callback
+ * @see CARequestCallback
+ * @see CAResponseCallback
+ * @return NONE
*/
-CAResult_t CARegisterHandler(CARequestCallback ReqHandler, CAResponseCallback RespHandler);
+void CARegisterHandler(CARequestCallback ReqHandler, CAResponseCallback RespHandler);
+
+#ifdef __WITH_DTLS__
+/**
+ * @brief Register callback to get DTLS PSK credentials.
+ * @param GetDTLSCredentials [IN] GetDTLS Credetials callback
+ * @return #CA_STATUS_OK
+ */
+CAResult_t CARegisterDTLSCredentialsHandler(
+ CAGetDTLSCredentialsHandler GetDTLSCredentials);
+#endif //__WITH_DTLS__
/**
* @brief Create a Remote endpoint if the URI is available already.
- * for FindResource-> unicast requests , this API is used.
- * FindResource(URI)-> CACreateRemoteEndpoint , CASendRequest(GET)
- * @param uri [IN] Absolute URI of the resource to be used to generate the Remote endpoint
- * for ex : coap://10.11.12.13:4545/resource_uri ( for IP)
- * coap://10:11:12:13:45:45/resource_uri ( for BT)
- * @param object [OUT ] Endpoint object which contains the above parsed data
- * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * This is a Helper function which can be used before calling
+ * CASendRequest / CASendNotification.
+ * @param uri [IN] Absolute URI of the resource to be used to generate the
+ * Remote endpoint
+ * \n For ex : coap://10.11.12.13:4545/resource_uri ( for IP)
+ * \n coap://10:11:12:13:45:45/resource_uri ( for BT)
+ * @param transportType [IN] Transport type of the endpoint
+ * @param object [OUT] Endpoint object which contains the above parsed data
+ * @return #CA_STATUS_OK or #CA_STATUS_FAILED
+ * @remark The created Remote endpoint can be freed using CADestroyRemoteEndpoint() API.
+ * @see CADestroyRemoteEndpoint
*/
-CAResult_t CACreateRemoteEndpoint(const CAURI_t uri, CARemoteEndpoint_t** object);
+CAResult_t CACreateRemoteEndpoint(const CAURI_t uri,
+ const CATransportType_t transportType,
+ CARemoteEndpoint_t **object);
/**
- * @brief API Destroy the remote endpoint created
- * @param object [IN] endpoint object created with CACreateRemoteEndpoint
+ * @brief Destroy the remote endpoint created
+ * @param object [IN] Remote Endpoint object created with CACreateRemoteEndpoint
+ * @return NONE
*/
-void CADestroyRemoteEndpoint(CARemoteEndpoint_t* object);
+void CADestroyRemoteEndpoint(CARemoteEndpoint_t *object);
/**
- * @brief Generating the token for the requests/response.
- * Token memory is created and destroyed by the calle.
- * @param token [OUT] token for the request
- * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * @brief Generating the token for matching the request and response.
+ * @param token [OUT] Token for the request
+ * @param tokenLength [IN] length of the token
+ * @return #CA_STATUS_OK or #CA_STATUS_FAILED or #CA_MEMORY_ALLOC_FAILED
+ * or #CA_STATUS_NOT_INITIALIZED
+ * @remark Token memory is destroyed by the caller using CADestroyToken().
+ * @see CADestroyToken
*/
-CAResult_t CAGenerateToken(CAToken_t* token);
+CAResult_t CAGenerateToken(CAToken_t *token, uint8_t tokenLength);
/**
* @brief Destroy the token generated by CAGenerateToken
- * @param token [IN] token for the request
+ * @param token [IN] token to be freed
+ * @return NONE
*/
void CADestroyToken(CAToken_t token);
/**
- * @brief Find the resource in the network. This API internally sends multicast messages on the
- * all connectivity adapters. Responses are delivered via response callbacks.
+ * @brief Find the resource in the network. This API internally sends multicast messages on all
+ * selected connectivity adapters. Responses are delivered via response callbacks.
*
- * @param resourceUri [IN] Uri to send multicast search request
- * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * @param resourceUri [IN] Uri to send multicast search request. Must contain only relative
+ * path of Uri to be search.
+ * @param token [IN] Token for the request
+ * @param tokenLength [IN] length of the token
+ * @return #CA_STATUS_OK or #CA_STATUS_FAILED or #CA_STATUS_NOT_INITIALIZED
*/
-CAResult_t CAFindResource(const CAURI_t resourceUri);
+CAResult_t CAFindResource(const CAURI_t resourceUri, const CAToken_t token, uint8_t tokenLength);
/**
* @brief Send control Request on a resource
- * @param object [IN] Remote Endpoint where the payload need to be sent.
- * This Remote endpoint is delivered with Request or response callback.
- * @param requestInfo [IN ] information for the request.
- * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * @param object [IN] Remote Endpoint where the payload need to be sent.
+ * This Remote endpoint is delivered with Request or response callback.
+ * @param requestInfo [IN] Information for the request.
+ * @return #CA_STATUS_OK #CA_STATUS_FAILED #CA_MEMORY_ALLOC_FAILED
*/
-CAResult_t CASendRequest(const CARemoteEndpoint_t* object, CARequestInfo_t* requestInfo);
+CAResult_t CASendRequest(const CARemoteEndpoint_t *object, const CARequestInfo_t *requestInfo);
/**
- * @brief Sendi the response
- * @param object [IN] Remote Endpoint where the payload need to be sent.
- * This Remote endpoint is delivered with Request or response callback
- * @param responseInfo [IN ] information for the response
- * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * @brief Send control Request on a resource to multicast group
+ * @param object [IN] Group Endpoint where the payload need to be sent.
+ * This Remote endpoint is delivered with Request or response callback.
+ * @param requestInfo [IN] Information for the request.
+ * @return #CA_STATUS_OK or #CA_STATUS_FAILED or #CA_MEMORY_ALLOC_FAILED
*/
-CAResult_t CASendResponse(const CARemoteEndpoint_t* object, CAResponseInfo_t* responseInfo);
+CAResult_t CASendRequestToAll(const CAGroupEndpoint_t *object,
+ const CARequestInfo_t *requestInfo);
+
+/**
+ * @brief Send the response
+ * @param object [IN] Remote Endpoint where the payload need to be sent.
+ * This Remote endpoint is delivered with Request or response callback
+ * @param responseInfo [IN] Information for the response
+ * @return #CA_STATUS_OK or #CA_STATUS_FAILED or #CA_MEMORY_ALLOC_FAILED
+ */
+CAResult_t CASendResponse(const CARemoteEndpoint_t *object,
+ const CAResponseInfo_t *responseInfo);
/**
* @brief Send notification to the remote object
- * @param object [IN] Remote Endpoint where the payload need to be sent.
- * This Remote endpoint is delivered with Request or response callback.
- * @param responseInfo [IN ] information for the response.
- * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * @param object [IN] Remote Endpoint where the payload need to be sent.
+ * This Remote endpoint is delivered with Request or response callback.
+ * @param responseInfo [IN] Information for the response.
+ * @return #CA_STATUS_OK or #CA_STATUS_FAILED or #CA_MEMORY_ALLOC_FAILED
*/
-CAResult_t CASendNotification(const CARemoteEndpoint_t* object, CAResponseInfo_t* responseInfo);
+CAResult_t CASendNotification(const CARemoteEndpoint_t *object,
+ const CAResponseInfo_t *responseInfo);
/**
- * @brief for advertise the resource
- * @param resourceUri [IN] URI to be advertised
- * @param options [IN] header options information
- * @param numOptions [IN] number of options
- * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * @brief To advertise the resource
+ * @param resourceUri [IN] URI to be advertised
+ * @param token [IN] Token for the request
+ * @param tokenLength [IN] length of the token
+ * @param options [IN] Header options information
+ * @param numOptions [IN] Number of options
+ * @return #CA_STATUS_OK or #CA_STATUS_FAILED or
+ * #CA_MEMORY_ALLOC_FAILED or #CA_STATUS_NOT_INITIALIZED
*/
-CAResult_t CAAdvertiseResource(const CAURI_t resourceUri, CAHeaderOption_t* options,
- uint8_t numOptions);
+CAResult_t CAAdvertiseResource(const CAURI_t resourceUri,const CAToken_t token,
+ uint8_t tokenLength, const CAHeaderOption_t *options,
+ const uint8_t numOptions);
/**
* @brief Select network to use
- * @param interestedNetwork [IN] Connectivity Type enum
- * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * @param interestedNetwork [IN] Connectivity Type enum
+ * @return #CA_STATUS_OK or #CA_NOT_SUPPORTED or #CA_STATUS_FAILED or #CA_NOT_SUPPORTED
*/
CAResult_t CASelectNetwork(const uint32_t interestedNetwork);
/**
* @brief Select network to unuse
- * @param nonInterestedNetwork [IN] Connectivity Type enum
- * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * @param nonInterestedNetwork [IN] Connectivity Type enum
+ * @return #CA_STATUS_OK or #CA_NOT_SUPPORTED or #CA_STATUS_FAILED
*/
CAResult_t CAUnSelectNetwork(const uint32_t nonInterestedNetwork);
/**
* @brief Get network information
- * It should be destroyed by the caller as its Get Information.
- * @param info [OUT] LocalConnectivity objects
- * @param size [OUT] No Of Array objects
- * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * It should be destroyed by the caller as it Get Information.
+ * @param info [OUT] LocalConnectivity objects
+ * @param size [OUT] No Of Array objects
+ * @return #CA_STATUS_OK or #CA_STATUS_FAILED or #CA_STATUS_INVALID_PARAM or
+* #CA_MEMORY_ALLOC_FAILED
*/
-CAResult_t CAGetNetworkInformation(CALocalConnectivityt_t **info, uint32_t* size);
+CAResult_t CAGetNetworkInformation(CALocalConnectivity_t **info, uint32_t *size);
/**
- * @brief for usage of singled threaded application.
- * @return CA_STATUS_OK or ERROR CODES ( CAResult_t error codes in cacommon.h)
+ * @brief To Handle the Request or Response
+ * @return #CA_STATUS_OK
*/
CAResult_t CAHandleRequestResponse();
} /* extern "C" */
#endif
-#endif
+#endif /* CA_INTERFACE_H_ */
+
projects / platform / upstream / iotivity.git / blobdiff