* @file FNetBluetooth.h
* @brief This is the header file for the %Bluetooth namespace.
*
- * This header file contains the declarations and descriptions of the %Tizen::Net::Bluetooth namespace.
+ * This header file contains the declarations and descriptions of the %Bluetooth namespace.
*/
#ifndef _FNET_BLUETOOTH_H_
#define _FNET_BLUETOOTH_H_
virtual ~BluetoothDevice(void);
/**
- * Gets the address of a %Bluetooth device which consists of 6 bytes.
+ * Gets the address of a %Bluetooth device which consists of @c 6 bytes.
*
* @since 2.0
*
* Compares the calling instance with the specified instance.
*
* @since 2.0
+ *
* @return @c true if both the instances are equal, @n
* else @c false
* @param[in] obj The object to compare
* recommended.
*
* @since 2.0
+ *
* @return The %Bluetooth device containing the specified information extracted from the input data if successful, @n
* else @c null
* @param[in] appControlResult The data list, which is the result of the %Bluetooth AppControl
* Gets a new instance of %BluetoothDevice that is generated using the result of the %Bluetooth AppControl.
*
* @since 2.1
+ *
* @return The %Bluetooth device containing the specified information extracted from the input data if successful, @n
* else @c null
* @param[in] appControlResult The data map, which is the result of the %Bluetooth AppControl
* @feature %http://tizen.org/feature/network.bluetooth
*
* @return An error code
- * @param[in] listener The event listener for the %BluetoothHealth. @n
+ * @param[in] listener The event listener for the %BluetoothHealth @n
* The specified listener must be allocated at heap, not stack.
* @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”>
+ * <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">
* Application Filtering</a>.
* @exception E_OPERATION_FAILED The method has failed.
* @remarks Before calling this method, check whether the feature is supported by %Tizen::System::SystemInfo::GetValue()
/**
* Stops %Bluetooth health as a role of sink. @n
- * This method disconnects all established channels before stop.
+ * The %Stop() method disconnects all established channels before stop.
*
* @since 2.0
* @privlevel public
/**
* Connects to a new channel with a remote health device which has source role. @n
- * This method establishes a channel after the source device accepts the request.
+ * The %ConnectToSource() method establishes a channel after the source device accepts the request.
*
* @since 2.0
* @privlevel public
* @exception E_DEVICE_BUSY The pairing and connection process is in progress.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_OPERATION_FAILED The method has failed.
- * @see IBluetoothHealthEventListener::OnHealthConnected()
* @remarks If the local device is not paired with the specified target device, the pairing process starts
* internally before the connect request is sent.
+ * @see IBluetoothHealthEventListener::OnHealthConnected()
*/
result ConnectToSource(const BluetoothDevice& remoteDevice);
/**
* Disconnects the connection which has the specified channel ID. @n
- * After calling this method, the IBluetoothHealthEventListener::OnHealthDisconnected() is called regardless of
+ * After calling the %Disconnect() method, the IBluetoothHealthEventListener::OnHealthDisconnected() method is called regardless of
* whether this method is called during connection or before connection is established.
*
* @since 2.0
* @privilege %http://tizen.org/privilege/bluetooth.health
*
* @return An error code
- * @param[in] channelId The ID of the specified channel to disconnect. @n
+ * @param[in] channelId The ID of the specified channel to disconnect @n
* The ID can be obtained by IBluetoothHealthEventListener::OnHealthConnected()
* after the specific channel is established.
* @exception E_SUCCESS The method is successful.
* @privilege %http://tizen.org/privilege/bluetooth.health
*
* @return An error code
- * @param[in] channelId The ID of the specified channel on which the data is sent. @n
+ * @param[in] channelId The ID of the specified channel on which the data is sent @n
* The ID can be obtained by IBluetoothHealthEventListener::OnHealthConnected()
* after the specific channel is established.
* @param[in] buffer The data to send
* @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”>
+ * <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()
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues@n
+ * @compatibility This method has compatibility issues. @n
* For more information, see @ref BluetoothManagerGetDiscoverableModePage "here".
*
* @endif
/**
* Gets the remaining time, in seconds, until the discoverable mode is changed from
* ::BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE to be ::BT_DISC_MODE_NOT_DISCOVERABLE. @n
- * This method is valid only if the current discoverable mode is @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE.
+ * The %GetRemainingTimeAsDiscoverable() method is valid only if the current discoverable mode is @c
+ * BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE.
*
* @since 2.0
*
- * @return The remaining time, in seconds, until the local device to be not discoverable. @n
- * @c 0 will be returned if the current discoverable mode is not @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE.
+ * @return The remaining time, in seconds, until the local device is not discoverable @n
+ * @c 0 is returned if the current discoverable mode is not ::BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE.
*/
int GetRemainingTimeAsDiscoverable(void) const;
bool IsDiscoveryInProgress(void) const;
/**
- * Sets the name of the local device. @n
+ * Sets a name of the local device. @n
* The searching device detects the local devices in close proximity based on the specified device name, and the
* name is only valid while an application is active.
*
* @privilege %http://tizen.org/privilege/bluetooth.admin
*
* @return An error code
- * @param[in] deviceName The new device name. @n
+ * @param[in] deviceName The new device name @n
* The specified device name is automatically truncated if its size is greater
* than @c 64 bytes.
* @exception E_SUCCESS The method is successful.
*
* @return An error code
* @param[in] mode The new discoverable mode
- * @param[in] seconds The duration in seconds for which the local device is discoverable. @n
+ * @param[in] seconds The duration in seconds for which the local device is discoverable @n
* The specified duration is adopted only if the specified @c mode is
* @c BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE.
* @exception E_SUCCESS The method is successful.
result CancelPair(void);
/**
- * Unpairs with the paired device. @n
- * The process of unpairing is to remove the specified device from the paired device list. No notification is
+ * Unpairs with a paired device. @n
+ * The process of unpairing is to remove a specified device from the paired device list. No notification is
* transmitted to the remote device. @n
- * This method is synchronous. Only when the result of this method is @c E_SUCCESS, the unpaired event is fired.
+ * The %Unpair() method is synchronous. Only when the result of this method is @c E_SUCCESS, the unpaired event is fired.
*
* @since 2.0
* @privlevel public
// The implementation of this copy constructor is intentionally blank to prohibit copying of objects.
//
BluetoothManager(const BluetoothManager& value);
+
//
// The implementation of this copy assignment operator is intentionally blank to prohibit copying of objects.
//
* @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”>
+ * <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()
* @endif
* @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues@n
+ * @compatibility This method has compatibility issues. @n
* For more information, see @ref CompIoPathPage "here".
* @endif
* @privlevel public
* @exception E_REMOTE_DEVICE_NOT_FOUND The input device is not found. @n
* This exception is currently not in use.
* @exception E_FAILURE The method has failed.
- * @see IBluetoothOppServerEventListener::OnOppPushRequested()
* @remarks If the local device is not paired with the specified target device, the pairing process starts
* internally before the push request is sent.
+ * @see IBluetoothOppServerEventListener::OnOppPushRequested()
*/
result PushFile(const BluetoothDevice& remoteDevice, const Tizen::Base::String& filePath);
/**
* Cancels the file push request in progress. @n
- * If this method is called before the OPP server accepts the push request, the
+ * If the %CancelPush() method is called before the OPP server accepts the push request, the
* IBluetoothOppClientEventListener::OnOppPushResponded() method is called and its result @c E_SYSTEM is thrown. @n
* If this method is called during the file transfer, the IBluetoothOppClientEventListener::OnOppTransferDone()
* method is called with @c isCompleted as @c false.
// of objects.
//
BluetoothOppClient(const BluetoothOppClient& value);
+
//
// The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit
// copying of objects.
* @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”>
+ * <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()
/**
* Accepts a push request from a remote OPP client. @n
- * This method starts the file transfer.
+ * The %AcceptPush() method starts the file transfer.
*
* @since 2.0
* @privlevel public
/**
* Stops the OPP service. @n
- * This method cancels the file transfer before stopping the service.
+ * The %StopService() method cancels the file transfer before stopping the service.
*
* @since 2.0
* @privlevel public
/**
* Stops the file transfer in progress which was started by the client. @n
- * If this method is called during the file transfer, the IBluetoothOppServerEventListener::OnOppTransferDone()
+ * 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
// 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.
* @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”>
+ * <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()
/**
* Accepts a connection request from a remote SPP initiator. @n
- * This method establishes a connection.
+ * The %AcceptConnection() method establishes a connection.
*
* @since 2.0
* @privlevel public
/**
* Stops the SPP service. @n
- * This method disconnects the current connection before stopping the service.
+ * The %StopService() method disconnects the current connection before stopping the service.
*
* @since 2.0
* @privlevel public
* @privilege %http://tizen.org/privilege/bluetooth.spp
*
* @return An error code
- * @param[in] buffer The data to send. @n
+ * @param[in] buffer The data to send @n
* The size of the buffer should not exceed @c 1000 bytes.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state. @n
// of objects.
//
BluetoothSppAcceptor(const BluetoothSppAcceptor& value);
+
//
// The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit
// copying of objects.
* @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”>
+ * <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()
/**
* Connects to a remote SPP acceptor with the default service UUID - BT_SVC_UUID_SPP. @n
- * This method establishes a connection after the SPP acceptor accepts the request.
+ * The %Connect() method establishes a connection after the SPP acceptor accepts the request.
*
* @since 2.0
* @privlevel public
* @exception E_REMOTE_DEVICE_NOT_FOUND The input device is not found. @n
* This exception is currently not in use.
* @exception E_FAILURE The method has failed.
- * @see IBluetoothSppAcceptorEventListener::OnSppConnectionRequested()
* @remarks If the local device is not paired with the specified target device, the pairing process starts
* internally before the connect request is sent.
+ * @see IBluetoothSppAcceptorEventListener::OnSppConnectionRequested()
*/
result Connect(const BluetoothDevice& remoteDevice);
/**
* Connects to a remote SPP acceptor with the specified service UUID. @n
- * This method establishes a connection after the SPP acceptor accepts the request.
+ * The %Connect() method establishes a connection after the SPP acceptor accepts the request.
*
* @since 2.0
* @privlevel public
* @exception E_REMOTE_DEVICE_NOT_FOUND The input device is not found. @n
* This exception is currently not in use.
* @exception E_FAILURE The method has failed.
- * @see IBluetoothSppAcceptorEventListener::OnSppConnectionRequested()
* @remarks If the local device is not paired with the specified target device, the pairing process starts
* internally before the connect request is sent.
+ * @see IBluetoothSppAcceptorEventListener::OnSppConnectionRequested()
*/
result Connect(const BluetoothDevice& remoteDevice, const Tizen::Base::UuId& serviceUuid);
/**
* Disconnects the current connection. @n
- * If this method is called before the SPP acceptor accepts the connection request, the
- * IBluetoothSppInitiatorEventListener::OnSppConnectionResponded() and its result @c E_SYSTEM is thrown. @n
- * If this method is called on connection, the IBluetoothSppInitiatorEventListener::OnSppDisconnected() and
+ * If the %Disconnect() method is called before the SPP acceptor accepts the connection request, the
+ * IBluetoothSppInitiatorEventListener::OnSppConnectionResponded() method and its result @c E_SYSTEM is thrown. @n
+ * If this method is called on connection, the IBluetoothSppInitiatorEventListener::OnSppDisconnected() method and
* its result @c E_SUCCESS is thrown.
*
* @since 2.0
* @privilege %http://tizen.org/privilege/bluetooth.spp
*
* @return An error code
- * @param[in] buffer The data to send. @n
+ * @param[in] buffer The data to send @n
* The size of the buffer should not exceed @c 1000 bytes.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state. @n
// of objects.
//
BluetoothSppInitiator(const BluetoothSppInitiator& value);
+
//
// The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit
// copying of objects.
{
BT_DISC_MODE_NOT_DISCOVERABLE, /**< The mode NOT DISCOVERABLE by other devices */
BT_DISC_MODE_DISCOVERABLE, /**< The mode DISCOVERABLE by other devices */
- BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE /**< The mode DISCOVERABLE by other devices during a certain amount of time
- */
+ BT_DISC_MODE_TIME_LIMITED_DISCOVERABLE /**< The mode DISCOVERABLE by other devices during a certain amount of time */
};
/**
{
BT_CONNECTION_GENERIC, /**< The GENERIC CONNECTION
* @if OSPDEPREC
- * @deprecated This enumeration field is deprecated. @n
+ * @deprecated This enum field is deprecated.
* @endif
*/
BT_CONNECTION_SPP_ACCEPTOR, /**< The SPP ACCEPTOR CONNECTION */
{
BT_HEALTH_DATA_CHANNEL_NONE, /**< The any type of data channel */
BT_HEALTH_DATA_CHANNEL_RELIABLE, /**< The data channel type for transmitting data with the reliable manner of
- * which the confidence in the exchange is at its highest (e.g. measurement
+ * which the confidence in the exchange is at its highest (for example, measurement
* and alert information)
*/
BT_HEALTH_DATA_CHANNEL_STREAMING /**< The data channel type for transmitting data when the timeliness of the
* delivery of each frame is more important than the reliable delivery of
- * every frame (e.g. an ECG waveform, where low latency is critical)
+ * every frame (for example, an ECG waveform, where low latency is critical)
*/
};
BT_SVC_MAP_SERVICE = 0x10000000, /**< The message access profile service type */
BT_SVC_ALL_SERVICE = 0x01FFFFFF, /**< The All-services-supported-by-BTA service type
* @if OSPDEPREC
- * @deprecated This enumeration field is deprecated.
+ * @deprecated This enum field is deprecated.
* @endif
*/
_OSP_EXPORT_ extern const byte BT_SVC_UUID_GENERIC_AUDIO[];
/**
- * The generic telephony UUID. (00001204-0000-1000-8000-00805F9B34FB)
+ * The generic telephony UUID (00001204-0000-1000-8000-00805F9B34FB).
*
* @since 2.0
*/
* @since 2.0
*
* @param[in] targetDevice The remote device that sends its service list
- * @param[in] serviceList The service list that is received. @n
+ * @param[in] serviceList The service list that is received @n
* The specified service list consists of Bluetooth::BluetoothServiceType
* values which are joined by OR operator.
* @param[in] r The result of receiving the service list
virtual void OnBluetoothServiceListReceived(const BluetoothDevice& targetDevice, unsigned long serviceList, result r) = 0;
/**
- * Called when a new remote device is paired with this local device. @n
- * This method is able to be called even though the specified device already exists in the paired device list.
- * Because the authorized key with the remote device is no more valid. @n
+ * Called when a new remote device is paired with a local device. @n
+ * Even though the specified device already exists in the paired device list, the %OnBluetoothPaired() method can be called
+ * because the key that is authorized with the remote device is no longer valid. @n
* If the pairing is explicitly requested by BluetoothManager::Pair() and the request fails,
* OnBluetoothPairingFailed() is called instead of this method.
*
* @since 2.0
*
- * @param[in] pairedDevice The device to pair with the local device. @n
+ * @param[in] pairedDevice The device to pair with the local device @n
* The specified device may have no service list value and elements in the service
- * UUID list because the retrieving the service list from the remote device fails.@n
+ * UUID list because retrieving the service list from the remote device fails. @n
* In that case, call BluetoothManager::RetrieveServiceList() to get the service
* list from the paired device.
*/
*
* @since 2.0
*
- * @param[in] r The error result of the pairing request. @n
+ * @param[in] r The error result of the pairing request @n
* One of the following exception is thrown.
* @exception E_OPERATION_CANCELED The pairing operation is canceled explicitly.
* @exception E_TIMEOUT The pairing request has timed out because the remote device does not
* Called to notify when a connection with a health device is established.
*
* @since 2.0
+ *
* @param[in] channelId The channel ID of the established connection, @n
* else an invalid ID (@c -1) if the method is not successful
* @param[in] dataType The type of data used in the established connection which is defined in
* @param[in] channelType The data channel type of the established connection
* @param[in] pRemoteDevice The remote health device to connect with the local device, @n
* else @c null if the method is not successful
- * @param[in] r The result of the connection request. @n
+ * @param[in] r The result of the connection request @n
* One of the following exception is thrown.
* @exception E_SUCCESS The connection is established successfully.
* @exception E_OPERATION_FAILED The connection request has failed.
* @since 2.0
*
* @param[in] channelId The channel ID of the terminated connection
- * @param[in] r The disconnection status. @n
+ * @param[in] r The disconnection status @n
* One of the following exception is thrown.
* @exception E_SUCCESS The specified connection (channel) is terminated successfully.
* @exception E_OPERATION_FAILED The method has failed to disconnect.
*
* @since 2.0
*
- * @param[in] fileName The name of the file to transfer. @n
+ * @param[in] fileName The name of the file to transfer @n
* If the name of the received file already exists in the destination path, the
* received file is renamed automatically and @c isCompleted is set to @c true.
* For renaming, the specified postfix is appended to the original file name. The
projects / platform / framework / native / bluetooth.git / commitdiff