IOBluetoothDevicePair.h

Overview

Use the links in the table of contents to the left to access the documentation.



Classes

IOBluetoothDevicePair

An instance of IOBluetoothDevicePair represents a pairing attempt to a remote Bluetooth device.



Methods

-devicePairingConnecting:

Indicates to the delegate that the pairing object is making the device (baseband) connection.

-devicePairingFinished:error:

Indicates to the delegate that the pairing object has fully completed the process. Can tell the delegate when and error occurred during the attempt to pair with the device.

-devicePairingPINCodeRequest:

Indicates to the delegate that the pairing object has made the device (baseband) connection and is awaiting the PIN code (if specified) to be entered on the device. Thus, when you recieve this message, you should display to the user that they should enter the PIN code on the device. The method replyPINCode must be invoked in response and happen before the timeout period of the device.

-devicePairingStarted:

Indicates that the pairing has started.

-devicePairingUserConfirmationRequest:numericValue:

Indicates to the delegate that the pairing object has made the device (baseband) connection and is awaiting the a yes/no answer for the Simple Secure Pairing numeric comparison. Thus, when you recieve this message, you should display to the user the numeric value and then accept the yes/no answer if it matches the value on the other device. The method replyUserConfirmation must be invoked in response and happen before the timeout period of the device.

-devicePairingUserPasskeyNotification:passkey:

Indicates to the delegate that the pairing object has made the device (baseband) connection and is awaiting the passkey (if specified) to be entered on the device for the Secure Simple Pairing. Thus, when you recieve this message, you should display to the user that they should enter the passkey on the device.


devicePairingConnecting:


Indicates to the delegate that the pairing object is making the device (baseband) connection.

- (void) devicePairingConnecting:(id)sender;  
Parameters
sender

The IOBluetoothDevicePair object.


devicePairingFinished:error:


Indicates to the delegate that the pairing object has fully completed the process. Can tell the delegate when and error occurred during the attempt to pair with the device.

- (void) devicePairingFinished:(id)sender error:(IOReturn)error;  
Parameters
sender

The IOBluetoothDevicePair object.

error

An IOReturn or Bluetooth error code.

Discussion

The error passed to your delegate could be kBluetoothHCIErrorAuthenticationFailure, kBluetoothHCIErrorLMPResponseTimeout, etc. See Bluetooth.h for all the possibilities.


devicePairingPINCodeRequest:


Indicates to the delegate that the pairing object has made the device (baseband) connection and is awaiting the PIN code (if specified) to be entered on the device. Thus, when you recieve this message, you should display to the user that they should enter the PIN code on the device. The method replyPINCode must be invoked in response and happen before the timeout period of the device.

- (void) devicePairingPINCodeRequest:(id)sender;  
Parameters
sender

The IOBluetoothDevicePair object.


devicePairingStarted:


Indicates that the pairing has started.

- (void) devicePairingStarted:(id)sender;  
Parameters
sender

The IOBluetoothDevicePair object.


devicePairingUserConfirmationRequest:numericValue:


Indicates to the delegate that the pairing object has made the device (baseband) connection and is awaiting the a yes/no answer for the Simple Secure Pairing numeric comparison. Thus, when you recieve this message, you should display to the user the numeric value and then accept the yes/no answer if it matches the value on the other device. The method replyUserConfirmation must be invoked in response and happen before the timeout period of the device.

- (void) devicePairingUserConfirmationRequest:(id)sender 
        numericValue:(BluetoothNumericValue)numericValue;  
Parameters
sender

The IOBluetoothDevicePair object.

numericValue

Numeric value to be displayed.


devicePairingUserPasskeyNotification:passkey:


Indicates to the delegate that the pairing object has made the device (baseband) connection and is awaiting the passkey (if specified) to be entered on the device for the Secure Simple Pairing. Thus, when you recieve this message, you should display to the user that they should enter the passkey on the device.

- (void) devicePairingUserPasskeyNotification:(id)sender 
        passkey:(BluetoothPasskey)passkey;  
Parameters
sender

The IOBluetoothDevicePair object.

passkey

Passkey to be displayed.

 

Did this document help you? Yes It's good, but... Not helpful...

 

Last Updated: 2009-10-09