inc/FIoIChannelResponseEventListener.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   3 //
   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
   7 //
   8 //     http://www.apache.org/licenses/LICENSE-2.0
   9 //
  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.
  15 //
  16 /**
  17  * @if OSPDEPREC
  18  * @file                FIoIChannelResponseEventListener.h
  19  * @brief               This is the header file for the %IChannelResponseEventListener interface.
  20  *
  21  * This header file contains the declarations of the %IChannelResponseEventListener interface.
  22  * @endif
  23  */
  24 #ifndef _FIO_ICHANNEL_RESPONSEEVENT_LISTENER_H_
  25 #define _FIO_ICHANNEL_RESPONSEEVENT_LISTENER_H_
  26
  27 #include <FBaseTypes.h>
  28 #include <FBaseDataType.h>
  29 #include <FBaseRtIEventListener.h>
  30 #include <FBase.h>
  31 #include <FAppTypes.h>
  32
  33 namespace Tizen { namespace Io
  34 {
  35
  36 class ClientChannel;
  37 /**
  38 * @if OSPDEPREC
  39 * @interface IChannelResponseEventListener
  40 * @brief    <i> [Deprecated] </i> This interface provides event handlers for any response events received through a channel.
  41 *
  42 * @deprecated   This interface is deprecated. Instead of using this interface, use the MessagePortManager class.
  43 * @since    2.0
  44 *
  45 *  The %IChannelResponseEventListener interface provides event handlers for receiving the channel response events.
  46 * @endif
  47 */
  48 class _OSP_EXPORT_ IChannelResponseEventListener
  49         : virtual public Tizen::Base::Runtime::IEventListener
  50 {
  51 public:
  52         /**
  53          * This polymorphic destructor should be overridden if required. @n
  54          * This way, the destructors of the derived classes are called when the destructor of this interface is called.
  55          *
  56          * @since   2.0
  57          */
  58         virtual ~IChannelResponseEventListener(void) {}
  59
  60         /**
  61      * Called when a response is received from a server channel.
  62          *
  63          * @since        2.0
  64          *
  65          * @param[in] reqId                             The request ID
  66          * @param[in] clientChannel             The reference to the client channel
  67          * @param[in] serverChannelId   The server channel ID
  68          * @param[in] pArgs             A pointer to an argument list of type String
  69          *
  70          */
  71         virtual void OnChannelResponseReceivedN(RequestId reqId, ClientChannel& clientChannel, const Tizen::Base::String& serverChannelId, Tizen::Base::Collection::IList* pArgs) = 0;
  72
  73
  74 protected:
  75         //
  76         // This method is for internal use only.
  77         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  78         //
  79         // This method is reserved and may change its name at any time without prior notice.
  80         //
  81         // @since           2.0
  82         //
  83         virtual void IChannelResponseEventListener_Reserved2(void) {}
  84
  85         //
  86         // This method is for internal use only.
  87         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  88         //
  89         // This method is reserved and may change its name at any time without prior notice.
  90         //
  91         // @since           2.0
  92         //
  93         virtual void IChannelResponseEventListener_Reserved3(void) {}
  94 }; // IChannelResponseEventListener
  95
  96 } } // Tizen::Io
  97
  98 #endif // _FIO_ICHANNEL_RESPONSEEVENT_LISTENER_H_