inc/FIoIChannelRequestEventListener.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4 //
   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
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  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.
  16 //
  17 /**
  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  */
  23
  24 #ifndef _FIO_ICHANNEL_REQUESTEVENT_LISTENER_H_
  25 #define _FIO_ICHANNEL_REQUESTEVENT_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 ServerChannel;
  37
  38 /**
  39 * @if OSPDEPREC
  40 * @interface IChannelRequestEventListener
  41 * @brief    <i> [Deprecated] </i> This interface provides event handlers for any request events received through a channel.
  42 *
  43 * @deprecated   This interface is deprecated. Instead of using this interface, use the IMessagePortListener interface.
  44 * @since    2.0
  45 *
  46 * The %IChannelRequestEventListener interface provides event handlers to receive channel request event.
  47 * @endif
  48 */
  49 class _OSP_EXPORT_ IChannelRequestEventListener
  50         : virtual public Tizen::Base::Runtime::IEventListener
  51 {
  52 public:
  53         /**
  54          * 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.
  55          *
  56          * @since   2.0
  57          */
  58         virtual ~IChannelRequestEventListener(void) {}
  59
  60         /**
  61          * Called when a request is received from the client channel.
  62          *
  63          * @since        2.0
  64          *
  65          * @param[in] reqId               The request ID
  66          * @param[in] serverChannel       The reference to the server channel
  67          * @param[in] clientChannelId     The client channel ID
  68          * @param[in] pArgs               A pointer to an argument list of type String
  69          */
  70         virtual void OnChannelRequestReceivedN(RequestId reqId, ServerChannel& serverChannel, const Tizen::Base::String& clientChannelId, Tizen::Base::Collection::IList* pArgs) = 0;
  71
  72
  73 protected:
  74         //
  75         // This method is for internal use only.
  76         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  77         //
  78         // This method is reserved and may change its name at any time without prior notice.
  79         //
  80         // @since           2.0
  81         //
  82         virtual void IChannelRequestEventListener_Reserved1(void) {}
  83
  84         //
  85         // This method is for internal use only.
  86         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  87         //
  88         // This method is reserved and may change its name at any time without prior notice.
  89         //
  90         // @since           2.0
  91         //
  92         virtual void IChannelRequestEventListener_Reserved2(void) {}
  93 }; // IChannelRequestEventListener
  94
  95 } } // Tizen::Io
  96
  97 #endif // _FIO_ICHANNEL_REQUESTEVENT_LISTENER_H_