Diffstat (limited to 'libopie2/opiebluez/obluetooth.h') (more/less context) (ignore whitespace changes)
-rw-r--r-- | libopie2/opiebluez/obluetooth.h | 40 |
1 files changed, 39 insertions, 1 deletions
diff --git a/libopie2/opiebluez/obluetooth.h b/libopie2/opiebluez/obluetooth.h index 4423a55..ee4a90d 100644 --- a/libopie2/opiebluez/obluetooth.h +++ b/libopie2/opiebluez/obluetooth.h | |||
@@ -16,48 +16,49 @@ | |||
16 | : .. .:, . . . without even the implied warranty of | 16 | : .. .:, . . . without even the implied warranty of |
17 | =_ + =;=|` MERCHANTABILITY or FITNESS FOR A | 17 | =_ + =;=|` MERCHANTABILITY or FITNESS FOR A |
18 | _.=:. : :=>`: PARTICULAR PURPOSE. See the GNU | 18 | _.=:. : :=>`: PARTICULAR PURPOSE. See the GNU |
19 | ..}^=.= = ; Library General Public License for more | 19 | ..}^=.= = ; Library General Public License for more |
20 | ++= -. .` .: details. | 20 | ++= -. .` .: details. |
21 | : = ...= . :.=- | 21 | : = ...= . :.=- |
22 | -. .:....=;==+<; You should have received a copy of the GNU | 22 | -. .:....=;==+<; You should have received a copy of the GNU |
23 | -_. . . )=. = Library General Public License along with | 23 | -_. . . )=. = Library General Public License along with |
24 | -- :-=` this library; see the file COPYING.LIB. | 24 | -- :-=` this library; see the file COPYING.LIB. |
25 | If not, write to the Free Software Foundation, | 25 | If not, write to the Free Software Foundation, |
26 | Inc., 59 Temple Place - Suite 330, | 26 | Inc., 59 Temple Place - Suite 330, |
27 | Boston, MA 02111-1307, USA. | 27 | Boston, MA 02111-1307, USA. |
28 | */ | 28 | */ |
29 | 29 | ||
30 | #ifndef OBLUETOOTH_H | 30 | #ifndef OBLUETOOTH_H |
31 | #define OBLUETOOTH_H | 31 | #define OBLUETOOTH_H |
32 | 32 | ||
33 | #include <qobject.h> | 33 | #include <qobject.h> |
34 | #include <qdict.h> | 34 | #include <qdict.h> |
35 | 35 | ||
36 | namespace Opie { | 36 | namespace Opie { |
37 | namespace Bluez { | 37 | namespace Bluez { |
38 | 38 | ||
39 | class OBluetoothInterface; | 39 | class OBluetoothInterface; |
40 | class OBluetoothDevice; | ||
40 | 41 | ||
41 | /** | 42 | /** |
42 | * @brief A container class for all bluetooth interfaces | 43 | * @brief A container class for all bluetooth interfaces |
43 | * | 44 | * |
44 | * This class provides access to all available bluetooth interfaces of your computer. | 45 | * This class provides access to all available bluetooth interfaces of your computer. |
45 | * | 46 | * |
46 | * @author Michael 'Mickey' Lauer <mickey@vanille.de> | 47 | * @author Michael 'Mickey' Lauer <mickey@vanille.de> |
47 | */ | 48 | */ |
48 | class OBluetooth : public QObject | 49 | class OBluetooth : public QObject |
49 | { | 50 | { |
50 | Q_OBJECT | 51 | Q_OBJECT |
51 | 52 | ||
52 | public: | 53 | public: |
53 | typedef QDict<OBluetoothInterface> InterfaceMap; | 54 | typedef QDict<OBluetoothInterface> InterfaceMap; |
54 | typedef QDictIterator<OBluetoothInterface> InterfaceIterator; | 55 | typedef QDictIterator<OBluetoothInterface> InterfaceIterator; |
55 | 56 | ||
56 | public: | 57 | public: |
57 | /** | 58 | /** |
58 | * @returns the number of available interfaces | 59 | * @returns the number of available interfaces |
59 | */ | 60 | */ |
60 | int count() const; | 61 | int count() const; |
61 | /** | 62 | /** |
62 | * @returns a pointer to the (one and only) @ref OBluetooth instance. | 63 | * @returns a pointer to the (one and only) @ref OBluetooth instance. |
63 | */ | 64 | */ |
@@ -83,67 +84,104 @@ class OBluetooth : public QObject | |||
83 | * @internal Rebuild the internal interface database | 84 | * @internal Rebuild the internal interface database |
84 | * @note Sometimes it might be useful to call this from client code, | 85 | * @note Sometimes it might be useful to call this from client code, |
85 | * e.g. after issuing a cardctl insert | 86 | * e.g. after issuing a cardctl insert |
86 | */ | 87 | */ |
87 | void synchronize(); | 88 | void synchronize(); |
88 | 89 | ||
89 | protected: | 90 | protected: |
90 | OBluetooth(); | 91 | OBluetooth(); |
91 | 92 | ||
92 | private: | 93 | private: |
93 | static OBluetooth* _instance; | 94 | static OBluetooth* _instance; |
94 | InterfaceMap _interfaces; | 95 | InterfaceMap _interfaces; |
95 | class OBluetoothPrivate; | 96 | class OBluetoothPrivate; |
96 | OBluetoothPrivate *d; | 97 | OBluetoothPrivate *d; |
97 | int _fd; | 98 | int _fd; |
98 | }; | 99 | }; |
99 | 100 | ||
100 | /*====================================================================================== | 101 | /*====================================================================================== |
101 | * OBluetoothInterface | 102 | * OBluetoothInterface |
102 | *======================================================================================*/ | 103 | *======================================================================================*/ |
103 | 104 | ||
104 | /** | 105 | /** |
105 | * @brief An bluetooth interface wrapper. | 106 | * @brief An bluetooth interface wrapper. |
106 | * | 107 | * |
107 | * This class provides a wrapper for an infrared interface. All the cumbersome details of | 108 | * This class provides a wrapper for a bluetooth HCI device. All the cumbersome details of |
108 | * Linux ioctls are hidden under a convenient high-level interface. | 109 | * Linux ioctls are hidden under a convenient high-level interface. |
109 | * @warning Most of the setting methods contained in this class require the appropriate | 110 | * @warning Most of the setting methods contained in this class require the appropriate |
110 | * process permissions to work. | 111 | * process permissions to work. |
111 | * | 112 | * |
112 | * @author Michael 'Mickey' Lauer <mickey@vanille.de> | 113 | * @author Michael 'Mickey' Lauer <mickey@vanille.de> |
113 | */ | 114 | */ |
114 | class OBluetoothInterface : public QObject | 115 | class OBluetoothInterface : public QObject |
115 | { | 116 | { |
117 | Q_OBJECT | ||
118 | public: | ||
119 | typedef QDict<OBluetoothDevice> DeviceMap; | ||
120 | typedef QDictIterator<OBluetoothDevice> DeviceIterator; | ||
121 | |||
116 | public: | 122 | public: |
117 | /** | 123 | /** |
118 | * Constructor. Normally you don't create @ref OBluetoothInterface objects yourself, | 124 | * Constructor. Normally you don't create @ref OBluetoothInterface objects yourself, |
119 | * but access them via @ref OBluetooth::interface(). | 125 | * but access them via @ref OBluetooth::interface(). |
120 | */ | 126 | */ |
121 | OBluetoothInterface( QObject* parent, const char* name, void* devinfo, int ctlfd ); | 127 | OBluetoothInterface( QObject* parent, const char* name, void* devinfo, int ctlfd ); |
122 | /** | 128 | /** |
123 | * Destructor. | 129 | * Destructor. |
124 | */ | 130 | */ |
125 | virtual ~OBluetoothInterface(); | 131 | virtual ~OBluetoothInterface(); |
126 | /** | 132 | /** |
127 | * @return the MAC address of the interfaces | 133 | * @return the MAC address of the interfaces |
128 | */ | 134 | */ |
129 | QString macAddress() const; | 135 | QString macAddress() const; |
130 | /** | 136 | /** |
131 | * Setting an interface to up enables it to receive packets. | 137 | * Setting an interface to up enables it to receive packets. |
132 | */ | 138 | */ |
133 | bool setUp( bool ); | 139 | bool setUp( bool ); |
134 | /** | 140 | /** |
135 | * @returns true if the interface is up. | 141 | * @returns true if the interface is up. |
136 | */ | 142 | */ |
137 | bool isUp() const; | 143 | bool isUp() const; |
144 | /** | ||
145 | * @returns an iterator usable for iterating through the devices in range | ||
146 | */ | ||
147 | DeviceIterator neighbourhood(); | ||
138 | 148 | ||
139 | private: | 149 | private: |
150 | DeviceMap _devices; | ||
140 | class Private; | 151 | class Private; |
141 | Private *d; | 152 | Private *d; |
142 | }; | 153 | }; |
143 | 154 | ||
155 | /*====================================================================================== | ||
156 | * OBluetoothDevice | ||
157 | *======================================================================================*/ | ||
158 | |||
159 | /** | ||
160 | * @brief An bluetooth (remote) device abstraction. | ||
161 | * | ||
162 | * This class resembles a (remote) bluetooth device. | ||
163 | * @author Michael 'Mickey' Lauer <mickey@vanille.de> | ||
164 | */ | ||
165 | class OBluetoothDevice : public QObject | ||
166 | { | ||
167 | Q_OBJECT | ||
144 | 168 | ||
169 | public: | ||
170 | /** | ||
171 | * Constructor. | ||
172 | */ | ||
173 | OBluetoothDevice( QObject* parent, const char* name ); | ||
174 | /** | ||
175 | * Destructor. | ||
176 | */ | ||
177 | virtual ~OBluetoothDevice(); | ||
178 | /** | ||
179 | * @returns the MAC address of the device's interface | ||
180 | */ | ||
181 | QString macAddress() const; | ||
182 | }; | ||
145 | 183 | ||
146 | } | 184 | } |
147 | } | 185 | } |
148 | #endif | 186 | #endif |
149 | 187 | ||