NimBLESecurityCallbacks Class Reference

Callbacks to handle GAP events related to authorization. Deprecated - provided for backward compatibility only. More...

Public Member Functions
virtual uint32_t	onPassKeyRequest ()=0
	Its request from peer device to input authentication pin code displayed on peer device. It requires that our device is capable to input 6-digits code by end user. More...
virtual void	onPassKeyNotify (uint32_t pass_key)=0
	Provide us 6-digits code to perform authentication. It requires that our device is capable to display this code to end user. More...
virtual bool	onSecurityRequest ()=0
	Here we can make decision if we want to let negotiate authorization with peer device or not. More...
virtual void	onAuthenticationComplete (ble_gap_conn_desc *)=0
	Provides us information when authentication process is completed.
virtual bool	onConfirmPIN (uint32_t pin)=0
	Called when using numeric comparison for authentication. More...

Detailed Description

Callbacks to handle GAP events related to authorization. Deprecated - provided for backward compatibility only.

Deprecated:

Use the callbacks provided in NimBLEClientCallbacks and NimBLEServerCallbacks instead.

Member Function Documentation

onConfirmPIN()

virtual bool NimBLESecurityCallbacks::onConfirmPIN ( uint32_t  pin )

pure virtual

Called when using numeric comparison for authentication.

Parameters

[in]

pin

The PIN to compare.

Returns

True to accept and pair.

onPassKeyNotify()

virtual void NimBLESecurityCallbacks::onPassKeyNotify ( uint32_t  pass_key )

pure virtual

Provide us 6-digits code to perform authentication. It requires that our device is capable to display this code to end user.

Parameters

[in]

pass_key

The PIN provided by the peer.

onPassKeyRequest()

virtual uint32_t NimBLESecurityCallbacks::onPassKeyRequest ( )

pure virtual

Its request from peer device to input authentication pin code displayed on peer device. It requires that our device is capable to input 6-digits code by end user.

Returns

Return 6-digits integer value from input device

onSecurityRequest()

virtual bool NimBLESecurityCallbacks::onSecurityRequest ( )

pure virtual

Here we can make decision if we want to let negotiate authorization with peer device or not.

Returns

Return true if we accept this peer device request