2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
18 * @file FIoIMessagePortListener.h
19 * @brief This is the header file for the %IMessagePortListener interface.
21 * This header file contains declarations of the %IMessagePortListener interface.
24 #ifndef _FIO_IMESSAGE_PORT_LISTENER_H_
25 #define _FIO_IMESSAGE_PORT_LISTENER_H_
27 #include <FBaseTypes.h>
28 #include <FBaseString.h>
29 #include <FBaseColIMap.h>
30 #include <FBaseRtIEventListener.h>
32 namespace Tizen { namespace Io
35 class RemoteMessagePort;
38 * @interface IMessagePortListener
39 * @brief This interface provides event handlers to receive messages from other applications.
43 * The %IMessagePortListener interface provides event handlers to receive messages from other applications.
45 class _OSP_EXPORT_ IMessagePortListener
46 : virtual public Tizen::Base::Runtime::IEventListener
50 * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
54 virtual ~IMessagePortListener(void) {}
57 * Called when a message is received from a remote application. @n
58 * This method will be called only if the remote application uses bidirectional communication method - RemoteMessagePort::SendMessage(const LocalMessagePort* pLocalMessagePort, const Tizen::Base::Collection::IMap* pMessagee).
59 * The RemoteMessagePort instance can be used to send a response message to the message port of the remote application.
63 * @param[in] pRemoteMessagePort The message port of a remote application which has sent this message
64 * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair
66 virtual void OnMessageReceivedN(RemoteMessagePort* pRemoteMessagePort, Tizen::Base::Collection::IMap* pMessage) {}
69 * Called when a message is received from a remote application. @n
70 * This method will be called only if the remote application uses unidirectional communication method - RemoteMessagePort::SendMessage(const Tizen::Base::Collection::IMap* pMessage).
74 * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair
76 virtual void OnMessageReceivedN(Tizen::Base::Collection::IMap* pMessage) {}
80 // This method is for internal use only.
81 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
83 // This method is reserved and may change its name at any time without prior notice.
87 virtual void IMessagePortListener_Reserved1(void) {}
90 // This method is for internal use only.
91 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
93 // This method is reserved and may change its name at any time without prior notice.
97 virtual void IMessagePortListener_Reserved2(void) {}
100 // This method is for internal use only.
101 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
103 // This method is reserved and may change its name at any time without prior notice.
107 virtual void IMessagePortListener_Reserved3(void) {}
110 // This method is for internal use only.
111 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
113 // This method is reserved and may change its name at any time without prior notice.
117 virtual void IMessagePortListener_Reserved4(void) {}
118 }; // IMessagePortListener
122 #endif // _FIO_IMESSAGE_PORT_LISTENER_H_