Enable build with iniparser v 3.1
[platform/framework/native/appfw.git] / inc / FIoMessagePortManager.h
index 03c28cd..50d4d0c 100644 (file)
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -55,24 +54,27 @@ class _OSP_EXPORT_ MessagePortManager
 public:
        /**
        * Requests for a LocalMessagePort instance with the specified message port name. @n
-       * This method returns the same %LocalMessagePort instance if it has already been called with the same message port name. @n
+       * This method returns the same %LocalMessagePort instance if it has already been called with the same message port name.
        *
        * @since    2.0
        *
        * @return       A pointer to the LocalMessagePort instance, @n
        *                       else @c null if it fails
-       * @param[in]     localMessagePortName   The name of a local message port
-       * @exception     E_SUCCESS           The method is successful.
-       * @exception     E_INVALID_ARG       The @c localMessagePortName is empty.
-       * @exception     E_SYSTEM            The method has failed due to a severe system error.
-       * @remarks       It is not recommended to use the message port names that start with "http://tizen.org/messageport". @c E_INVALID_ARG may be returned because they are reserved by platform.
-       * @remarks       The specific error code can be accessed using the GetLastResult() method.
+       * @param[in]    localMessagePortName    The name of a local message port
+       * @exception    E_SUCCESS               The method is successful.
+       * @exception    E_INVALID_ARG           The @c localMessagePortName is empty.
+       * @exception    E_SYSTEM                The method has failed due to a severe system error.
+       * @remarks
+       *                               - It is not recommended to use the message port names that start with "http://tizen.org/messageport".
+       *                               @c E_INVALID_ARG may be returned because they are reserved by platform.
+       *                               - The specific error code can be accessed using the GetLastResult() method.
        */
        static LocalMessagePort* RequestLocalMessagePort(const Tizen::Base::String& localMessagePortName);
 
        /**
-       * Requests the RemoteMessagePort instance with the specified remote application ID and message port name. @n
-       * This method returns the same %RemoteMessagePort instance if it has already been called with the same remote application ID and message port name.
+       * Requests for a RemoteMessagePort instance with the specified remote application ID and message port name. @n
+       * This method returns the same %RemoteMessagePort instance if it has already been called with the same remote application ID
+       * and message port name.
        *
        * @since    2.0
        *
@@ -80,10 +82,10 @@ public:
        *                       else @c null if it fails
        * @param[in]     remoteAppId                    The remote application ID
        * @param[in]     remoteMessagePortName  The remote message port name
-       * @exception     E_SUCCESS           The method is successful.
-       * @exception     E_INVALID_ARG       The remote application ID or the remote message port name is empty.
-       * @exception     E_OBJ_NOT_FOUND     The message port of the target application is not found.
-       * @exception     E_SYSTEM            The method cannot proceed due to a severe system error.
+       * @exception     E_SUCCESS              The method is successful.
+       * @exception     E_INVALID_ARG          The remote application ID or the remote message port name is empty.
+       * @exception     E_OBJ_NOT_FOUND        The message port of the target application is not found.
+       * @exception     E_SYSTEM               The method cannot proceed due to a severe system error.
        * @remarks       The specific error code can be accessed using the GetLastResult() method.
        */
        static RemoteMessagePort* RequestRemoteMessagePort(const Tizen::App::AppId& remoteAppId, const Tizen::Base::String& remoteMessagePortName);
@@ -91,38 +93,43 @@ public:
        /**
        * Requests for a trusted LocalMessagePort instance with the specified message port name. @n
        * This method returns the same %LocalMessagePort instance if it has already been called with the same message port name. @n
-       * Communications over a trusted message port is allowed only if both the applications are signed with a certificate that is uniquely assigned to the developer.
+       * Communications over a trusted message port is allowed only if both the applications are signed with a certificate that is
+       * uniquely assigned to the developer.
        *
        * @since    2.0
        *
        * @return       A pointer to the trusted LocalMessagePort instance, @n
        *                       else @c null if it fails
-       * @param[in]     localMessagePortName   The name of a local message port
-       * @exception     E_SUCCESS           The method is successful.
-       * @exception     E_INVALID_ARG       The @c localMessagePortName is empty.
-       * @exception     E_SYSTEM            The method has failed due to a severe system error.
-       * @remarks       It is not recommended to use the message port names that start with "http://tizen.org/messageport". @c E_INVALID_ARG may be returned because they are reserved by platform.
-       * @remarks       The specific error code can be accessed using the GetLastResult() method.
+       * @param[in]    localMessagePortName    The name of a local message port
+       * @exception    E_SUCCESS               The method is successful.
+       * @exception    E_INVALID_ARG           The @c localMessagePortName is empty.
+       * @exception    E_SYSTEM                The method has failed due to a severe system error.
+       * @remarks
+       *                               - It is not recommended to use the message port names that start with "http://tizen.org/messageport".
+       *                               @c E_INVALID_ARG may be returned because they are reserved by platform.
+       *                               - The specific error code can be accessed using the GetLastResult() method.
        */
        static LocalMessagePort* RequestTrustedLocalMessagePort(const Tizen::Base::String& localMessagePortName);
 
        /**
-       * Requests the trusted RemoteMessagePort instance with the specified message port name. @n
-       * This method returns the same %RemoteMessagePort instance if it has already been called with the same remote application ID and message port name. @n
-       * This message port allows communications only if the applications are signed with the same certificate which is uniquely assigned to the developer.
+       * Requests for a trusted RemoteMessagePort instance with the specified message port name. @n
+       * This method returns the same %RemoteMessagePort instance if it has already been called with the same remote application ID
+       * and message port name. @n
+       * This message port allows communications only if the applications are signed with the same certificate which is uniquely
+       * assigned to the developer.
        *
        * @since    2.0
        *
        * @return       A pointer to the trusted RemoteMessagePort instance, @n
        *                       else @c null if it fails
-       * @param[in]     remoteAppId                    The remote application ID
-       * @param[in]     remoteMessagePortName  The name of a remote message port
-       * @exception     E_SUCCESS           The method is successful.
-       * @exception     E_INVALID_ARG       Either @c remoteAppId or @c remoteMessagePortName is empty.
-       * @exception     E_OBJ_NOT_FOUND     The message port of the target application is not found.
-       * @exception     E_CERTIFICATE_VERIFICATION_FAILED    The target application is not signed with the same certificate.
-       * @exception     E_SYSTEM            The method has failed due to a severe system error.
-       * @remarks       The specific error code can be accessed using the GetLastResult() method.
+       * @param[in]    remoteAppId                                                     The remote application ID
+       * @param[in]    remoteMessagePortName                           The name of a remote message port
+       * @exception    E_SUCCESS                                       The method is successful.
+       * @exception    E_INVALID_ARG                                   Either @c remoteAppId or @c remoteMessagePortName is empty.
+       * @exception    E_OBJ_NOT_FOUND                                 The message port of the target application is not found.
+       * @exception    E_CERTIFICATE_VERIFICATION_FAILED       The target application is not signed with the same certificate.
+       * @exception    E_SYSTEM                                                        The method has failed due to a severe system error.
+       * @remarks              The specific error code can be accessed using the GetLastResult() method.
        */
        static RemoteMessagePort* RequestTrustedRemoteMessagePort(const Tizen::App::AppId& remoteAppId, const Tizen::Base::String& remoteMessagePortName);