ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #12661 from kbarm/feature-fix-documentation-ascii-art 

Adjusted SecurityManager Doxygen ASCII art
pull/12671/head
Martin Kojtal 2020-03-23 10:18:54 +01:00 committed by GitHub
parent 59540ed8c1 a624acd45c
commit cc799a83fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
features/FEATURE_BLE/ble/SecurityManager.h
View File

@ -124,19 +124,19 @@ namespace interface {
* Sequence diagram "Just Works" pairing
*
* \verbatim
* /----------- Device 1 --------------\ *------ BLE link ------* /-------------- Device 2 -------------\
* /-------- Device 1 ---------\ *----- BLE link -----* /----------- Device 2-----------\
*
* App EventHandler SecurityManager SecurityManager EventHandler App
* | | | | | |
* |---------------------------> requestPairing() | | |
* | | |------[pairing start]------>| | |
* | | | |----------------> pairingRequest() ->|
* | | | acceptPairing() <------------------------ |
* | | |<---[pairing complete]----->| | |
* |<- pairingResult() <---------------| |----------------> pairingResult() -->|
* | | | | | |
* App EventHandler SecurityManager SecurityManager EventHandler App
* | | | | | |
* |-------------------> requestPairing() | | |
* | | |-----[pairing start]----->| | |
* | | | |---------> pairingRequest() -->|
* | | | acceptPairing() <--------------------- |
* | | |<--[pairing complete]---->| | |
* |<- pairingResult() <-------| |---------> pairingResult() --->|
* | | | | | |
* @endverbatim
*
*
* @note the requestPairing() call isn't required to trigger pairing. Pairing will also be triggered
* if you request encryption and authentication and no bonding information is available. The sequence will
* be the same save for the lack of explicit requestPairing() call.
@ -145,16 +145,16 @@ namespace interface {
* Sequence diagram Encryption request when bonding information is available
*
* \verbatim
* /----------- Device 1 --------------\ *------ BLE link ------* /-------------- Device 2 -------------\
* /--------- Device 1 ---------\ *------ BLE link ------* /--------- Device 2 ---------\
*
* App EventHandler SecurityManager SecurityManager EventHandler App
* | | | | | |
* |---------------------------> setLinkEncryption() | | |
* | | |<-[encryption established]->| | |
* |<- linkEncryptionResult() <--------| |---------> linkEncryptionResult() -->|
* | | | | | |
* App EventHandler SecurityManager SecurityManager EventHandler App
* | | | | | |
* |--------------------> setLinkEncryption() | | |
* | | |<-[encryption established]->| | |
* |<- linkEncryptionResult() <-| |-> linkEncryptionResult() ->|
* | | | | | |
* @endverbatim
*
*
* @note if bonding information is not available, pairing will be triggered
*
*
@ -162,27 +162,27 @@ namespace interface {
* and other a keyboard
*
* \verbatim
* /----------- Device 1 (keyboard) ---\ *------ BLE link ------* /-------------- Device 2 (display) ---\
* /---- Device 1 (keyboard) ---\ *------ BLE link ------* /----- Device 2 (display) ---\
*
* App EventHandler SecurityManager SecurityManager EventHandler App
* | | | | | |
* |---------------------------> requestPairing() | | |
* | | |------[pairing start]------>| | |
* | | | |----------------> pairingRequest() ->|
* | | | acceptPairing() <------------------------ |
* | | |<---[secure con. pairing]-->| | |
* |<- passkeyRequest() <--------------| |----------------> passkeyDisplay() ->|
* | | | | | |
* App EventHandler SecurityManager SecurityManager EventHandler App
* | | | | | |
* |--------------------> requestPairing() | | |
* | | |------[pairing start]------>| | |
* | | | |-------> pairingRequest() ->|
* | | | acceptPairing() <--------------- |
* | | |<---[secure con. pairing]-->| | |
* |<- passkeyRequest() <-------| |-------> passkeyDisplay() ->|
* | | | | | |
*
* user reads the passkey on Device 2 and inputs it on Device 1
* user reads the passkey on Device 2 and inputs it on Device 1
*
* | | | | | |
* |-------------------------->passkeyEntered() | | |
* | | |<---[pairing complete]----->| | |
* |<- pairingResult() <---------------| |----------------> pairingResult() -->|
* | | | | | |
* | | | | | |
* |------------------->passkeyEntered() | | |
* | | |<---[pairing complete]----->| | |
* |<- pairingResult() <--------| |-------> pairingResult() -->|
* | | | | | |
* @endverbatim
*
*
*/
#if !defined(DOXYGEN_ONLY)
template <class Impl>