summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSunwook Bae <sunwook45.bae@samsung.com>2013-07-24 19:51:32 +0900
committerSunwook Bae <sunwook45.bae@samsung.com>2013-07-24 19:51:32 +0900
commit75f7722ba72ef7fb4577fbc47fec38d06f98b14d (patch)
treecb1bd4b2c8a64c2b04d95e4a4ca029c5669552bc
parentc0562c2dc210e20b89a3d9b49f4cbbc463294891 (diff)
downloadmessage-port-75f7722ba72ef7fb4577fbc47fec38d06f98b14d.tar.gz
message-port-75f7722ba72ef7fb4577fbc47fec38d06f98b14d.tar.bz2
message-port-75f7722ba72ef7fb4577fbc47fec38d06f98b14d.zip
Update document
Change-Id: Iafb50a706ead369282dee26bd11c0dbf4204bb25 Signed-off-by: Sunwook Bae <sunwook45.bae@samsung.com>
-rw-r--r--src/IpcClient.h39
1 files changed, 9 insertions, 30 deletions
diff --git a/src/IpcClient.h b/src/IpcClient.h
index 716ed5d..ba1abfe 100644
--- a/src/IpcClient.h
+++ b/src/IpcClient.h
@@ -60,14 +60,12 @@ public:
/**
* Constructs the instance of this class.
*
- * @return An error code
- * @param[in] serverName The name of the server
- * @param[in] pListener Set if the client want to handle a message from the IPC server.
+ * @return 0 on success, otherwise a negative error value.
+ * @param [in] serverName The name of the server
+ * @param [in] pListener Set if the client want to handle a message from the IPC server.
* @c NULL, otherwise.
- * @exception E_SUCCESS The method was successful.
- * @exception E_OBJ_NOT_FOUND The IPC server was not found.
- * @exception E_OUT_OF_MEMORY Insufficient memory.
- * @exception E_SYSTEM A system error occurred.
+ * @retval MESSAGEPORT_ERROR_OUT_OF_MEMORY Insufficient memory.
+ * @retval MESSAGEPORT_ERROR_IO_ERROR A system error occurred.
*/
int Construct(const std::string& serverName, const IIpcClientEventListener* pListener = NULL);
@@ -81,28 +79,10 @@ public:
/**
* Sends a request message to an IPC server.
*
- * @code
- *
- *
- * int
- * CalculatorProxy::Add(int a , int b)
- * {
- * int c = 0;
- *
- * My_sum mySum(a, b, &c);
- *
- * __pIpcClient->SendRequest(mySum);
- *
- * return c;
- * }
- *
- * @endcode
- * @return An error code
- * @param[in] message The message to send
- * @exception E_SUCCESS The method was successful.
- * @exception E_INVALID_STATE The instance is in an invalid state.
- * @exception E_OUT_OF_MEMORY Insufficient memory.
- * @exception E_SYSTEM A system error occurred.
+ * @return 0 on success, otherwise a negative error value.
+ * @param [in] message The message to send
+ * @retval MESSAGEPORT_ERROR_OUT_OF_MEMORY Insufficient memory.
+ * @retval MESSAGEPORT_ERROR_IO_ERROR A system error occurred.
*
*/
int SendRequest(const IPC::Message& message);
@@ -135,7 +115,6 @@ private:
pthread_mutex_t* __pMutex;
std::vector <int> __fds;
- //Tizen::Base::Runtime::Mutex* __pFdLock;
std::string __name;
std::string __appId;
IIpcClientEventListener* __pListener;