1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
|
//
// Open Service Platform
// Copyright (c) 2012-2013 Samsung Electronics Co., Ltd.
//
// Licensed under the Apache License, Version 2.0 (the License);
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
/**
* @file FNetBtBluetoothOppServer.h
* @brief This is the header file for the %BluetoothOppServer class.
*
* This header file contains the declarations of the %BluetoothOppServer class.
*/
#ifndef _FNET_BT_BLUETOOTH_OPP_SERVER_H_
#define _FNET_BT_BLUETOOTH_OPP_SERVER_H_
#include <FBaseObject.h>
#include <FBaseResult.h>
namespace Tizen { namespace Base
{
class String;
} }
namespace Tizen { namespace Net { namespace Bluetooth
{
// forward declarations
class IBluetoothOppServerEventListener;
class _BluetoothOppServerImpl;
/**
* @class BluetoothOppServer
* @brief This class provides methods to handle the %Bluetooth Object Push Profile (OPP) server, such as the
* incoming connection requests.
*
* @since 2.0
*
* The %BluetoothOppServer class provides methods to handle the %Bluetooth Object Push Profile (OPP) server, such as the incoming
* connection requests.
*
* For more information on the class features, see
* <a href="../org.tizen.native.appprogramming/html/guide/net/bluetooth_namespace.htm">Bluetooth Guide</a>.
*/
class _OSP_EXPORT_ BluetoothOppServer
: public Tizen::Base::Object
{
public:
/**
* The object is not fully constructed after this constructor is called. For full construction, the Construct()
* method must be called right after calling this constructor.
*
* @since 2.0
*/
BluetoothOppServer(void);
/**
* This destructor overrides Tizen::Base::Object::~Object().
*
* @since 2.0
*/
virtual ~BluetoothOppServer(void);
/**
* Constructs and initializes this instance of %BluetoothOppServer with the specified listener.
*
* @since 2.0
* @feature %http://tizen.org/feature/network.bluetooth
*
* @return An error code
* @param[in] listener The event listener for the OPP server
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
* For more information, see
* <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">
* Application Filtering</a>.
* @exception E_SYSTEM A system error has occurred.
* @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue()
* methods.
*/
result Construct(IBluetoothOppServerEventListener& listener);
/**
* Accepts a push request from a remote OPP client. @n
* The %AcceptPush() method starts the file transfer.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth.opp
*
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state. @n
* For example, this instance has not been constructed as yet or %Bluetooth is
* not activated.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified
* operation. @n
* For example, the service is not started yet or a push request is not
* received from a remote device.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
* @exception E_FAILURE The method has failed.
* @see IBluetoothOppClientEventListener::OnOppPushResponded()
*/
result AcceptPush(void);
/**
* Rejects a push request from a remote OPP client.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth.opp
*
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state. @n
* For example, this instance has not been constructed as yet or %Bluetooth is
* not activated.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified
* operation. @n
* For example, the service is not started yet or a push request is not
* received from a remote device.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
* @exception E_FAILURE The method has failed.
* @see IBluetoothOppClientEventListener::OnOppPushResponded()
*/
result RejectPush(void);
/**
* Sets the destination path of the file to be received.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues. @n
* For more information, see @ref CompIoPathPage "here".
*
* @endif
* @return An error code
* @param[in] dstPath The new destination file path
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified
* operation. @n
* For example, trying to change the path on Push transition is prohibited.
* @exception E_INACCESSIBLE_PATH The specified @c dstPath is inaccessible.
* @exception E_FAILURE The method has failed.
*/
result SetDestinationPath(const Tizen::Base::String& dstPath);
/**
* Starts the OPP service and associates a listener with it.
*
* @if OSPCOMPAT
* @brief <i> [Compatibility] </i>
* @endif
* @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues. @n
* For more information, see @ref CompIoPathPage "here".
* @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth.opp
*
* @return An error code
* @param[in] dstPath The new destination file path
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state. @n
* For example, %Bluetooth is not activated.
* @exception E_IN_PROGRESS The service has already started.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
* @exception E_SERVICE_UNAVAILABLE The OPP service is unavailable.
* @exception E_INACCESSIBLE_PATH The specified @c dstPath is inaccessible.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified
* operation. @n
* For example, The stop process is in progress.
* @exception E_FAILURE The method has failed.
*/
result StartService(const Tizen::Base::String& dstPath);
/**
* Stops the OPP service. @n
* The %StopService() method cancels the file transfer before stopping the service.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth.opp
*
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state. @n
* For example, %Bluetooth is not activated.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified
* operation. @n
* For example, the service is not started as yet.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
* @exception E_IN_PROGRESS The stop process is in progress.
* @exception E_FAILURE The method has failed.
*/
result StopService(void);
/**
* Stops the file transfer in progress which was started by the client. @n
* If the %StopTransfer() method is called during the file transfer, the IBluetoothOppServerEventListener::OnOppTransferDone()
* method is called with @c isCompleted as @c false.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth.opp
*
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state. @n
* For example, %Bluetooth is not activated.
* @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified
* operation. @n
* For example, the file transfer is not in progress.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1
* @exception E_OPERATION_FAILED The operation has failed.
*/
result StopTransfer(void);
/**
* Sets the minimum interval of invocation of IBluetoothOppServerEventListener::OnOppTransferInProgress() in
* percentage. @n
* The default value is @c 5.
*
* @since 2.0
*
* @return An error code
* @param[in] percent The minimum period of progress interval as a percentage value
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method.
* @see IBluetoothOppServerEventListener::OnOppTransferInProgress()
*/
result SetMinProgressInterval(int percent);
private:
//
// The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying
// of objects.
//
BluetoothOppServer(const BluetoothOppServer& value);
//
// The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit
// copying of objects.
//
BluetoothOppServer& operator =(const BluetoothOppServer& value);
private:
_BluetoothOppServerImpl* __pImpl;
}; // BluetoothOppServer
} } }
#endif // _FNET_BT_BLUETOOTH_OPP_SERVER_H_
|
