X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFIoRemoteMessagePort.h;h=d4163b5de95969facb8a3997d3045e843caa0a7a;hb=b54953ec1a6df32b1f10ce54ec189c9a3ad826b0;hp=6ac2304d95cd746be9586a1b78e04855eae66d20;hpb=84ae32fc9014edf1457554db60000885285034ff;p=platform%2Fframework%2Fnative%2Fappfw.git diff --git a/inc/FIoRemoteMessagePort.h b/inc/FIoRemoteMessagePort.h index 6ac2304..d4163b5 100644 --- a/inc/FIoRemoteMessagePort.h +++ b/inc/FIoRemoteMessagePort.h @@ -1,5 +1,4 @@ // -// Open Service Platform // Copyright (c) 2012 Samsung Electronics Co., Ltd. // // Licensed under the Apache License, Version 2.0 (the License); @@ -63,7 +62,7 @@ class LocalMessagePort; * : public Tizen::Io::IMessagePortListener * { * public: -* result Initialize(void); +* void Initialize(void); * virtual void OnMessageReceivedN(RemoteMessagePort* pRemoteMessagePort, IMap* pMessage); * void GetOnlineFriends(void); * @@ -82,7 +81,7 @@ class LocalMessagePort; * } * * void -* MyAppClass::OnMessageReceivedN(RemoteMessagePort* pRemoteMessagePort, IMap* pMessage); +* MyAppClass::OnMessageReceivedN(RemoteMessagePort* pRemoteMessagePort, IMap* pMessage) * { * String* pValue = static_cast(pMessage->GetValue(String(L"Reply"))); * @@ -90,7 +89,7 @@ class LocalMessagePort; * * delete pMessage; * } - +* * void * MyAppClass::GetOnlineFriends(void) * { @@ -113,25 +112,25 @@ class _OSP_EXPORT_ RemoteMessagePort public: /** - * Gets the name of a remote message port. + * Gets the name of the remote message port. * * @since 2.0 * - * @return The name of a remote message port + * @return The name of the remote message port */ Tizen::Base::String GetName(void) const; /** - * Gets the ID of a remote application. + * Gets the ID of the remote application. * * @since 2.0 * - * @return The ID of a remote application + * @return The ID of the remote application */ Tizen::App::AppId GetAppId(void) const; /** - * Checks whether an instance is a trusted message port or not. + * Checks whether an instance is a trusted message port. * * @since 2.0 * @@ -145,36 +144,41 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair @n - * The recommended message size is under 4KB. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The message argument is not a map of key (String) and value (String or ByteBuffer) pair. - * @exception E_OBJ_NOT_FOUND The message port of the target application is not found. - * @exception E_MAX_EXCEEDED The size of @c pMessage has exceeded the maximum limit. - * @exception E_SYSTEM The method has failed due to a severe system error. - * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large messages. E_MAX_EXCEEDED may be returned for messages over 4KB size. + * @return An error code + * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair @n + * The recommended message size is under 4KB. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The message argument is not a map of key (String) and value (String or ByteBuffer) pair. + * @exception E_OBJ_NOT_FOUND The message port of the target application is not found. + * @exception E_MAX_EXCEEDED The size of @c pMessage has exceeded the maximum limit. + * @exception E_SYSTEM The method has failed due to a severe system error. + * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large + * messages. @n + * @c E_MAX_EXCEEDED may be returned for messages over 4KB size. */ result SendMessage(const Tizen::Base::Collection::IMap* pMessage); /** - * Sends a message to the message port of a remote application. This method is used for the bidirectional communication. + * Sends a message to the message port of a remote application. @n + * This method is used for the bidirectional communication. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] pLocalMessagePort The local message port - * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair @n - * The recommended message size is under 4KB. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The local message port is @c null. @n - * - The message argument is not a map of key (String) and value (String or ByteBuffer) pair. - * @exception E_OBJ_NOT_FOUND The message port of the target application is not found. - * @exception E_MAX_EXCEEDED The size of @c pMessage has exceeded the maximum limit. - * @exception E_SYSTEM The method has failed due to a severe system error. - * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large messages. E_MAX_EXCEEDED may be returned for messages over 4KB size. + * @return An error code + * @param[in] pLocalMessagePort The local message port + * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair @n + * The recommended message size is under 4KB. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The local message port is @c null. + * - The message argument is not a map of key (String) and value (String or ByteBuffer) pair. + * @exception E_OBJ_NOT_FOUND The message port of the target application is not found. + * @exception E_MAX_EXCEEDED The size of @c pMessage has exceeded the maximum limit. + * @exception E_SYSTEM The method has failed due to a severe system error. + * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large + * messages. @n + * @c E_MAX_EXCEEDED may be returned for messages over 4KB size. */ result SendMessage(const LocalMessagePort* pLocalMessagePort, const Tizen::Base::Collection::IMap* pMessage);