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