src/io/inc/FIoIChannelEventListener.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                FIoIChannelEventListener.h
  18  * @brief               This is the header file for the %IChannelEventListener interface.
  19  *
  20  * This header file contains the declarations of the %IChannelEventListener interface. @n
  21  * If the channel event is generated, a method of this interface will be called.
  22  * So, if the application performs jobs related to the channel event, use methods that belong to this class.
  23  *
  24  */
  25 #ifndef _FIO_ICHANNEL_EVENT_LISTENER_H_
  26 #define _FIO_ICHANNEL_EVENT_LISTENER_H_
  27
  28 #include <FBase.h>
  29 #include <FBaseRtIEventListener.h>
  30 #include <FIoChannelTypes.h>
  31 #include <FAppTypes.h>
  32
  33 namespace Tizen { namespace Io
  34 {
  35
  36 /**
  37 * @interface IChannelEventListener
  38 * @brief    This interface provides event handlers for the channel creation and deletion.
  39 *
  40 * @since    2.0
  41 *
  42 * The %IChannelEventListener interface provides event handlers for receiving the channel events.
  43 *
  44 */
  45 class IChannelEventListener
  46         : virtual public Tizen::Base::Runtime::IEventListener
  47 {
  48 public:
  49         /**
  50          * This is the destructor for this class.
  51          *
  52          * @since   2.0
  53          */
  54         virtual ~IChannelEventListener(void) {}
  55
  56         /**
  57          * Called when an application creates the channel.
  58          *
  59          * @since 2.0
  60          *
  61          * @param[in] appId  The application ID that creates the channel
  62          * @param[in] type   The type of the channel
  63          *
  64          */
  65         virtual void OnChannelCreated(const Tizen::App::AppId& appId, ChannelType type){}
  66
  67         /**
  68         * Called when an application deletes the channel.
  69         *
  70         * @since 2.0
  71         *
  72         * @param[in] appId  The application ID that deletes the channel
  73         * @param[in] type   The type of the channel
  74         *
  75         */
  76         virtual void OnChannelDeleted(const Tizen::App::AppId& appId, ChannelType type){}
  77
  78
  79 protected:
  80         //
  81         // This method is for internal use only.
  82         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  83         //
  84         // This method is reserved and may change its name at any time without prior notice.
  85         //
  86         // @since           2.0
  87         //
  88         virtual void IChannelEventListener_Reserved1(void) {}
  89
  90         //
  91         // This method is for internal use only.
  92         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
  93         //
  94         // This method is reserved and may change its name at any time without prior notice.
  95         //
  96         // @since           2.0
  97         //
  98         virtual void IChannelEventListener_Reserved2(void) {}
  99
 100         //
 101         // This method is for internal use only.
 102         // Using this method can cause behavioral, security-related, and consistency-related issues in the application.
 103         //
 104         // This method is reserved and may change its name at any time without prior notice.
 105         //
 106         // @since           2.0
 107         //
 108         virtual void IChannelEventListener_Reserved3(void) {}
 109 };
 110
 111 } } // Tizen::Io
 112
 113 #endif // _FIO_ICHANNEL_EVENT_LISTENER_H_
 114