merge with master
[framework/osp/net.git] / inc / FNetHttpHttpSession.h
index b03922c..b0a7963 100755 (executable)
@@ -100,7 +100,7 @@ public:
         * @since           2.0
         *
         * @return                      An error code
-        * @param[in]           sessionMode                             The session mode to open the session
+        * @param[in]           sessionMode                     The session mode to open the session
         * @param[in]           pProxyAddr                              A proxy address @n
         *                                                                                      The specified @c pProxyAddr must be a valid URL. If @c pProxyAddr is @c null, %HttpSession uses the system
         *                                                                                      default proxy address.
@@ -109,14 +109,14 @@ public:
         *                                                                                      @c hostAddr is ignored (In case of multiple host mode, @c hostAddr is set to HttpRequest::SetUri()).
         * @param[in]           pCommonHeader                   An instance of HttpHeader @n
         *                                                                                      This is a common header used in all the transactions included in this session.
-        * @param[in]           flag                                    Set to @c true if the cookies must be handled automatically, @n
-        *                                                                                      else @c false if the cookies must be handled manually
+        * @param[in]           flag                                    Set to @c NET_HTTP_COOKIE_FLAG_ALWAYS_AUTOMATIC if the cookies must be handled automatically, @n
+        *                                                                                      else @c NET_HTTP_COOKIE_FLAG_ALWAYS_MANUAL if the cookies must be handled manually
         * @exception           E_SUCCESS                               The method is successful.
         * @exception           E_INVALID_ARG                   A specified input parameter is invalid.
-        * @exception           E_OUT_OF_MEMORY                 The memory is insufficient.
+        * @exception           E_OUT_OF_MEMORY         The memory is insufficient.
         * @exception           E_INVALID_CONNECTION    The net connection is invalid.
-        * @exception           E_MAX_EXCEEDED                  The number of currently opened sessions has exceeded the maximum limit.
-        * @exception           E_INVALID_PROXY                 The specified proxy address is invalid.
+        * @exception           E_MAX_EXCEEDED          The number of currently opened sessions has exceeded the maximum limit.
+        * @exception           E_INVALID_PROXY         The specified proxy address is invalid.
         * @exception           E_UNKNOWN                               An unknown error has occurred.
         * @exception           E_SYSTEM                                An internal error has occurred.
         * @exception           E_INVALID_ADDRESS               The host address is invalid.
@@ -142,8 +142,8 @@ public:
         *                                                                                      The specified @c hostAddr must be a valid URL.
         * @param[in]           pCommonHeader                   An instance of HttpHeader @n
         *                                                                                      This is a common header used in all the transactions included in this session.
-        * @param[in]           flag                                    Set to @c true if the cookies must be handled automatically, @n
-        *                                                                                      else @c false if the cookies must be handled manually
+        * @param[in]           flag                                    Set to @c NET_HTTP_COOKIE_FLAG_ALWAYS_AUTOMATIC if the cookies must be handled automatically, @n
+        *                                                                                      else @c NET_HTTP_COOKIE_FLAG_ALWAYS_MANUAL if the cookies must be handled manually
         * @exception           E_SUCCESS                               The method is successful.
         * @exception           E_INVALID_ARG                   A specified input parameter is invalid.
         * @exception           E_OUT_OF_MEMORY                 The memory is insufficient.
@@ -170,8 +170,9 @@ public:
        /**
         * Opens a transaction.
         *
-        * @since       2.0
-        * @privilege   %http://tizen.org/privilege/http
+        * @since                       2.0
+        * @privlevel           public
+        * @privilege           http://tizen.org/privilege/http
         *
         * @return              A pointer to a new HttpTransaction, @n
         *                              else @c null if an error occurs
@@ -189,8 +190,9 @@ public:
        /**
        * Opens a transaction with authentication information.
        *
-       * @since        2.0
-       * @privilege    %http://tizen.org/privilege/http
+       * @since                        2.0
+       * @privlevel            public
+       * @privilege            http://tizen.org/privilege/http
        *
        * @return               The pointer to a new HttpTransaction, @n
        *                               else @c null if an error occurs
@@ -210,8 +212,9 @@ public:
         * Cancels the specified transaction. @n
         * This method is followed by the CloseTransaction() method.
         *
-        * @since       2.0
-        * @privilege   %http://tizen.org/privilege/http
+        * @since                       2.0
+        * @privlevel           public
+        * @privilege           http://tizen.org/privilege/http
         *
         * @return              An error code
         * @param[in]   httpTransaction             The HttpTransaction to cancel
@@ -230,8 +233,9 @@ public:
        /**
         * Closes the specified transaction.
         *
-        * @since       2.0
-        * @privilege   %http://tizen.org/privilege/http
+        * @since                       2.0
+        * @privlevel           public
+        * @privilege           http://tizen.org/privilege/http
         *
         * @return              An error code
         * @param[in]   httpTransaction                 The HttpTransaction to close
@@ -250,8 +254,9 @@ public:
        /**
         * Closes all the transactions.
         *
-        * @since       2.0
-        * @privilege   %http://tizen.org/privilege/http
+        * @since                       2.0
+        * @privlevel           public
+        * @privilege           http://tizen.org/privilege/http
         *
         * @return              An error code
         * @exception   E_SUCCESS                               The method is successful.
@@ -294,8 +299,9 @@ public:
        /**
         * Gets the number of active transactions in the current instance of %HttpSession.
         *
-        * @since       2.0
-        * @privilege   %http://tizen.org/privilege/http
+        * @since                       2.0
+        * @privlevel           public
+        * @privilege           http://tizen.org/privilege/http
         *
         * @return      An integer value indicating the number of currently active transactions, @n
         *                              else @c -1 if an error occurs
@@ -311,8 +317,9 @@ public:
        /**
         * Gets the maximum number of transactions, the current instance of %HttpSession can have.
         *
-        * @since       2.0
-        * @privilege   %http://tizen.org/privilege/http
+        * @since                       2.0
+        * @privlevel           public
+        * @privilege           http://tizen.org/privilege/http
         *
         * @return      An integer value indicating the maximum number of transactions allowed @n
         *              In NET_HTTP_SESSION_MODE_MULTIPLE_HOST mode, the return value is zero.