X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=resource%2Fcsdk%2Fsecurity%2Finclude%2Finternal%2Fsecureresourcemanager.h;h=7976452be8042c6b1882f6f3d73209babc43ec43;hb=390866079e285d2c74918432c0d597d5da52f8a0;hp=eb2643b3a1fd6d3f67e3bff478bb449c1673f6e3;hpb=3e9402ad71cb3e93266a77796f44d17bab9853fd;p=platform%2Fupstream%2Fiotivity.git diff --git a/resource/csdk/security/include/internal/secureresourcemanager.h b/resource/csdk/security/include/internal/secureresourcemanager.h index eb2643b..7976452 100644 --- a/resource/csdk/security/include/internal/secureresourcemanager.h +++ b/resource/csdk/security/include/internal/secureresourcemanager.h @@ -28,83 +28,91 @@ extern "C" { #endif /** - * @brief Register Persistent storage callback. - * @param persistentStorageHandler [IN] Pointers to open, read, write, close & unlink handlers. - * @return - * OC_STACK_OK - No errors; Success - * OC_STACK_INVALID_PARAM - Invalid parameter + * Register Persistent storage callback. + * + * @param persistentStorageHandler [IN] Pointers to open, read, write, close & unlink handlers. + * + * @return ::OC_STACK_OK is no errors and successful. ::OC_STACK_INVALID_PARAM for invalid parameter. */ OCStackResult SRMRegisterPersistentStorageHandler(OCPersistentStorage* persistentStorageHandler); /** - * @brief Get Persistent storage handler pointer. - * @return - * The pointer to Persistent Storage callback handler + * Get Persistent storage handler pointer. + * + * @return The pointer to Persistent Storage callback handler. */ OCPersistentStorage* SRMGetPersistentStorageHandler(); /** - * @brief Register request and response callbacks. - * Requests and responses are delivered in these callbacks. - * @param reqHandler [IN] Request handler callback ( for GET,PUT ..etc) - * @param respHandler [IN] Response handler callback. - * @param errHandler [IN] Error handler callback. - * @return - * OC_STACK_OK - No errors; Success - * OC_STACK_INVALID_PARAM - Invalid parameter + * Register request and response callbacks. Requests and responses are delivered in these callbacks. + * + * @param reqHandler Request handler callback ( for GET,PUT ..etc) + * @param respHandler Response handler callback. + * @param errHandler Error handler callback. + * + * @return ::OC_STACK_OK is no errors and successful. ::OC_STACK_INVALID_PARAM for invalid parameter. */ OCStackResult SRMRegisterHandler(CARequestCallback reqHandler, CAResponseCallback respHandler, CAErrorCallback errHandler); /** - * @brief Initialize all secure resources ( /oic/sec/cred, /oic/sec/acl, /oic/sec/pstat etc). - * @return OC_STACK_OK for Success, otherwise some error value + * Initialize all secure resources ( /oic/sec/cred, /oic/sec/acl, /oic/sec/pstat etc). + * @return ::OC_STACK_OK for Success, otherwise some error value. */ OCStackResult SRMInitSecureResources(); /** - * @brief Perform cleanup for secure resources ( /oic/sec/cred, /oic/sec/acl, /oic/sec/pstat etc). - * @return none + * Perform cleanup for secure resources ( /oic/sec/cred, /oic/sec/acl, /oic/sec/pstat etc). */ void SRMDeInitSecureResources(); /** - * @brief Initialize Policy Engine context. - * @return OC_STACK_OK for Success, otherwise some error value. + * Initialize Policy Engine context. + * + * @return ::OC_STACK_OK for Success, otherwise some error value. */ OCStackResult SRMInitPolicyEngine(); /** - * @brief Cleanup Policy Engine context. - * @return none + * Cleanup Policy Engine context. */ void SRMDeInitPolicyEngine(); /** - * @brief Provisioning API response callback. - * @param object[IN] endpoint instance. - * @param responseInfo[IN] instance of CAResponseInfo_t structure. + * Provisioning API response callback. + * + * @param object endpoint instance. + * @param responseInfo instance of CAResponseInfo_t structure. + * * @return true if received response is for provisioning API false otherwise. */ typedef bool (*SPResponseCallback) (const CAEndpoint_t *object, const CAResponseInfo_t *responseInfo); /** - * @brief function to register provisoning API's response callback. + * Function to register provisoning API's response callback. + * * @param respHandler response handler callback. */ void SRMRegisterProvisioningResponseHandler(SPResponseCallback respHandler); /** - * @brief Check the security resource URI. - * @param uri [IN] Pointers to security resource URI. - * @return true if the URI is one of security resources, otherwise false. + * Check the security resource URI. + * @param uri Pointers to security resource URI. + * @return true if the URI is one of security resources, otherwise false. */ bool SRMIsSecurityResourceURI(const char* uri); /** - * @brief Sends Response + * Get the resource type from the URI. + * @param uri [IN] Pointers to security resource URI. + * @return SVR type (note that "NOT_A_SVR_RESOURCE" is returned if not a SVR) + */ +OicSecSvrType_t GetSvrTypeFromUri(const char* uri); + +/** + * Sends Response * @param resposeVal SRMAccessResponse_t value * @return NONE */