From 41736b0c6fe60f4b057ee253f8ba134e33174b7a Mon Sep 17 00:00:00 2001 From: jusung son Date: Fri, 16 Dec 2016 18:39:25 +0900 Subject: [PATCH] Fix API description Change-Id: I6d2ac814b149197e65280ed8de7131c8c419ed8d Signed-off-by: jusung son --- doc/message-port-doc.h | 8 +- include/message_port.h | 429 ++++++++++++++++++++++++------------------------- 2 files changed, 211 insertions(+), 226 deletions(-) mode change 100644 => 100755 doc/message-port-doc.h mode change 100644 => 100755 include/message_port.h diff --git a/doc/message-port-doc.h b/doc/message-port-doc.h old mode 100644 new mode 100755 index 58bdd09..200db5e --- a/doc/message-port-doc.h +++ b/doc/message-port-doc.h @@ -14,22 +14,24 @@ * limitations under the License. */ + #ifndef __TIZEN_APPFW_MESSAGE_PORT_DOC_H__ #define __TIZEN_APPFW_MESSAGE_PORT_DOC_H__ + /** * @ingroup CAPI_APPLICATION_FRAMEWORK * @defgroup CAPI_MESSAGE_PORT_MODULE Message Port * @brief The @ref CAPI_MESSAGE_PORT_MODULE API provides functions to send and receive messages between applications. - * * @section CAPI_MESSAGE_PORT_MODULE_HEADER Required Header - * \#include + * \#include * * @section CAPI_MESSAGE_PORT_MODULE_OVERVIEW Overview * The @ref CAPI_MESSAGE_PORT_MODULE API provides functions for passing messages between applications. * An application should register its own local port to receive messages from remote applications. * If a remote application sends a message, the registered callback function of the local port is called. @n - * The trusted message-port API allows communications between applications that are signed by the same developer (author) certificate. + * The trusted message-port API allows communications between applications that are signed by the same developer (author) certificate. */ + #endif /* __TIZEN_APPFW_MESSAGE_PORT_DOC_H__ */ diff --git a/include/message_port.h b/include/message_port.h old mode 100644 new mode 100755 index bfaf290..133dd11 --- a/include/message_port.h +++ b/include/message_port.h @@ -18,11 +18,11 @@ #define __TIZEN_APPFW_MESSAGE_PORT_H__ #ifdef __GNUC__ -# ifndef EXPORT_API -# define EXPORT_API __attribute__((visibility("default"))) -# endif +#ifndef EXPORT_API +#define EXPORT_API __attribute__((visibility("default"))) +#endif #else -# define EXPORT_API +#define EXPORT_API #endif #include @@ -38,286 +38,269 @@ extern "C" { * @{ */ + /** * @brief Enumeration for error codes of a message port. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { - MESSAGE_PORT_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ - MESSAGE_PORT_ERROR_IO_ERROR = TIZEN_ERROR_IO_ERROR, /**< Internal I/O error */ - MESSAGE_PORT_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ - MESSAGE_PORT_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ - MESSAGE_PORT_ERROR_PORT_NOT_FOUND = TIZEN_ERROR_MESSAGE_PORT | 0x01, /**< The message port of the remote application is not found */ - MESSAGE_PORT_ERROR_CERTIFICATE_NOT_MATCH = TIZEN_ERROR_MESSAGE_PORT | 0x02, /**< The remote application is not signed with the same certificate */ - MESSAGE_PORT_ERROR_MAX_EXCEEDED = TIZEN_ERROR_MESSAGE_PORT | 0x03, /**< The size of the message has exceeded the maximum limit */ - MESSAGE_PORT_ERROR_RESOURCE_UNAVAILABLE = TIZEN_ERROR_MESSAGE_PORT | 0x04 /**< Resource is temporarily unavailable */ + MESSAGE_PORT_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ + MESSAGE_PORT_ERROR_IO_ERROR = TIZEN_ERROR_IO_ERROR, /**< Internal I/O error */ + MESSAGE_PORT_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */ + MESSAGE_PORT_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ + MESSAGE_PORT_ERROR_PORT_NOT_FOUND = TIZEN_ERROR_MESSAGE_PORT | 0x01, /**< The message port of the remote application is not found */ + MESSAGE_PORT_ERROR_CERTIFICATE_NOT_MATCH = TIZEN_ERROR_MESSAGE_PORT | 0x02, /**< The remote application is not signed with the same certificate */ + MESSAGE_PORT_ERROR_MAX_EXCEEDED = TIZEN_ERROR_MESSAGE_PORT | 0x03, /**< The size of the message has exceeded the maximum limit */ + MESSAGE_PORT_ERROR_RESOURCE_UNAVAILABLE = TIZEN_ERROR_MESSAGE_PORT | 0x04 /**< Resource is temporarily unavailable */ } message_port_error_e; + /** * @brief Called when a message is received. * @details The function is called when a message is received from the remote application. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * - * @remarks @a message is automatically freed by framework when callback returned, you can keep @a message using bundle_dup(). @n - * @a remote_port will be set only if the remote application sends a message with its port information using message_port_send_message_with_local_port(), otherwise it is @c NULL. @n - * When message is sent from remote application by message_port_send_message_with_local_port() in bidirectional communication, trusted_remote_port is used to check whether remote port is trusted port or not. - * This callback is called only in the main thread. - * - * @param[in] local_port_id The local message port ID returned by message_port_register_local_port() - * @param[in] remote_app_id The ID of the remote application that sent this message - * @param[in] remote_port The name of the remote message port - * @param[in] trusted_remote_port If @c true the remote port is a trusted port, otherwise if @c false it is not - * @param[in] message The message passed from the remote application - * @param[in] user_data The user data passed from the register function - * @pre Either message_port_send_message() or message_port_send_message_with_local_port() from the remote application will invoke this function if you register it using message_port_register_local_port(). - * @see message_port_register_local_port() - * @see message_port_unregister_local_port() - * @see message_port_send_message() - * @see message_port_send_message_with_local_port() + * @remarks @a message is automatically freed by framework when callback returned, you can keep @a message using bundle_dup() @n + * @a remote_port will be set only if the remote application sends a message with its port information using message_port_send_message_with_local_port(), otherwise it is @c NULL @n + * When message is sent from remote application by message_port_send_message_with_local_port() in bidirectional communication, trusted_remote_port is used to check whether remote port is trusted port or not + * This callback is called only in the main thread. + * @param[in] local_port_id The local message port ID returned by message_port_register_local_port() + * @param[in] remote_app_id The ID of the remote application that sent this message + * @param[in] remote_port The name of the remote message port + * @param[in] trusted_remote_port If @c true, the remote port is a trusted port; otherwise if @c false, it is not + * @param[in] message The message passed from the remote application + * @param[in] user_data The user data passed from the register function + * @pre Either message_port_send_message() or message_port_send_message_with_local_port() from the remote application will invoke this function if you register it using message_port_register_local_port() + * @see message_port_register_local_port() + * @see message_port_unregister_local_port() + * @see message_port_send_message() + * @see message_port_send_message_with_local_port() */ typedef void (*message_port_message_cb)(int local_port_id, const char *remote_app_id, const char *remote_port, bool trusted_remote_port, bundle *message, void *user_data); + /** * @brief Called when a trusted message is received. * @details This function is called when a trusted message is received from the remote application. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * - * @remarks You can keep @a message using bundle_dup(). @n - * @a remote_port will be set only if the remote application sends a message with its port information using message_port_send_trusted_message_with_local_port(), otherwise it is @c NULL. @n - * When message is sent from remote application by message_port_send_trusted_message_with_local_port() in bidirectional communication, trusted_remote_port is used to check whether remote port is trusted port or not. - * This callback is called only in the main thread. - * @param[in] trusted_local_port_id The message port ID returned by message_port_register_trusted_local_port() - * @param[in] remote_app_id The ID of the remote application that sent this message - * @param[in] remote_port The name of the remote message port - * @param[in] trusted_remote_port If @c true the remote port is a trusted port, otherwise if @c false it is not - * @param[in] message The message passed from the remote application - * @param[in] user_data The user data passed from the register function - * @pre Either message_port_send_trusted_message() or message_port_send_trusted_message_with_local_port() from the remote application will invoke this function if you register it using message_port_register_trusted_local_port(). - * @see message_port_register_trusted_local_port() - * @see message_port_unregister_trusted_local_port() - * @see message_port_send_trusted_message() - * @see message_port_send_trusted_message_with_local_port() + * @remarks You can keep @a message using bundle_dup(). @n + * @a remote_port will be set only if the remote application sends a message with its port information using message_port_send_trusted_message_with_local_port(), otherwise it is @c NULL. @n + * When message is sent from remote application by message_port_send_trusted_message_with_local_port() in bidirectional communication, trusted_remote_port is used to check whether remote port is trusted port or not. + * This callback is called only in the main thread. + * @param[in] trusted_local_port_id The message port ID returned by message_port_register_trusted_local_port() + * @param[in] remote_app_id The ID of the remote application that sent this message + * @param[in] remote_port The name of the remote message port + * @param[in] trusted_remote_port If @c true, the remote port is a trusted port; otherwise if @c false, it is not + * @param[in] message The message passed from the remote application + * @param[in] user_data The user data passed from the register function + * @pre Either message_port_send_trusted_message() or message_port_send_trusted_message_with_local_port() from the remote application will invoke this function if you register it using message_port_register_trusted_local_port(). + * @see message_port_register_trusted_local_port() + * @see message_port_unregister_trusted_local_port() + * @see message_port_send_trusted_message() + * @see message_port_send_trusted_message_with_local_port() */ typedef void (*message_port_trusted_message_cb)(int trusted_local_port_id, const char *remote_app_id, const char *remote_port, bool trusted_remote_port, bundle *message, void *user_data); + /** * @brief Registers the local message port. * @details If the message port name is already registered, the previous local message port ID returns and the callback function is changed. \n * Multiple message ports can be registered. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * - * @remarks The specified callback is called only in the main thread. - * @param[in] local_port The name of the local message port - * @param[in] callback The callback function to be called when a message is received - * @param[in] user_data The user data to be passed to the callback function - * - * @return A local message port ID on success, - * otherwise a negative error value - * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a local_port or @a callback is NULL - * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error - * @see message_port_unregister_local_port() + * @remarks The specified callback is called only in the main thread. + * @param[in] local_port The name of the local message port + * @param[in] callback The callback function to be called when a message is received + * @param[in] user_data The user data to be passed to the callback function + * @return A local message port ID on success, + * otherwise a negative error value + * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a local_port or @a callback is NULL + * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory + * @retval MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error + * @see message_port_unregister_local_port() */ EXPORT_API int message_port_register_local_port(const char *local_port, message_port_message_cb callback, void *user_data); + /** - * @brief Registers the trusted local message port. - * @details If the message port name is already registered, the previous local message port ID returns and the callback function is changed. @n - * It allows communications only if the applications are signed with the same certificate which is uniquely assigned to the developer. @n - * Multiple message ports can be registered. - * + * @brief Registers the trusted local message port. + * @details If the message port name is already registered, the previous local message port ID returns and the callback function is changed. @n + * It allows communications only if the applications are signed with the same certificate, which is uniquely assigned to the developer. @n + * Multiple message ports can be registered. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * - * @remarks The specified callback is called only in the main thread. - * @param[in] trusted_local_port The name of the trusted local message port - * @param[in] callback The callback function to be called when a trusted message is received - * @param[in] user_data The user data to be passed to the callback function - * @return A trusted local message port ID on success, - * otherwise a negative error value - * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a trusted_local_port or @a callback is NULL - * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error - * @see message_port_unregister_trusted_local_port() + * @remarks The specified callback is called only in the main thread. + * @param[in] trusted_local_port The name of the trusted local message port + * @param[in] callback The callback function to be called when a trusted message is received + * @param[in] user_data The user data to be passed to the callback function + * @return A trusted local message port ID on success, + * otherwise a negative error value + * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a trusted_local_port or @a callback is NULL + * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error + * @see message_port_unregister_trusted_local_port() */ EXPORT_API int message_port_register_trusted_local_port(const char *trusted_local_port, message_port_trusted_message_cb callback, void *user_data); + /** * @brief Unregisters the local message port. * @details This method unregisters the callback function with the specified local port ID. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * - * @param[in] local_port_id The local message port ID - * @return 0 on success, - * otherwise a negative error value - * @retval #MESSAGE_PORT_ERROR_NONE Successful - * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a local_port_id is not positive - * @retval #MESSAGE_PORT_ERROR_PORT_NOT_FOUND The specified @a local_port_id cannot be found - * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error - * @see message_port_register_local_port() + * @param[in] local_port_id The local message port ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MESSAGE_PORT_ERROR_NONE Successful + * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a local_port_id is not positive + * @retval #MESSAGE_PORT_ERROR_PORT_NOT_FOUND The specified @a local_port_id cannot be found + * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error + * @see message_port_register_local_port() */ EXPORT_API int message_port_unregister_local_port(int local_port_id); + /** - * @brief Registers the trusted local message port. - * @details This method unregisters the callback function with the specified local port ID. @n - * It allows communications only if the applications are signed with the same certificate which is uniquely assigned to the developer. - * + * @brief Registers the trusted local message port. + * @details This method unregisters the callback function with the specified local port ID. @n + * It allows communications only if the applications are signed with the same certificate, which is uniquely assigned to the developer. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * - * @param[in] trusted_local_port_id The trusted local message port ID - * @return @c 0 on success, - * otherwise a negative error value - * @retval #MESSAGE_PORT_ERROR_NONE Successful - * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a trusted_local_port_id is not positive - * @retval #MESSAGE_PORT_ERROR_PORT_NOT_FOUND The specified @a trusted_local_port_id cannot be found - * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error - * @see message_port_register_trusted_local_port() + * @param[in] trusted_local_port_id The trusted local message port ID + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MESSAGE_PORT_ERROR_NONE Successful + * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a trusted_local_port_id is not positive + * @retval #MESSAGE_PORT_ERROR_PORT_NOT_FOUND The specified @a trusted_local_port_id cannot be found + * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error + * @see message_port_register_trusted_local_port() */ EXPORT_API int message_port_unregister_trusted_local_port(int trusted_local_port_id); + /** * @brief Checks whether the message port of a remote application is registered. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * - * @remarks If this function returns a negative error value, the out parameter @a exist will not be changed. - * @param[in] remote_app_id The ID of the remote application - * @param[in] remote_port The name of the remote message port - * @param[out] exist If @c true the message port of the remote application exists, - * otherwise @c false - * @return @c 0 on success, - * otherwise a negative error value - * @retval #MESSAGE_PORT_ERROR_NONE Successful - * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a remote_app_id or @a remote_port is NULL - * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error + * @remarks If this function returns a negative error value, the out parameter @a exist will not be changed. + * @param[in] remote_app_id The ID of the remote application + * @param[in] remote_port The name of the remote message port + * @param[out] exist If @c true, the message port of the remote application exists; + * otherwise @c false + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MESSAGE_PORT_ERROR_NONE Successful + * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a remote_app_id or @a remote_port is NULL + * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error */ EXPORT_API int message_port_check_remote_port(const char *remote_app_id, const char *remote_port, bool *exist); + /** * @brief Checks whether the trusted message port of a remote application is registered. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * - * @remarks If this function returns a negative error value, the out parameter @a exist will not be changed. - * @param[in] remote_app_id The ID of the remote application - * @param[in] remote_port The name of the remote message port - * @param[out] exist If @c true the message port of the remote application exists, - * otherwise @c false - * @return @c 0 on success, - * otherwise a negative error value - * @retval #MESSAGE_PORT_ERROR_NONE Successful - * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a remote_app_id or @a remote_port is @c NULL - * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MESSAGE_PORT_ERROR_CERTIFICATE_NOT_MATCH The remote application is not signed with the same certificate - * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error + * @remarks If this function returns a negative error value, the out parameter @a exist will not be changed. + * @param[in] remote_app_id The ID of the remote application + * @param[in] remote_port The name of the remote message port + * @param[out] exist If @c true, the message port of the remote application exists; + * otherwise @c false + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MESSAGE_PORT_ERROR_NONE Successful + * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a remote_app_id or @a remote_port is @c NULL + * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MESSAGE_PORT_ERROR_CERTIFICATE_NOT_MATCH The remote application is not signed with the same certificate + * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error */ EXPORT_API int message_port_check_trusted_remote_port(const char *remote_app_id, const char *remote_port, bool *exist); + /** * @brief Sends a message to the message port of a remote application. - * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * - * @remarks @a message must be released with bundle_free() after sending the message. - * @param[in] remote_app_id The ID of the remote application - * @param[in] remote_port The name of the remote message port - * @param[in] message The message to be passed to the remote application, the recommended message size is under 4KB - * @return 0 on success, otherwise a negative error value - * @retval #MESSAGE_PORT_ERROR_NONE Successful - * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a remote_app_id, @a remote_port or @a message is NULL - * @retval #MESSAGE_PORT_ERROR_PORT_NOT_FOUND The message port of the remote application cannot be found - * @retval #MESSAGE_PORT_ERROR_MAX_EXCEEDED The size of message has exceeded the maximum limit - * @retval #MESSAGE_PORT_ERROR_RESOURCE_UNAVAILABLE Resource temporarily unavailable - * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error - * @post It invokes message_port_message_cb() on the remote application. - * @see message_port_message_cb() - * @see message_port_register_local_port() - * @see message_port_unregister_local_port() + * @remarks @a message must be released with bundle_free() after sending the message. + * @param[in] remote_app_id The ID of the remote application + * @param[in] remote_port The name of the remote message port + * @param[in] message The message to be passed to the remote application, the recommended message size is under 4KB + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MESSAGE_PORT_ERROR_NONE Successful + * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a remote_app_id, @a remote_port or @a message is NULL + * @retval #MESSAGE_PORT_ERROR_PORT_NOT_FOUND The message port of the remote application cannot be found + * @retval #MESSAGE_PORT_ERROR_MAX_EXCEEDED The size of message has exceeded the maximum limit + * @retval #MESSAGE_PORT_ERROR_RESOURCE_UNAVAILABLE Resource temporarily unavailable + * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error + * @post It invokes message_port_message_cb() on the remote application. + * @see message_port_message_cb() + * @see message_port_register_local_port() + * @see message_port_unregister_local_port() * * @code * #include - * * bundle *b = bundle_create(); * bundle_add(b, "key1", "value1"); * bundle_add(b, "key2", "value2"); - * * int ret = message_port_send_message("0123456789.BasicApp", "BasicAppPort", b); - * * bundle_free(b); * @endcode */ EXPORT_API int message_port_send_message(const char *remote_app_id, const char *remote_port, bundle *message); + /** * @brief Sends a trusted message to the message port of a remote application. - * @details This method allows communication only if the applications are signed with the same certificate which is uniquely assigned to the developer. - * + * @details This method allows communication only if the applications are signed with the same certificate, which is uniquely assigned to the developer. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * - * @remarks You must release @a message using bundle_free() after sending the message. - * @param[in] remote_app_id The ID of the remote application - * @param[in] remote_port The name of the remote message port - * @param[in] message The message to be passed to the remote application, the recommended message size is under 4KB - * @return 0 on success, - * otherwise a negative error value - * @retval #MESSAGE_PORT_ERROR_NONE Successful - * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a remote_app_id, @a remote_port or @a message is @c NULL - * @retval #MESSAGE_PORT_ERROR_PORT_NOT_FOUND The message port of the remote application cannot be found - * @retval #MESSAGE_PORT_ERROR_CERTIFICATE_NOT_MATCH The remote application is not signed with the same certificate - * @retval #MESSAGE_PORT_ERROR_MAX_EXCEEDED The size of the message has exceeded the maximum limit - * @retval #MESSAGE_PORT_ERROR_RESOURCE_UNAVAILABLE Resource is temporarily unavailable - * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error - * @post It invokes message_port_trusted_message_cb() on the remote application. - * @see message_port_trusted_message_cb() - * @see message_port_register_trusted_local_port() - * @see message_port_unregister_trusted_local_port() + * @remarks You must release @a message using bundle_free() after sending the message. + * @param[in] remote_app_id The ID of the remote application + * @param[in] remote_port The name of the remote message port + * @param[in] message The message to be passed to the remote application, the recommended message size is under 4KB + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MESSAGE_PORT_ERROR_NONE Successful + * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a remote_app_id, @a remote_port or @a message is @c NULL + * @retval #MESSAGE_PORT_ERROR_PORT_NOT_FOUND The message port of the remote application cannot be found + * @retval #MESSAGE_PORT_ERROR_CERTIFICATE_NOT_MATCH The remote application is not signed with the same certificate + * @retval #MESSAGE_PORT_ERROR_MAX_EXCEEDED The size of the message has exceeded the maximum limit + * @retval #MESSAGE_PORT_ERROR_RESOURCE_UNAVAILABLE Resource is temporarily unavailable + * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error + * @post It invokes message_port_trusted_message_cb() on the remote application. + * @see message_port_trusted_message_cb() + * @see message_port_register_trusted_local_port() + * @see message_port_unregister_trusted_local_port() */ EXPORT_API int message_port_send_trusted_message(const char *remote_app_id, const char *remote_port, bundle *message); + /** - * @brief Sends a message with local port information to the message port of a remote application. - * @details This method is used for bidirectional communication. - * + * @brief Sends a message with local port information to the message port of a remote application. + * @details This method is used for bidirectional communication. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * - * @remarks You must releas @a message using bundle_free() after sending the message. - * @param[in] remote_app_id The ID of the remote application - * @param[in] remote_port The name of the remote message port - * @param[in] message The message to be passed to the remote application, the recommended message size is under 4KB - * @param[in] local_port_id The message port ID returned by message_port_register_local_port() or message_port_register_trusted_local_port() - * @return @c 0 on success, - * otherwise a negative error value - * @retval #MESSAGE_PORT_ERROR_NONE Successful - * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a remote_app_id, @a remote_port or @a message is @c NULL and - The specified @a local_port_id is not positive - * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MESSAGE_PORT_ERROR_PORT_NOT_FOUND The port of the local or remote application cannot be found - * @retval #MESSAGE_PORT_ERROR_MAX_EXCEEDED The size of the message has exceeded the maximum limit - * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error - * @post It invokes message_port_message_cb() on the remote application. - * @see message_port_message_cb() - * @see message_port_register_local_port() - * @see message_port_unregister_local_port() + * @remarks You must releas @a message using bundle_free() after sending the message. + * @param[in] remote_app_id The ID of the remote application + * @param[in] remote_port The name of the remote message port + * @param[in] message The message to be passed to the remote application, the recommended message size is under 4KB + * @param[in] local_port_id The message port ID returned by message_port_register_local_port() or message_port_register_trusted_local_port() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MESSAGE_PORT_ERROR_NONE Successful + * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a remote_app_id, @a remote_port or @a message is @c NULL and + * The specified @a local_port_id is not positive + * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MESSAGE_PORT_ERROR_PORT_NOT_FOUND The port of the local or remote application cannot be found + * @retval #MESSAGE_PORT_ERROR_MAX_EXCEEDED The size of the message has exceeded the maximum limit + * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error + * @post It invokes message_port_message_cb() on the remote application. + * @see message_port_message_cb() + * @see message_port_register_local_port() + * @see message_port_unregister_local_port() * * @code * #include * - * static void - * message_port_receive_cb(int local_port_id, const char *remote_app_id, const char *remote_port, bundle *message) - * { - * } + * static void message_port_receive_cb(int local_port_id, const char *remote_app_id, const char *remote_port, bundle *message) {} * - * int main(int argc, char *argv[]) + * int + * main(int argc, char *argv[]) * { * bundle *b = bundle_create(); * bundle_add(b, "key1", "value1"); @@ -329,39 +312,39 @@ EXPORT_API int message_port_send_trusted_message(const char *remote_app_id, cons * * bundle_free(b); * } - * @endcode + * @endcode */ EXPORT_API int message_port_send_message_with_local_port(const char *remote_app_id, const char *remote_port, bundle *message, int local_port_id); + /** - * @brief Sends a trusted message with local port information to the message port of a remote application. - * @details This method is used for bidirectional communication. @n - * It allows communications only if the applications are signed with the same certificate which is uniquely assigned to the developer. - * + * @brief Sends a trusted message with local port information to the message port of a remote application. + * @details This method is used for bidirectional communication. @n + * It allows communications only if the applications are signed with the same certificate, which is uniquely assigned to the developer. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * - * @remarks You muse release @a message using bundle_free() after sending the message. - * @param[in] remote_app_id The ID of the remote application - * @param[in] remote_port The name of the remote message port - * @param[in] message The message to be passed to the remote application, the recommended message size is under 4KB - * @param[in] local_port_id The message port ID returned by message_port_register_local_port() or message_port_register_trusted_local_port() - * @return 0 on success, - * otherwise a negative error value - * @retval #MESSAGE_PORT_ERROR_NONE Successful - * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a remote_app_id, @a remote_port or @a message is @c NULL and - specified @a local_port_id is not positive - * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory - * @retval #MESSAGE_PORT_ERROR_PORT_NOT_FOUND The port of the local or remote application cannot be found. - * @retval #MESSAGE_PORT_ERROR_CERTIFICATE_NOT_MATCH The remote application is not signed with the same certificate. - * @retval #MESSAGE_PORT_ERROR_MAX_EXCEEDED The size of the message has exceeded the maximum limit. - * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error - * @post It invokes message_port_trusted_message_cb() on the remote application. - * @see message_port_trusted_message_cb() - * @see message_port_register_trusted_local_port() - * @see message_port_unregister_trusted_local_port() + * @remarks You muse release @a message using bundle_free() after sending the message. + * @param[in] remote_app_id The ID of the remote application + * @param[in] remote_port The name of the remote message port + * @param[in] message The message to be passed to the remote application, the recommended message size is under 4KB + * @param[in] local_port_id The message port ID returned by message_port_register_local_port() or message_port_register_trusted_local_port() + * @return @c 0 on success, + * otherwise a negative error value + * @retval #MESSAGE_PORT_ERROR_NONE Successful + * @retval #MESSAGE_PORT_ERROR_INVALID_PARAMETER The specified @a remote_app_id, @a remote_port or @a message is @c NULL and + * specified @a local_port_id is not positive + * @retval #MESSAGE_PORT_ERROR_OUT_OF_MEMORY Out of memory + * @retval #MESSAGE_PORT_ERROR_PORT_NOT_FOUND The port of the local or remote application cannot be found + * @retval #MESSAGE_PORT_ERROR_CERTIFICATE_NOT_MATCH The remote application is not signed with the same certificate + * @retval #MESSAGE_PORT_ERROR_MAX_EXCEEDED The size of the message has exceeded the maximum limit + * @retval #MESSAGE_PORT_ERROR_IO_ERROR Internal I/O error + * @post It invokes message_port_trusted_message_cb() on the remote application. + * @see message_port_trusted_message_cb() + * @see message_port_register_trusted_local_port() + * @see message_port_unregister_trusted_local_port() */ EXPORT_API int message_port_send_trusted_message_with_local_port(const char *remote_app_id, const char *remote_port, bundle *message, int local_port_id); + /** * @} */ -- 2.7.4