BluetoothScannerFilter::Builder Class Reference

Public Member Functions
	Builder ()
	~Builder ()
Builder &	includeDeviceWithMac (std::string mac)
Builder &	includeDeviceWithMacIn (std::vector< std::string > &macs)
Builder &	excludeDeviceWithMac (std::string mac)
Builder &	excludeDeviceWithMacIn (std::vector< std::string > &macs)
Builder &	includeDeviceWhoseNameContains (std::string name)
Builder &	includeDeviceWhoseNameContains (std::vector< std::string > &names)
Builder &	excludeDeviceWhoseNameContains (std::string name)
Builder &	excludeDeviceWhoseNameContains (std::vector< std::string > &names)
BluetoothScannerFilter	build ()
BluetoothScannerFilter	buildDefault ()

Constructor & Destructor Documentation

Builder()

Builder

(

)

Builder constructor.

~Builder()

~Builder

(

)

Builder destructor.

Member Function Documentation

build()

BluetoothScannerFilter build

(

)

Builds a new instance of a BluetoothScannerFilter using the configured parameters.

Returns

A valid BluetoothScannerFilter.

buildDefault()

BluetoothScannerFilter buildDefault

(

)

Builds a new instance of a BluetoothScannerFilter using the default parameters.

Every list will be empty so every device will be allowed.

Returns

A valid BluetoothScannerFilter.

excludeDeviceWhoseNameContains() [1/2]

Builder& excludeDeviceWhoseNameContains

(

std::string

name

)

Adds a string to the name exclude list.

See BluetoothScannerFilter#filter() for more information.

Parameters

name

A string.

Returns

This Builder instance.

excludeDeviceWhoseNameContains() [2/2]

Builder& excludeDeviceWhoseNameContains

(

std::vector< std::string > &

names

)

Adds a string to the name exclude list.

See BluetoothScannerFilter#filter() for more information.

Parameters

names

A string list.

Returns

This Builder instance.

excludeDeviceWithMac()

Builder& excludeDeviceWithMac

(

std::string

mac

)

Adds a MAC address to the exclude list.

See BluetoothScannerFilter#filter() for more information.

Parameters

macs	A MAC address list. Each address should follow the s_mac_regex.

Returns

This Builder instance.

excludeDeviceWithMacIn()

Builder& excludeDeviceWithMacIn

(

std::vector< std::string > &

macs

)

Adds a list of MAC addresses to the exclude list.

See BluetoothScannerFilter#filter() for more information.

Parameters

macs	A MAC address list. Each address should follow the s_mac_regex.

Returns

This Builder instance.

includeDeviceWhoseNameContains() [1/2]

Builder& includeDeviceWhoseNameContains

(

std::string

name

)

Adds a string to the name include list.

See BluetoothScannerFilter#filter() for more information.

Parameters

name

A string.

Returns

This Builder instance.

includeDeviceWhoseNameContains() [2/2]

Builder& includeDeviceWhoseNameContains

(

std::vector< std::string > &

names

)

Adds a string list to the name include list.

See BluetoothScannerFilter#filter() for more information.

Parameters

names

A string list.

Returns

This Builder instance.

includeDeviceWithMac()

Builder& includeDeviceWithMac

(

std::string

mac

)

Adds a MAC address to the include list.

See BluetoothScannerFilter#filter() for more information.

Parameters

mac	The MAC address. Should follow the s_mac_regex.

Returns

This Builder instance.

includeDeviceWithMacIn()

Builder& includeDeviceWithMacIn

(

std::vector< std::string > &

macs

)

Adds a list of MAC addresses to the include list.

See BluetoothScannerFilter#filter() for more information.

Parameters

macs	A MAC address list. Each address should follow the s_mac_regex.

Returns

This Builder instance.

---

The documentation for this class was generated from the following file:

• /home/joao.oliveira/Workspace/local/repo/documentation/sphinx/source/components/kallistolinuxapi/include/bluetooth/scanner/bluetooth_scanner_filter.hpp