2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
4 // Licensed under the Apache License, Version 2.0 (the License);
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
8 // http://www.apache.org/licenses/LICENSE-2.0
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
17 * @file FIoIMessagePortListener.h
18 * @brief This is the header file for the %IMessagePortListener interface.
20 * This header file contains declarations of the %IMessagePortListener interface.
23 #ifndef _FIO_IMESSAGE_PORT_LISTENER_H_
24 #define _FIO_IMESSAGE_PORT_LISTENER_H_
26 #include <FBaseTypes.h>
27 #include <FBaseString.h>
28 #include <FBaseColIMap.h>
29 #include <FBaseRtIEventListener.h>
31 namespace Tizen { namespace Io
34 class RemoteMessagePort;
37 * @interface IMessagePortListener
38 * @brief This interface provides event handlers to receive messages from other applications.
42 * The %IMessagePortListener interface provides event handlers to receive messages from other applications.
44 class _OSP_EXPORT_ IMessagePortListener
45 : virtual public Tizen::Base::Runtime::IEventListener
49 * 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.
53 virtual ~IMessagePortListener(void) {}
56 * Called when a message is received from a remote application. @n
57 * 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).
58 * The RemoteMessagePort instance can be used to send a response message to the message port of the remote application.
62 * @param[in] pRemoteMessagePort The message port of a remote application which has sent this message
63 * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair
65 virtual void OnMessageReceivedN(RemoteMessagePort* pRemoteMessagePort, Tizen::Base::Collection::IMap* pMessage) {}
68 * Called when a message is received from a remote application. @n
69 * This method will be called only if the remote application uses unidirectional communication method - RemoteMessagePort::SendMessage(const Tizen::Base::Collection::IMap* pMessage).
73 * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair
75 virtual void OnMessageReceivedN(Tizen::Base::Collection::IMap* pMessage) {}
79 // This method is for internal use only.
80 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
82 // This method is reserved and may change its name at any time without prior notice.
86 virtual void IMessagePortListener_Reserved1(void) {}
89 // This method is for internal use only.
90 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
92 // This method is reserved and may change its name at any time without prior notice.
96 virtual void IMessagePortListener_Reserved2(void) {}
99 // This method is for internal use only.
100 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
102 // This method is reserved and may change its name at any time without prior notice.
106 virtual void IMessagePortListener_Reserved3(void) {}
109 // This method is for internal use only.
110 // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
112 // This method is reserved and may change its name at any time without prior notice.
116 virtual void IMessagePortListener_Reserved4(void) {}
117 }; // IMessagePortListener
121 #endif // _FIO_IMESSAGE_PORT_LISTENER_H_