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

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

@ -124,17 +124,17 @@ namespace interface {
* Sequence diagram "Just Works" pairing * Sequence diagram "Just Works" pairing
* *
* \verbatim * \verbatim
* /----------- Device 1 --------------\ *------ BLE link ------* /-------------- Device 2 -------------\ * /-------- Device 1 ---------\ *----- BLE link -----* /----------- Device 2-----------\
* *
* App EventHandler SecurityManager SecurityManager EventHandler App * App EventHandler SecurityManager SecurityManager EventHandler App
* | | | | | | * | | | | | |
* |---------------------------> requestPairing() | | | * |-------------------> requestPairing() | | |
* | | |------[pairing start]------>| | | * | | |-----[pairing start]----->| | |
* | | | |----------------> pairingRequest() ->| * | | | |---------> pairingRequest() -->|
* | | | acceptPairing() <------------------------ | * | | | acceptPairing() <--------------------- |
* | | |<---[pairing complete]----->| | | * | | |<--[pairing complete]---->| | |
* |<- pairingResult() <---------------| |----------------> pairingResult() -->| * |<- pairingResult() <-------| |---------> pairingResult() --->|
* | | | | | | * | | | | | |
* @endverbatim * @endverbatim
* *
* @note the requestPairing() call isn't required to trigger pairing. Pairing will also be triggered * @note the requestPairing() call isn't required to trigger pairing. Pairing will also be triggered
@ -145,14 +145,14 @@ namespace interface {
* Sequence diagram Encryption request when bonding information is available * Sequence diagram Encryption request when bonding information is available
* *
* \verbatim * \verbatim
* /----------- Device 1 --------------\ *------ BLE link ------* /-------------- Device 2 -------------\ * /--------- Device 1 ---------\ *------ BLE link ------* /--------- Device 2 ---------\
* *
* App EventHandler SecurityManager SecurityManager EventHandler App * App EventHandler SecurityManager SecurityManager EventHandler App
* | | | | | | * | | | | | |
* |---------------------------> setLinkEncryption() | | | * |--------------------> setLinkEncryption() | | |
* | | |<-[encryption established]->| | | * | | |<-[encryption established]->| | |
* |<- linkEncryptionResult() <--------| |---------> linkEncryptionResult() -->| * |<- linkEncryptionResult() <-| |-> linkEncryptionResult() ->|
* | | | | | | * | | | | | |
* @endverbatim * @endverbatim
* *
* @note if bonding information is not available, pairing will be triggered * @note if bonding information is not available, pairing will be triggered
@ -162,25 +162,25 @@ namespace interface {
* and other a keyboard * and other a keyboard
* *
* \verbatim * \verbatim
* /----------- Device 1 (keyboard) ---\ *------ BLE link ------* /-------------- Device 2 (display) ---\ * /---- Device 1 (keyboard) ---\ *------ BLE link ------* /----- Device 2 (display) ---\
* *
* App EventHandler SecurityManager SecurityManager EventHandler App * App EventHandler SecurityManager SecurityManager EventHandler App
* | | | | | | * | | | | | |
* |---------------------------> requestPairing() | | | * |--------------------> requestPairing() | | |
* | | |------[pairing start]------>| | | * | | |------[pairing start]------>| | |
* | | | |----------------> pairingRequest() ->| * | | | |-------> pairingRequest() ->|
* | | | acceptPairing() <------------------------ | * | | | acceptPairing() <--------------- |
* | | |<---[secure con. pairing]-->| | | * | | |<---[secure con. pairing]-->| | |
* |<- passkeyRequest() <--------------| |----------------> passkeyDisplay() ->| * |<- 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() | | | * |------------------->passkeyEntered() | | |
* | | |<---[pairing complete]----->| | | * | | |<---[pairing complete]----->| | |
* |<- pairingResult() <---------------| |----------------> pairingResult() -->| * |<- pairingResult() <--------| |-------> pairingResult() -->|
* | | | | | | * | | | | | |
* @endverbatim * @endverbatim
* *
*/ */