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