X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=resource%2Fcsdk%2Fconnectivity%2Fapi%2Fcainterface.h;h=b6677660212c072e582547cb4effa3b86eba4ab5;hb=7f00f942c39b7bc27c7eeecf213a239c3fe4173c;hp=7607bfc49d6f93fc3a71b40d0a67059218208ec0;hpb=0734f2d4a926a266e8f5a988834e4c25c2d8d11d;p=platform%2Fupstream%2Fiotivity.git diff --git a/resource/csdk/connectivity/api/cainterface.h b/resource/csdk/connectivity/api/cainterface.h index 7607bfc..b667766 100644 --- a/resource/csdk/connectivity/api/cainterface.h +++ b/resource/csdk/connectivity/api/cainterface.h @@ -31,248 +31,219 @@ * Connectivity Abstraction Interface APIs. */ #include "cacommon.h" - -#ifdef __WITH_DTLS__ -#include "ocsecurityconfig.h" -#endif +#include "casecurityinterface.h" #ifdef __cplusplus extern "C" { #endif -/** - * @brief Callback function type for request delivery. - * @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)(const CARemoteEndpoint_t *object, - const CARequestInfo_t *requestInfo); +#ifdef RA_ADAPTER /** - * @brief Callback function type for response delivery. - * @param object [OUT] Endpoint object from which the response is received. - * @param responseInfo [OUT] Identifier which needs to be mapped with response. - * @return NONE + * Callback for bound JID + * @param[out] jid Boud Jabber Identifier. */ -typedef void (*CAResponseCallback)(const CARemoteEndpoint_t *object, - const CAResponseInfo_t *responseInfo); - -#ifdef __WITH_DTLS__ +typedef void (*CAJidBoundCallback)(char *jid); /** - * Binary blob containing device identity and the credentials for all devices - * trusted by this device. + * CA Remote Access information for XMPP Client + * */ 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; + char *hostName; /**< XMPP server hostname */ + uint16_t port; /**< XMPP server serivce port */ + char *xmppDomain; /**< XMPP login domain */ + char *userName; /**< login username */ + char *password; /**< login password */ + char *resource; /**< specific resource for login */ + char *userJid; /**< specific JID for login */ + CAJidBoundCallback jidBoundCallback; /**< callback when JID bound */ +} CARAInfo_t; +#endif //RA_ADAPTER + +#ifdef TCP_ADAPTER /** - * @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 + * Callback function to pass the connection information from CA to RI. + * @param[out] object remote device information. + * @param[out] isConnected Whether keepalive message needs to be sent. + * @param[out] isClient Host Mode of Operation. */ -typedef void (*CAGetDTLSCredentialsHandler)(CADtlsPskCredsBlob_t **credInfo); -#endif //__WITH_DTLS__ +typedef void (*CAKeepAliveConnectionCallback)(const CAEndpoint_t *object, bool isConnected, + bool isClient); /** - * @brief Initialize the connectivity abstraction module. - * It will initialize adapters, thread pool and other modules based on the platform - * compilation options. - * - * @return #CA_STATUS_OK or #CA_STATUS_FAILED or #CA_MEMORY_ALLOC_FAILED + * Register connection status changes callback to process KeepAlive. + * connection informations are delivered these callbacks. + * @param[in] ConnHandler Connection status changes callback. */ -CAResult_t CAInitialize(); +void CARegisterKeepAliveHandler(CAKeepAliveConnectionCallback ConnHandler); +#endif +/** + * Initialize the connectivity abstraction module. + * It will initialize adapters, thread pool and other modules based on the platform + * compilation options. + * @param[in] transportType transport type to initialize. + * @return ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_MEMORY_ALLOC_FAILED + */ +CAResult_t CAInitialize(CATransportAdapter_t transportType); /** - * @brief Terminate the connectivity abstraction module. - * All threads, data structures are destroyed for next initializations. - * @return NONE + * Terminate the connectivity abstraction module. + * All threads, data structures are destroyed for next initializations. */ 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 #CA_STATUS_FAILED + * 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 ::CA_STATUS_FAILED or ::CA_STATUS_NOT_INITIALIZED */ 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 #CA_STATUS_FAILED + * Stops the server from receiving the multicast traffic. This is used by sleeping + * device to not receives the multicast traffic. + * @return ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_STATUS_NOT_INITIALIZED */ -CAResult_t CAStartDiscoveryServer(); +CAResult_t CAStopListeningServer(); /** - * @brief Register request callbacks and response callbacks. - * 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 + * 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 ::CA_STATUS_FAILED or ::CA_STATUS_NOT_INITIALIZED */ -void CARegisterHandler(CARequestCallback ReqHandler, CAResponseCallback RespHandler); +CAResult_t CAStartDiscoveryServer(); -#ifdef __WITH_DTLS__ /** - * @brief Register callback to get DTLS PSK credentials. - * @param GetDTLSCredentials [IN] GetDTLS Credetials callback - * @return #CA_STATUS_OK + * Register request callbacks and response callbacks. + * Requests and responses are delivered these callbacks. + * @param[in] ReqHandler Request callback ( for GET,PUT ..etc). + * @param[in] RespHandler Response Handler Callback. + * @param[in] ErrorHandler Error Handler Callback. + * @see CARequestCallback + * @see CAResponseCallback + * @see CAErrorCallback */ -CAResult_t CARegisterDTLSCredentialsHandler( - CAGetDTLSCredentialsHandler GetDTLSCredentials); -#endif //__WITH_DTLS__ +void CARegisterHandler(CARequestCallback ReqHandler, CAResponseCallback RespHandler, + CAErrorCallback ErrorHandler); /** - * @brief Create a Remote endpoint if the URI is available already. - * 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 + * Create an endpoint description. + * @param[in] flags how the adapter should be used. + * @param[in] adapter which adapter to use. + * @param[in] addr string representation of address. + * @param[in] port port (for IP_ADAPTER). + * @param[out] object Endpoint which contains the above. + * @return ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_STATUS_INVALID_PARAM + * @remark The created Remote endpoint can be freed using CADestroyEndpoint(). + * @see CADestroyEndpoint */ -CAResult_t CACreateRemoteEndpoint(const CAURI_t uri, - const CATransportType_t transportType, - CARemoteEndpoint_t **object); +CAResult_t CACreateEndpoint(CATransportFlags_t flags, + CATransportAdapter_t adapter, + const char *addr, + uint16_t port, + CAEndpoint_t **object); /** - * @brief Destroy the remote endpoint created - * @param object [IN] Remote Endpoint object created with CACreateRemoteEndpoint - * @return NONE + * Destroy the remote endpoint created. + * @param[in] object Remote Endpoint object created with CACreateEndpoint. */ -void CADestroyRemoteEndpoint(CARemoteEndpoint_t *object); +void CADestroyEndpoint(CAEndpoint_t *object); /** - * @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 + * Generating the token for matching the request and response. + * @param[out] token Token for the request. + * @param[in] tokenLength length of the token. + * @return ::CA_STATUS_OK or ::CA_STATUS_FAILED or + * ::CA_MEMORY_ALLOC_FAILED or ::CA_STATUS_INVALID_PARAM * @remark Token memory is destroyed by the caller using CADestroyToken(). * @see CADestroyToken */ CAResult_t CAGenerateToken(CAToken_t *token, uint8_t tokenLength); /** - * @brief Destroy the token generated by CAGenerateToken - * @param token [IN] token to be freed - * @return NONE + * Destroy the token generated by CAGenerateToken. + * @param[in] token token to be freed. */ void CADestroyToken(CAToken_t token); /** - * @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. 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, 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 #CA_STATUS_FAILED #CA_MEMORY_ALLOC_FAILED - */ -CAResult_t CASendRequest(const CARemoteEndpoint_t *object, const CARequestInfo_t *requestInfo); - -/** - * @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 + * Send control Request on a resource. + * @param[in] object Endpoint where the payload need to be sent. + * This endpoint is delivered with Request or response callback. + * @param[in] requestInfo Information for the request. + * @return ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_STATUS_NOT_INITIALIZED or + ::CA_SEND_FAILED or ::CA_STATUS_INVALID_PARAM or ::CA_MEMORY_ALLOC_FAILED */ -CAResult_t CASendRequestToAll(const CAGroupEndpoint_t *object, - const CARequestInfo_t *requestInfo); +CAResult_t CASendRequest(const CAEndpoint_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 + * Send the response. + * @param[in] object Endpoint where the payload need to be sent. + * This endpoint is delivered with Request or response callback. + * @param[in] responseInfo Information for the response. + * @return ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_STATUS_NOT_INITIALIZED or + ::CA_SEND_FAILED or ::CA_STATUS_INVALID_PARAM or ::CA_MEMORY_ALLOC_FAILED */ -CAResult_t CASendResponse(const CARemoteEndpoint_t *object, - const CAResponseInfo_t *responseInfo); +CAResult_t CASendResponse(const CAEndpoint_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 #CA_STATUS_FAILED or #CA_MEMORY_ALLOC_FAILED + * Select network to use. + * @param[in] interestedNetwork Connectivity Type enum. + * @return ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_STATUS_NOT_INITIALIZED or + * ::CA_NOT_SUPPORTED or ::CA_ADAPTER_NOT_ENABLED or ::CA_MEMORY_ALLOC_FAILED */ -CAResult_t CASendNotification(const CARemoteEndpoint_t *object, - const CAResponseInfo_t *responseInfo); +CAResult_t CASelectNetwork(CATransportAdapter_t interestedNetwork); /** - * @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 + * Select network to unuse. + * @param[in] nonInterestedNetwork Connectivity Type enum. + * @return ::CA_STATUS_OK or ::CA_NOT_SUPPORTED or ::CA_STATUS_FAILED or + ::CA_STATUS_NOT_INITIALIZED */ -CAResult_t CAAdvertiseResource(const CAURI_t resourceUri,const CAToken_t token, - uint8_t tokenLength, const CAHeaderOption_t *options, - const uint8_t numOptions); +CAResult_t CAUnSelectNetwork(CATransportAdapter_t nonInterestedNetwork); /** - * @brief Select network to use - * @param interestedNetwork [IN] Connectivity Type enum - * @return #CA_STATUS_OK or #CA_NOT_SUPPORTED or #CA_STATUS_FAILED or #CA_NOT_SUPPORTED + * Get network information. + * It should be destroyed by the caller as it Get Information. + * @param[out] info LocalConnectivity objects + * @param[out] size No Of Array objects + * @return ::CA_STATUS_OK or ::CA_STATUS_FAILED or ::CA_STATUS_NOT_INITIALIZED or + * ::CA_STATUS_INVALID_PARAM or ::CA_MEMORY_ALLOC_FAILED */ -CAResult_t CASelectNetwork(const uint32_t interestedNetwork); +CAResult_t CAGetNetworkInformation(CAEndpoint_t **info, uint32_t *size); /** - * @brief Select network to unuse - * @param nonInterestedNetwork [IN] Connectivity Type enum - * @return #CA_STATUS_OK or #CA_NOT_SUPPORTED or #CA_STATUS_FAILED + * To Handle the Request or Response. + * @return ::CA_STATUS_OK or ::CA_STATUS_NOT_INITIALIZED */ -CAResult_t CAUnSelectNetwork(const uint32_t nonInterestedNetwork); +CAResult_t CAHandleRequestResponse(); +#ifdef RA_ADAPTER /** - * @brief Get network information - * 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 + * Set Remote Access information for XMPP Client. + * @param[in] caraInfo remote access info. + * + * @return ::CA_STATUS_OK or ::CA_STATUS_INVALID_PARAM */ -CAResult_t CAGetNetworkInformation(CALocalConnectivity_t **info, uint32_t *size); +CAResult_t CASetRAInfo(const CARAInfo_t *caraInfo); +#endif +#ifdef WITH_CHPROXY /** - * @brief To Handle the Request or Response - * @return #CA_STATUS_OK + * This function sets uri being used for proxy. + * + * @param uri NULL terminated resource uri for CoAP-HTTP Proxy. + * + * @return ::CA_STATUS_OK or ::CA_STATUS_INVALID_PARAM */ -CAResult_t CAHandleRequestResponse(); +CAResult_t CASetProxyUri(const char *uri); +#endif #ifdef __cplusplus } /* extern "C" */