Struct PairingDelegateSynchronousProxy

pub struct PairingDelegateSynchronousProxy { /* private fields */ }

Implementations

impl PairingDelegateSynchronousProxy

pub fn new(channel: Channel) -> Self

pub fn into_channel(self) -> Channel

pub fn wait_for_event( &self, deadline: MonotonicInstant, ) -> Result<PairingDelegateEvent, Error>

Waits until an event arrives and returns it. It is safe for other threads to make concurrent requests while waiting for an event.

pub fn on_pairing_request( &self, peer: &Peer, method: PairingMethod, displayed_passkey: u32, ___deadline: MonotonicInstant, ) -> Result<(bool, u32), Error>

Called to confirm a pairing. The pairing process will be continued if accept response is true and rejected otherwise. If the pairing method requires a passkey it must be included as well. Pairing methods that do not require a passkey ignore the entered_passkey repsonse.

The pairing can fail (usually by timeout or peer disconnect) before the response is received. The OnPairingComplete method will be called when this occurs. Any response sent in this case will be ignored.

• request peer information about the peer being paired
• request method method of pairing active. See PairingMethod
• request displayed_passkey a passkey to display to the user if PASSKEY_DISPLAY or PASSKEY_COMPARISON is being used. Meaningless otherwise.

• response accept true if the pairing is accepted
• response entered_passkey passkey entered by the user. Ignored unless method is PASSKEY_ENTRY.

pub fn on_pairing_complete( &self, id: &PeerId, success: bool, ) -> Result<(), Error>

Called when the pairing procedure for a peer has been completed. This can be due to successful completion or an error (e.g. due to cancellation by the peer, a timeout, or disconnection).

• request id The Bluetooth peer ID of the peer which was being paired.
• request success true if the pairing succeeded, otherwise false.

pub fn on_remote_keypress( &self, id: &PeerId, keypress: PairingKeypress, ) -> Result<(), Error>

Called to notify keypresses from the peer device during pairing using PairingMethod.PASSKEY_DISPLAY.

This event is used to provide key press events to the delegate for a responsive user experience as the user types the passkey on the peer device. This event will be called once for each keypress.

This event will only be called between when an OnPairingRequest has been sent for id and when OnPairingComplete is sent.

Note: many devices do not send these events

• request id The peer id of the peer that sent the keypress event.
• request keypress The type of event which was received.

Trait Implementations

impl Debug for PairingDelegateSynchronousProxy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl SynchronousProxy for PairingDelegateSynchronousProxy

type Proxy = PairingDelegateProxy

The async proxy for the same protocol.

type Protocol = PairingDelegateMarker

The protocol which this Proxy controls.

fn from_channel(inner: Channel) -> Self

Create a proxy over the given channel.

fn into_channel(self) -> Channel

Convert the proxy back into a channel.

fn as_channel(&self) -> &Channel

Get a reference to the proxy’s underlying channel.

fn is_closed(&self) -> Result<bool, Status>

Returns true if the proxy has received the PEER_CLOSED signal.