pub struct PeripheralProxy { /* private fields */ }
Implementations§
source§impl PeripheralProxy
impl PeripheralProxy
sourcepub fn new(channel: AsyncChannel) -> Self
pub fn new(channel: AsyncChannel) -> Self
Create a new Proxy for fuchsia.bluetooth.le/Peripheral.
sourcepub fn take_event_stream(&self) -> PeripheralEventStream
pub fn take_event_stream(&self) -> PeripheralEventStream
Get a Stream of events from the remote end of the protocol.
§Panics
Panics if the event stream was already taken.
sourcepub fn advertise(
&self,
parameters: &AdvertisingParameters,
advertised_peripheral: ClientEnd<AdvertisedPeripheralMarker>
) -> QueryResponseFut<PeripheralAdvertiseResult>
pub fn advertise( &self, parameters: &AdvertisingParameters, advertised_peripheral: ClientEnd<AdvertisedPeripheralMarker> ) -> QueryResponseFut<PeripheralAdvertiseResult>
Start advertising continuously as a LE peripheral. If advertising cannot
be initiated then advertised_peripheral
will be closed and an error
will be returned.
This method may be called any number of times. To reconfigure an advertisement, first close the original advertisement and then initiate a new advertisement after an empty response is returned.
If the client closes its end of the
[fuchsia.bluetooth.le/AdvertisedPeripheral
] channel,
advertising will be stopped. If the handle is closed before the request
is fulfilled, advertising may be briefly enabled before it is
terminated. AdvertisedPeripheral lifetime is bounded by the lifetime of
the Peripheral protocol, but this may be changed in the future
(https://fxbug.dev/42157682).
- request
parameters
Parameters used while configuring the advertising instance. - request
advertised_peripheral
Protocol that remains valid for the duration of this advertising session.
- response An empty response will be sent when the advertisement is
successfully stopped (due to release of the
advertised_peripheral
protocol). To prevent overlapping similar advertisements and transient errors with limited advertising resources, waiting for a response is recommended before callingAdvertise
again.
- error If an error occurs,
advertised_peripheral
will be closed and aPeripheralError
will be returned.
sourcepub fn start_advertising(
&self,
parameters: &AdvertisingParameters,
handle: ServerEnd<AdvertisingHandleMarker>
) -> QueryResponseFut<PeripheralStartAdvertisingResult>
pub fn start_advertising( &self, parameters: &AdvertisingParameters, handle: ServerEnd<AdvertisingHandleMarker> ) -> QueryResponseFut<PeripheralStartAdvertisingResult>
Start advertising as a LE peripheral. An empty response is sent to indicate when advertising
has successfully initiated. If advertising cannot be initiated, then the response will
contain a [fuchsia.bluetooth.le/PeripheralError
].
This method can get called any number of times and successive calls can be made to
reconfigure the advertising parameters. However only the most recent
[fuchsia.bluetooth.le/AdvertisingHandle
] will remain valid.
An instance of [fuchsia.bluetooth.le/Peripheral
] can only have one active advertisement at
a time. Clients must obtain multiple Peripheral instances for multiple simultaneous
advertisements.
If the client closes its end of the [fuchsia.bluetooth.le/AdvertisingHandle
] channel,
advertising will be stopped. If the handle is closed before the request is fulfilled,
advertising will be briefly enabled before it is terminated.
- request
parameters
Parameters used while configuring the advertising instance. - request
handle
Handle that remains valid for the duration of this advertising session.
- error Returns a [
fuchsia.bluetooth.le/PeripheralError
] if advertising cannot be initiated. In this case thehandle
will be closed.
Trait Implementations§
source§impl Clone for PeripheralProxy
impl Clone for PeripheralProxy
source§fn clone(&self) -> PeripheralProxy
fn clone(&self) -> PeripheralProxy
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PeripheralProxy
impl Debug for PeripheralProxy
source§impl PeripheralProxyInterface for PeripheralProxy
impl PeripheralProxyInterface for PeripheralProxy
type AdvertiseResponseFut = QueryResponseFut<Result<(), PeripheralError>>
fn advertise( &self, parameters: &AdvertisingParameters, advertised_peripheral: ClientEnd<AdvertisedPeripheralMarker> ) -> Self::AdvertiseResponseFut
type StartAdvertisingResponseFut = QueryResponseFut<Result<(), PeripheralError>>
fn start_advertising( &self, parameters: &AdvertisingParameters, handle: ServerEnd<AdvertisingHandleMarker> ) -> Self::StartAdvertisingResponseFut
source§impl Proxy for PeripheralProxy
impl Proxy for PeripheralProxy
§type Protocol = PeripheralMarker
type Protocol = PeripheralMarker
Proxy
controls.