namespace Tizen.Network.Bluetooth
{
/// <summary>
- /// This class is used to control the Bluetooth adapter and get the list of bonded devices.<br>
+ /// This class is used to control the Bluetooth adapter and get the list of bonded devices.<br/>
/// The BluetoothAdapter class is used to discover neighbouring bluetooth devices.
/// </summary>
/// <privilege> http://tizen.org/privilege/bluetooth </privilege>
/// </summary>
/// <remarks>
/// The device must be bonded with the remote device by CreateBond(). If connection request succeeds, the AudioConnectionStateChanged event will be invoked.
- /// If audio profile type is All and this request succeeds, then the AudioConnectionStateChanged event will be called twice when HspHfp <br>
+ /// If audio profile type is All and this request succeeds, then the AudioConnectionStateChanged event will be called twice when HspHfp <br/>
/// and AdvancedAudioDistribution is connected.
/// </remarks>
/// <param name="profileType">The type of the audio profile.</param>
/// </summary>
/// <remarks>
/// The device must be connected by Connect(). If the disconnection request succeeds, the AudioConnectionStateChanged event will be invoked.
- /// If audio profile type is All and this request succeeds, then the AudioConnectionStateChanged event will be called twice when HspHfp <br>
+ /// If audio profile type is All and this request succeeds, then the AudioConnectionStateChanged event will be called twice when HspHfp <br/>
/// and AdvancedAudioDistribution is disconnected.
/// </remarks>
/// <param name="type">The type of the audio profile.</param>
/// <param name="mode">The repeat mode.</param>
/// <exception cref="NotSupportedException">Thrown when the Bluetooth is not supported.</exception>
/// <exception cref="InvalidOperationException">Thrown when the Bluetooth is not enabled
- /// or when notifying the repeat mode state to the remote device fails.</exception>
+ /// or when notifying the repeat mode state to the remote device fails.
/// </exception>
public void NotifyRepeatMode(RepeatMode mode)
{
namespace Tizen.Network.Bluetooth
{
/// <summary>
- /// This class is used to handle the connection with other devices and set authorization of other devices.<br>
+ /// This class is used to handle the connection with other devices and set authorization of other devices.<br/>
/// The BluetoothDevice class is used to search for services available on remote devices.
/// </summary>
/// <privilege> http://tizen.org/privilege/bluetooth </privilege>
}
}
+ /// <summary>
+ /// The AcceptStateChanged event is raised when the socket connection state is changed.
+ /// </summary>
public class AcceptStateChangedEventArgs : EventArgs
{
private BluetoothError _result;
return client.Isvalid() ? client : null;
}
+ /// <summary>
+ /// Destroy Bluetooth GATT client
+ /// </summary>
public void DestroyClient()
{
_impl.GetHandle().Dispose();
/// <summary>
/// The constructor.
/// </summary>
- /// <param name="uuid">The UUID of the characterstic.param>
+ /// <param name="uuid">The UUID of the characterstic.</param>
/// <param name="permissions">Permissions for the characterstic.</param>
/// <param name="properties">Properties set for the characterstic.</param>
/// <param name="value">The value associated with the characterstic.</param>
private EventHandler<ReadRequestedEventArgs> _readValueRequested;
private EventHandler<WriteRequestedEventArgs> _writeValueRequested;
+ /// <summary>
+ /// The constructor.
+ /// </summary>
+ /// <param name="uuid">The UUID of the GATT attribute.</param>
+ /// <param name="permission">Permission for the GATT attribute.</param>
public BluetoothGattAttribute(string uuid, BluetoothGattPermission permission)
{
Uuid = uuid;
}
}
+ /// <summary>
+ /// BluetoothLeDevice destructor.
+ /// </summary>
~BluetoothLeDevice()
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
}
}
+ /// <summary>
+ /// BluetoothLeAdvertiseData destructor.
+ /// </summary>
~BluetoothLeAdvertiseData()
{
if (BluetoothAdapter.IsBluetoothEnabled && Globals.IsInitialize)
}
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
public void Dispose()
{
Dispose(true);
private static BluetoothOppServerImpl _impl;
private static BluetoothOppServer _instance;
+ /// <summary>
+ /// The constructor
+ /// </summary>
public BluetoothOppServer()
{
_impl = BluetoothOppServerImpl.Instance;
namespace Tizen.Network.Bluetooth
{
/// <summary>
- /// This generic class represents all Bluetooth profiles.<br>
+ /// This generic class represents all Bluetooth profiles.<br/>
/// Any common properties/functions can be added in this class in future.
/// </summary>
/// <privilege> http://tizen.org/privilege/bluetooth </privilege>
}
}
+ /// <summary>
+ /// BluetoothServerSocket distructor.
+ /// </summary>
~BluetoothServerSocket()
{
Dispose(false);
}
+ /// <summary>
+ /// Dispose
+ /// </summary>
public void Dispose()
{
Dispose(true);
/// </summary>
public interface IBluetoothServerSocket
{
+ /// <summary>
+ /// Event handler to receive data over bluetooth socket.
+ /// This event occurs when the socket server receives data from the client.
+ /// </summary>
event EventHandler<SocketDataReceivedEventArgs> DataReceived;
+
+ /// <summary>
+ /// Event handler method to receive bluetooth socket connection state changed events.
+ /// This event occurs when the connection state between two devices is changed.
+ /// </summary>
event EventHandler<SocketConnectionStateChangedEventArgs> ConnectionStateChanged;
+
+ /// <summary>
+ /// Method to send data over bluetooth socket
+ /// </summary>
+ /// <returns>The number of bytes written (zero indicates nothing was written).</returns>
+ /// <remarks>
+ /// The connection must be established.
+ /// </remarks>
+ /// <param name="data">The data to be sent.</param>
+ /// <returns></returns>
int SendData(string data);
}
/// </summary>
public interface IBluetoothClientSocket : IBluetoothServerSocket
{
+ /// <summary>
+ /// Connect client socket to server socket on remote device.
+ /// </summary>
void Connect();
+
+ /// <summary>
+ /// Disconnect client socket from server socket.
+ /// </summary>
void Disconnect();
}
internal string ServiceUuid;
}
- /// </summary>
[StructLayout(LayoutKind.Sequential)]
internal struct BluetoothLeScanDataStruct
{
projects / platform / core / csapi / tizenfx.git / commitdiff