Move return codes sent by server to protocols.h

Those codes are not part of security-manager's API
but are used only in communication between client and
server part. Return codes of libsecurity-manager's
functions are defined in enum lib_retcode, so there
is no need in placing additional macros in header file
security-manager.h

Also: fix problems with documentation in those macros

Change-Id: Iaa2f489f2b0a3e9dc3d2aaf74f522451e1b65057
Signed-off-by: Jan Cybulski <j.cybulski@samsung.com>

diff --git a/src/client/client-common.cpp b/src/client/client-common.cpp
index d43aa94..a58f7b3 100644 (file)
--- a/src/client/client-common.cpp
+++ b/src/client/client-common.cpp
@@ -40,7 +40,7 @@
 #include <message-buffer.h>
 #include <smack-common.h>
 
-#include <security-manager.h>
+#include <protocols.h>
 
 IMPLEMENT_SAFE_SINGLETON(SecurityManager::Log::LogSystem);
 

diff --git a/src/common/include/protocols.h b/src/common/include/protocols.h
index d6ba8bb..fadc46c 100644 (file)
--- a/src/common/include/protocols.h
+++ b/src/common/include/protocols.h
@@ -28,6 +28,78 @@
 #include <vector>
 #include <string>
 
+/**
+ * \name Return Codes
+ * exported by the foundation API.
+ * result codes begin with the start error code and extend into negative direction.
+ * @{
+*/
+
+/*! \brief   indicating the result of the one specific API is successful */
+#define SECURITY_MANAGER_API_SUCCESS 0
+
+/*! \brief   indicating the socket between client and Security Manager has been failed  */
+#define SECURITY_MANAGER_API_ERROR_SOCKET -1
+
+/*! \brief   indicating the request to Security Manager is malformed */
+#define SECURITY_MANAGER_API_ERROR_BAD_REQUEST -2
+
+/*! \brief   indicating the response from Security Manager is malformed */
+#define SECURITY_MANAGER_API_ERROR_BAD_RESPONSE -3
+
+/*! \brief   indicating the requested service does not exist */
+#define SECURITY_MANAGER_API_ERROR_NO_SUCH_SERVICE -4
+
+/*! \brief   indicating requesting object is not exist */
+#define SECURITY_MANAGER_API_ERROR_NO_SUCH_OBJECT -6
+
+/*! \brief   indicating the authentication between client and server has been failed */
+#define SECURITY_MANAGER_API_ERROR_AUTHENTICATION_FAILED -7
+
+/*! \brief   indicating the API's input parameter is malformed */
+#define SECURITY_MANAGER_API_ERROR_INPUT_PARAM -8
+
+/*! \brief   indicating the output buffer size which is passed as parameter is too small */
+#define SECURITY_MANAGER_API_ERROR_BUFFER_TOO_SMALL -9
+
+/*! \brief   indicating system  is running out of memory state */
+#define SECURITY_MANAGER_API_ERROR_OUT_OF_MEMORY -10
+
+/*! \brief   indicating the access has been denied by Security Manager */
+#define SECURITY_MANAGER_API_ERROR_ACCESS_DENIED -11
+
+/*! \brief   indicating Security Manager has been failed for some reason */
+#define SECURITY_MANAGER_API_ERROR_SERVER_ERROR -12
+
+/*! \brief   indicating getting smack label from socket failed  */
+#define SECURITY_MANAGER_API_ERROR_GETTING_SOCKET_LABEL_FAILED -21
+
+/*! \brief   indicating getting smack label from file failed  */
+#define SECURITY_MANAGER_API_ERROR_GETTING_FILE_LABEL_FAILED -22
+
+/*! \brief   indicating setting smack label for file failed  */
+#define SECURITY_MANAGER_API_ERROR_SETTING_FILE_LABEL_FAILED -23
+
+/*! \brief   indicating file already exists  */
+#define SECURITY_MANAGER_API_ERROR_FILE_EXIST -24
+
+/*! \brief   indicating file does not exist  */
+#define SECURITY_MANAGER_API_ERROR_FILE_NOT_EXIST -25
+
+/*! \brief   indicating file open error  */
+#define SECURITY_MANAGER_API_ERROR_FILE_OPEN_FAILED -26
+
+/*! \brief   indicating file creation error  */
+#define SECURITY_MANAGER_API_ERROR_FILE_CREATION_FAILED -27
+
+/*! \brief   indicating file deletion error  */
+#define SECURITY_MANAGER_API_ERROR_FILE_DELETION_FAILED -28
+
+/*! \brief   indicating the error with unknown reason */
+#define SECURITY_MANAGER_API_ERROR_UNKNOWN -255
+/** @}*/
+
+
 struct app_inst_req {
     std::string appId;
     std::string pkgId;

diff --git a/src/include/security-manager.h b/src/include/security-manager.h
index 760ee3f..81ddade 100644 (file)
--- a/src/include/security-manager.h
+++ b/src/include/security-manager.h
@@ -29,75 +29,6 @@
 
 #include <sys/types.h>
 
-/**
- * \name Return Codes
- * exported by the foundation API.
- * result codes begin with the start error code and extend into negative direction.
- * @{
-*/
-#define SECURITY_MANAGER_API_SUCCESS 0
-/*! \brief   indicating the result of the one specific API is successful */
-#define SECURITY_MANAGER_API_ERROR_SOCKET -1
-
-/*! \brief   indicating the socket between client and Security Manager has been failed  */
-#define SECURITY_MANAGER_API_ERROR_BAD_REQUEST -2
-
-/*! \brief   indicating the response from Security Manager is malformed */
-#define SECURITY_MANAGER_API_ERROR_BAD_RESPONSE -3
-
-/*! \brief   indicating the requested service does not exist */
-#define SECURITY_MANAGER_API_ERROR_NO_SUCH_SERVICE -4
-
-/*! \brief   indicating requesting object is not exist */
-#define SECURITY_MANAGER_API_ERROR_NO_SUCH_OBJECT -6
-
-/*! \brief   indicating the authentication between client and server has been failed */
-#define SECURITY_MANAGER_API_ERROR_AUTHENTICATION_FAILED -7
-
-/*! \brief   indicating the API's input parameter is malformed */
-#define SECURITY_MANAGER_API_ERROR_INPUT_PARAM -8
-
-/*! \brief   indicating the output buffer size which is passed as parameter is too small */
-#define SECURITY_MANAGER_API_ERROR_BUFFER_TOO_SMALL -9
-
-/*! \brief   indicating system  is running out of memory state */
-#define SECURITY_MANAGER_API_ERROR_OUT_OF_MEMORY -10
-
-/*! \brief   indicating the access has been denied by Security Manager */
-#define SECURITY_MANAGER_API_ERROR_ACCESS_DENIED -11
-
-/*! \brief   indicating Security Manager has been failed for some reason */
-#define SECURITY_MANAGER_API_ERROR_SERVER_ERROR -12
-
-/*! \brief   indicating getting smack label from socket failed  */
-#define SECURITY_MANAGER_API_ERROR_GETTING_SOCKET_LABEL_FAILED -21
-
-/*! \brief   indicating getting smack label from file failed  */
-#define SECURITY_MANAGER_API_ERROR_GETTING_FILE_LABEL_FAILED -22
-
-/*! \brief   indicating setting smack label for file failed  */
-#define SECURITY_MANAGER_API_ERROR_SETTING_FILE_LABEL_FAILED -23
-
-/*! \brief   indicating file already exists  */
-#define SECURITY_MANAGER_API_ERROR_FILE_EXIST -24
-
-/*! \brief   indicating file does not exist  */
-#define SECURITY_MANAGER_API_ERROR_FILE_NOT_EXIST -25
-
-/*! \brief   indicating file open error  */
-#define SECURITY_MANAGER_API_ERROR_FILE_OPEN_FAILED -26
-
-/*! \brief   indicating file creation error  */
-#define SECURITY_MANAGER_API_ERROR_FILE_CREATION_FAILED -27
-
-/*! \brief   indicating file deletion error  */
-#define SECURITY_MANAGER_API_ERROR_FILE_DELETION_FAILED -28
-
-/*! \brief   indicating the error with unknown reason */
-#define SECURITY_MANAGER_API_ERROR_UNKNOWN -255
-/** @}*/
-
-
 #ifdef __cplusplus
 extern "C" {
 #endif