//
-// Open Service Platform
// Copyright (c) 2012 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
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
*
*
* @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. @c 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. @c 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);
projects / platform / framework / native / appfw.git / blobdiff