src/FNetBt_BluetoothHealthEvent.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_BluetoothHealthEvent.h
  19  * @brief   This is the header file for the _BluetoothHealthEvent class.
  20  *
  21  * This header file contains the declarations of the _BluetoothHealthEvent class.
  22  * The _BluetoothHealthEvent class can call a method of a listener (_IBluetoothHealthEventListener object).
  23  * So, when a device event is occurred, listener instances can handle it appropriately.
  24  */
  25 #ifndef _FNET_BT_INTERNAL_BLUETOOTH_HEALTH_EVENT_H_
  26 #define _FNET_BT_INTERNAL_BLUETOOTH_HEALTH_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   _BluetoothHealthEvent
  44 // @brief   This class handles Bluetooth Health events.
  45 //
  46 // When a Bluetooth device event occurs, the _BluetoothHealthEvent object finds a _IBluetoothHealthEventListener object
  47 // and calls an appropriate method of the listener.
  48 //
  49 class _BluetoothHealthEvent
  50         : public Tizen::Base::Runtime::_Event
  51 {
  52 public:
  53         /**
  54          * This is the default constructor.
  55          */
  56         _BluetoothHealthEvent(void);
  57
  58         /**
  59          * This is the class destructor.
  60          */
  61         virtual ~_BluetoothHealthEvent(void);
  62
  63         result Construct(void);
  64
  65 protected:
  66         /**
  67          * Checks the argument and finds out the type of event. After that, this method calls appropriate Listener's method.
  68          *
  69          * @return      A result code.
  70          * @param[in]   pListener           An event listener related to this Bluetooth health event.
  71          * @param[in]   arg                 An event argument including information to be passed to the event listeners
  72          * @exception   E_SUCCESS           The method is successful.
  73          * @exception   E_INVALID_ARG       The argument passed to a method contains invalid values.
  74          * @exception   E_SYSTEM            A system error occurred.
  75          */
  76         virtual void FireImpl(Tizen::Base::Runtime::IEventListener& listener, const Tizen::Base::Runtime::IEventArg& arg);
  77
  78 private:
  79         _BluetoothHealthEvent(const _BluetoothHealthEvent& value);
  80         _BluetoothHealthEvent& operator =(const _BluetoothHealthEvent& rhs);
  81
  82 }; // _BluetoothHealthEvent
  83
  84 } } }
  85 #endif // _FNET_BT_INTERNAL_BLUETOOTH_HEALTH_EVENT_H_