src/FNetBt_BluetoothDeviceEvent.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012-2013 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    FNetBt_BluetoothDeviceEvent.h
  19  * @brief   This is the header file for the _BluetoothDeviceEvent class.
  20  *
  21  * This header file contains the declarations of the _BluetoothDeviceEvent class.
  22  * The _BluetoothDeviceEvent class can call a method of a listener (IBluetoothDeviceEventListener object).
  23  * So, when a device event is occurred, listener instances can handle it appropriately.
  24  */
  25 #ifndef _FNET_BT_INTERNAL_BLUETOOTH_DEVICE_EVENT_H_
  26 #define _FNET_BT_INTERNAL_BLUETOOTH_DEVICE_EVENT_H_
  27
  28 #include <FOspConfig.h>
  29 #include <FBaseResult.h>
  30 #include <FBaseRt_Event.h>
  31
  32 // Forward declaration
  33 namespace Tizen { namespace Base { namespace Runtime
  34 {
  35 class IEventListener;
  36 class IEventArg;
  37 } } }
  38
  39 namespace Tizen { namespace Net { namespace Bluetooth
  40 {
  41
  42 //
  43 // @class   _BluetoothDeviceEvent
  44 // @brief   This class handles Bluetooth device events.
  45 //
  46 // When a Bluetooth device event occurs, the _BluetoothDeviceEvent object finds a IBluetoothDeviceEventListener object
  47 // and calls an appropriate method of the listener.
  48 //
  49 class _BluetoothDeviceEvent
  50         : public Tizen::Base::Runtime::_Event
  51 {
  52 public:
  53         /**
  54          * This is the default constructor.
  55          */
  56         _BluetoothDeviceEvent(void);
  57
  58         /**
  59          * This is the class destructor.
  60          */
  61         virtual ~_BluetoothDeviceEvent(void);
  62         result Construct(void);
  63
  64 protected:
  65         /**
  66          * Checks the argument and finds out the type of event. After that, this method calls appropriate pListener's method.
  67          *
  68          * @return      A result code.
  69          * @param[in]   pListener           An event listener related to this Bluetooth device event.
  70          * @param[in]   arg                 An event argument including information to be passed to the event listeners
  71          * @exception   E_SUCCESS           The method is successful.
  72          * @exception   E_INVALID_ARG       The argument passed to a method contains invalid values.
  73          * @exception   E_SYSTEM            A system error occurred.
  74          */
  75         virtual void FireImpl(Tizen::Base::Runtime::IEventListener& listener, const Tizen::Base::Runtime::IEventArg& arg);
  76
  77 private:
  78         _BluetoothDeviceEvent(const _BluetoothDeviceEvent& value);
  79         _BluetoothDeviceEvent& operator =(const _BluetoothDeviceEvent& rhs);
  80
  81 }; // _BluetoothDeviceEvent
  82
  83 } } }
  84 #endif // _FNET_BT_INTERNAL_BLUETOOTH_DEVICE_EVENT_H_