wclBluetoothLeAdvertiserConnection Class

The virtual connection class enables Bluetooth LE advertising feature.

Inheritance Hierarchy

SystemObject
wclCommunicationwclCustomConnection
wclBluetoothwclBluetoothLeAdvertiserConnection

Namespace: wclBluetooth
Assembly: wclBluetoothFramework (in wclBluetoothFramework.dll) Version: 7.17.12.0 (7.17.12.0)

Syntax

public abstract class wclBluetoothLeAdvertiserConnection : wclCustomConnection

Public MustInherit Class wclBluetoothLeAdvertiserConnection
	Inherits wclCustomConnection

public ref class wclBluetoothLeAdvertiserConnection abstract : public wclCustomConnection

The wclBluetoothLeAdvertiserConnection type exposes the following members.

Constructors

	Name	Description
	wclBluetoothLeAdvertiserConnection	Creates a new "virtual" Bluetooth LE Advertising connection object.

Properties

	Name	Description
	Advertisements	Gets the Bluetooth LE advertisements list.
	Advertising	Gets advertising state.
	Anonymous	Specifies whether or not the device address is included in the advertisement header. By default, the address is included.
	IncludeTxRssi	Specifies whether the transmit power level is included in the advertisement header.
	Interval	Gets the advertising interval.
	PreferredTxRssi	If specified, requests that the radio use the indicated transmit power level for the advertisement.
	Radio	Gets the connection owner.
	Receiver	Gets the connection message receiver object. (Inherited from wclCustomConnection)
	ThreadId	Gets the connection's thread ID. (Inherited from wclCustomConnection)
	UseExtendedAdvertisement	Specifies that the advertisement publisher should use the Extended Advertising format.

Methods

	Name	Description
	DoStarted	Fires the OnStarted event.
	DoStopped	Fires the OnStopped event.
	Enter	Enters the connection's critical section. (Inherited from wclCustomConnection)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object)
	Finalize	Frees the object. (Overrides ObjectFinalize)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	HalStart	Implements a hardware-dependent code to start Bluetooth LE advertising.
	HalStop	Implements a hardware-dependent code to stop Bluetooth LE advertising.
	Leave	Exists *leaves) the connection's critical section. (Inherited from wclCustomConnection)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	MessageReceived	The method called when a new notification message received. (Overrides wclCustomConnectionMessageReceived(wclMessage))
	Start	Starts Bluetooth LE Advertising.
	Stop	Stops Bluetooth LE Advertising.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Events

	Name	Description
	OnStarted	The event fires when the Bluetooth LE advertising started.
	OnStopped	The event fires when the Bluetooth LE advertising stopped.

Remarks

The class provides methods to enable Bluetooth LE advertising.

The feature is supported only on Windows 10 platform with Microsoft Bluetooth drivers or on any Windows platform with BLED112 Bluetooth dongle.