class AdvertisingParameters

Defined at line 9227 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

Represents the parameters for configuring advertisements.

Public Members

static const fidl_type_t * FidlType

Public Methods

bool IsEmpty ()

Returns whether no field is set.

AdvertisingParameters & set_data (::fuchsia::bluetooth::le::AdvertisingData _value)
AdvertisingParameters & set_scan_response (::fuchsia::bluetooth::le::AdvertisingData _value)
AdvertisingParameters & set_mode_hint (::fuchsia::bluetooth::le::AdvertisingModeHint _value)
AdvertisingParameters & set_connectable (bool _value)
AdvertisingParameters & set_connection_options (::fuchsia::bluetooth::le::ConnectionOptions _value)
AdvertisingParameters & set_advertising_procedure (::fuchsia::bluetooth::le::AdvertisingProcedure _value)
AdvertisingParameters & set_address_type (::fuchsia::bluetooth::AddressType _value)
void AdvertisingParameters ()
void AdvertisingParameters (AdvertisingParameters && other)
void ~AdvertisingParameters ()
AdvertisingParameters & operator= (AdvertisingParameters && other)
::std::unique_ptr<AdvertisingParameters> New ()
void Encode (::fidl::Encoder * _encoder, size_t _offset, std::optional< ::fidl::HandleInformation> maybe_handle_info)
void Decode (::fidl::Decoder * _decoder, AdvertisingParameters * _value, size_t _offset)
zx_status_t Clone (AdvertisingParameters * _result)
const ::fuchsia::bluetooth::le::AdvertisingData & data ()

The fields that will be encoded in the data section of advertising packets.

This field is required.

Defined at line 9236 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

bool has_data ()

Defined at line 9240 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

::fuchsia::bluetooth::le::AdvertisingData * mutable_data ()

The fields that will be encoded in the data section of advertising packets.

This field is required.

Defined at line 9247 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

void clear_data ()

Defined at line 9255 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

const ::fuchsia::bluetooth::le::AdvertisingData & scan_response ()

The fields that are to be sent in a scan response packet. Clients may use this to send

additional data that does not fit inside an advertising packet on platforms that do not

support the advertising data length extensions.

If present advertisements will be configured to be scannable.

Defined at line 9268 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

bool has_scan_response ()

Defined at line 9272 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

::fuchsia::bluetooth::le::AdvertisingData * mutable_scan_response ()

The fields that are to be sent in a scan response packet. Clients may use this to send

additional data that does not fit inside an advertising packet on platforms that do not

support the advertising data length extensions.

If present advertisements will be configured to be scannable.

Defined at line 9281 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

void clear_scan_response ()

Defined at line 9289 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

const ::fuchsia::bluetooth::le::AdvertisingModeHint & mode_hint ()

The desired advertising frequency. See [`fuchsia.bluetooth.le/AdvertisingModeHint`].

Defaults to [`fuchsia.bluetooth.le/AdvertisingModeHint.SLOW`] if not present.

Defined at line 9299 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

bool has_mode_hint ()

Defined at line 9303 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

::fuchsia::bluetooth::le::AdvertisingModeHint * mutable_mode_hint ()

The desired advertising frequency. See [`fuchsia.bluetooth.le/AdvertisingModeHint`].

Defaults to [`fuchsia.bluetooth.le/AdvertisingModeHint.SLOW`] if not present.

Defined at line 9309 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

void clear_mode_hint ()

Defined at line 9317 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

const bool & connectable ()

If present and true then the controller will broadcast connectable advertisements which

allows remote LE centrals to initiate a connection to the Peripheral. If false or otherwise

not present then the advertisements will be non-connectable.

Defined at line 9328 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

bool has_connectable ()

Defined at line 9332 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

bool * mutable_connectable ()

If present and true then the controller will broadcast connectable advertisements which

allows remote LE centrals to initiate a connection to the Peripheral. If false or otherwise

not present then the advertisements will be non-connectable.

Defined at line 9339 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

void clear_connectable ()

Defined at line 9347 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

const ::fuchsia::bluetooth::le::ConnectionOptions & connection_options ()

If present, the controller will broadcast connectable advertisements

which allow peers to initiate connections to the Peripheral. The fields

of `ConnectionOptions` will configure any connections set up from

advertising.

Defined at line 9359 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

bool has_connection_options ()

Defined at line 9363 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

::fuchsia::bluetooth::le::ConnectionOptions * mutable_connection_options ()

If present, the controller will broadcast connectable advertisements

which allow peers to initiate connections to the Peripheral. The fields

of `ConnectionOptions` will configure any connections set up from

advertising.

Defined at line 9371 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

void clear_connection_options ()

Defined at line 9379 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

const ::fuchsia::bluetooth::le::AdvertisingProcedure & advertising_procedure ()

Specifies the advertising type to use (e.g. legacy, extended, etc).

If not present, we default to legacy advertising to maintain optimal compatibility with

pre-Bluetooth 5.0 devices. See field descriptions within AdvertisingProcedure for more

information.

Defined at line 9392 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

bool has_advertising_procedure ()

Defined at line 9396 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

::fuchsia::bluetooth::le::AdvertisingProcedure * mutable_advertising_procedure ()

Specifies the advertising type to use (e.g. legacy, extended, etc).

If not present, we default to legacy advertising to maintain optimal compatibility with

pre-Bluetooth 5.0 devices. See field descriptions within AdvertisingProcedure for more

information.

Defined at line 9405 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

void clear_advertising_procedure ()

Defined at line 9413 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

const ::fuchsia::bluetooth::AddressType & address_type ()

If privacy is not enabled, the address type will always be public.

If privacy is enabled and the client is not privileged, the address will be a random

private address (either resolvable or non-resolvable). A non-privileged client requesting a

public address will return an error.

If privacy is enabled and the client is privileged, they may request any address type,

or will default to a random private address.

If this field is unset, the address type will be public or random depending on if privacy

is enabled in the system.

Defined at line 9432 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

bool has_address_type ()

Defined at line 9436 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

::fuchsia::bluetooth::AddressType * mutable_address_type ()

If privacy is not enabled, the address type will always be public.

If privacy is enabled and the client is not privileged, the address will be a random

private address (either resolvable or non-resolvable). A non-privileged client requesting a

public address will return an error.

If privacy is enabled and the client is privileged, they may request any address type,

or will default to a random private address.

If this field is unset, the address type will be public or random depending on if privacy

is enabled in the system.

Defined at line 9451 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h

void clear_address_type ()

Defined at line 9459 of file fidling/gen/sdk/fidl/fuchsia.bluetooth.le/fuchsia.bluetooth.le/hlcpp/fuchsia/bluetooth/le/cpp/fidl.h