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