-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
document the thread confinement strategy of the bandmap feature
- Loading branch information
Showing
1 changed file
with
373 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,373 @@ | ||
| # Bandmap Thread Confinement | ||
|
|
||
| The following is a detailed analysis of the thread confinement strategy used in the bandmap feature. I use a bunch of plantuml diagrams to visualize the overall call graph (mis-using a component diagram) and a detailed view on most stimuli using sequence diagrams. | ||
|
|
||
| In context of the bandmap feature, keeping track of which thread is doing what is rather complicated because of the complex event system of the tree view widget. This analysis helped me a lot to keep things nice and working. | ||
|
|
||
| ## Overall Call Graph | ||
|
|
||
| ```plantuml | ||
| @startuml | ||
| ' Component Structure | ||
| component spotsTableView { | ||
| [spotsTableView.setupSpotsTableView]<<gtk>> | ||
| [spotsTableView.fillEntryToTableRow]<<gtk>> | ||
| [spotsTableView.updateHighlightedColumns]<<gtk>> | ||
| [spotsTableView.filterTableRow]<<gtk>> | ||
| [spotsTableView.showInitialFrameInTable]<<gtk>> | ||
| [spotsTableView.addTableEntry]<<gtk>> | ||
| [spotsTableView.updateTableEntry]<<gtk>> | ||
| [spotsTableView.removeTableEntry]<<gtk>> | ||
| [spotsTableView.revealTableEntry]<<gtk>> | ||
| [spotsTableView.refreshTable]<<gtk>> | ||
| [spotsTableView.tableRowByIndex]<<gtk>> | ||
| [spotsTableView.activateTableSelection]<<gtk>> | ||
| [spotsTableView.onTableSelectionChanged]<<gtk>> | ||
| [spotsTableView.getSelectedIndex]<<gtk>> | ||
| [spotsTableView.createSpotMarkupColumn] | ||
| [spotsTableView.createSpotTextColumn] | ||
| [spotsTableView.createSpotListStore] | ||
| [spotsTableView.getEntryColor] | ||
| [spotsTableView.formatSpotFrequency] | ||
| [spotsTableView.formatSpotCall] | ||
| [spotsTableView.formatPoints] | ||
| [spotsTableView.formatSpotAge] | ||
| [spotsTableView.getDXCCInformation] | ||
| [spotsTableView.tableRowByIndex]<<gtk>> | ||
| } | ||
| component SpotsController { | ||
| [SpotsController.EntryVisible] | ||
| [SpotsController.SelectEntry] | ||
| [SpotsController.SetVisibleBand] | ||
| [SpotsController.SetActiveBand] | ||
| [SpotsController.RemainingLifetime] | ||
| } | ||
| component spotsView { | ||
| [spotsView.setupSpotsView]<<gtk>> | ||
| [spotsView.setupBands]<<gtk>> | ||
| [spotsView.newBand]<<gtk>> | ||
| [spotsView.updateBand]<<gtk>> | ||
| [spotsView.updateBands]<<gtk>> | ||
| [spotsView.selectBand]<<gtk>> | ||
| [spotsView.ShowFrame]<<runAsync>> | ||
| [spotsView.EntryAdded]<<runAsync>> | ||
| [spotsView.EntryUpdated]<<runAsync>> | ||
| [spotsView.EntryRemoved]<<runAsync>> | ||
| [spotsView.EntrySelected]<<runAsync>> | ||
| [spotsView.RevealEntry]<<runAsync>> | ||
| } | ||
| ' Stimuli | ||
| [ui]<<gtk>> | ||
| [ui] --> [spotsView.setupSpotsView] | ||
| [ui] --> [spotsView.selectBand] | ||
| [ui] --> [spotsTableView.activateTableSelection] | ||
| [ui] --> [spotsTableView.onTableSelectionChanged] | ||
| [SpotsController] --> [spotsView.ShowFrame] | ||
| [SpotsController] --> [spotsView.EntryAdded] | ||
| [SpotsController] --> [spotsView.EntryUpdated] | ||
| [SpotsController] --> [spotsView.EntryRemoved] | ||
| [SpotsController] --> [spotsView.EntrySelected] | ||
| [SpotsController] --> [spotsView.RevealEntry] | ||
| [gtk.TreeModelFilter] --> [spotsTableView.filterTableRow] | ||
| ' Interactions | ||
| [spotsTableView.setupSpotsTableView] --> [spotsTableView.createSpotMarkupColumn] | ||
| [spotsTableView.setupSpotsTableView] --> [spotsTableView.createSpotTextColumn] | ||
| [spotsTableView.setupSpotsTableView] --> [spotsTableView.createSpotListStore] | ||
| [spotsTableView.setupSpotsTableView] --> [gtk] | ||
| [spotsTableView.fillEntryToTableRow] --> [spotsTableView.getEntryColor] | ||
| [spotsTableView.fillEntryToTableRow] --> [spotsTableView.formatSpotFrequency] | ||
| [spotsTableView.fillEntryToTableRow] --> [spotsTableView.formatSpotCall] | ||
| [spotsTableView.fillEntryToTableRow] --> [spotsTableView.formatPoints] | ||
| [spotsTableView.fillEntryToTableRow] --> [spotsTableView.formatSpotAge] | ||
| [spotsTableView.fillEntryToTableRow] --> [spotsTableView.getDXCCInformation] | ||
| [spotsTableView.fillEntryToTableRow] --> [gtk] | ||
| [spotsTableView.updateHighlightedColumns] --> [spotsTableView.tableRowByIndex] | ||
| [spotsTableView.updateHighlightedColumns] --> [spotsTableView.formatSpotFrequency] | ||
| [spotsTableView.updateHighlightedColumns] --> [spotsTableView.formatSpotCall] | ||
| [spotsTableView.updateHighlightedColumns] --> [spotsTableView.formatSpotAge] | ||
| [spotsTableView.filterTableRow] --> [SpotsController.EntryVisible] | ||
| [spotsTableView.filterTableRow] --> [gtk] | ||
| [spotsTableView.showInitialFrameInTable] --> [spotsTableView.fillEntryToTableRow] | ||
| [spotsTableView.showInitialFrameInTable] --> [gtk] | ||
| [spotsTableView.addTableEntry] --> [spotsTableView.fillEntryToTableRow] | ||
| [spotsTableView.addTableEntry] --> [gtk] | ||
| [spotsTableView.updateTableEntry] --> [spotsTableView.tableRowByIndex] | ||
| [spotsTableView.updateTableEntry] --> [spotsTableView.fillEntryToTableRow] | ||
| [spotsTableView.removeTableEntry] --> [spotsTableView.tableRowByIndex] | ||
| [spotsTableView.removeTableEntry] --> [spotsTableView.fillEntryToTableRow] | ||
| [spotsTableView.revealTableEntry] --> [SpotsController.EntryVisible] | ||
| [spotsTableView.revealTableEntry] --> [gtk] | ||
| [spotsTableView.refreshTable] --> [gtk] | ||
| [spotsTableView.tableRowByIndex] --> [gtk] | ||
| [spotsTableView.activateTableSelection] --> [gtk] | ||
| [spotsTableView.onTableSelectionChanged] --> [spotsTableView.getSelectedIndex] | ||
| [spotsTableView.onTableSelectionChanged] --> [SpotsController.SelectEntry] | ||
| [spotsTableView.onTableSelectionChanged] --> [gtk] | ||
| [spotsTableView.getSelectedIndex] --> [gtk] | ||
| [spotsView.setupSpotsView] --> [spotsTableView.setupSpotsTableView] | ||
| [spotsView.setupBands] --> [spotsView.newBand] | ||
| [spotsView.setupBands] --> [gtk] | ||
| [spotsView.newBand] --> [spotsView.updateBand] | ||
| [spotsView.newBand] --> [gtk] | ||
| [spotsView.updateBand] --> [gtk] | ||
| [spotsView.updateBands] --> [gtk] | ||
| [spotsView.selectBand] --> [SpotsController.SetVisibleBand] | ||
| [spotsView.selectBand] --> [SpotsController.SetActiveBand] | ||
| [spotsView.selectBand] --> [gtk] | ||
| [spotsView.ShowFrame] --> [spotsView.setupBands] | ||
| [spotsView.ShowFrame] --> [spotsView.updateBands] | ||
| [spotsView.ShowFrame] --> [spotsTableView.showInitialFrameInTable] | ||
| [spotsView.ShowFrame] --> [spotsTableView.refreshTable] | ||
| [spotsView.ShowFrame] --> [spotsTableView.updateHighlightedColumns] | ||
| [spotsView.ShowFrame] --> [spotsTableView.revealTableEntry] | ||
| [spotsView.EntryAdded] --> [spotsTableView.addTableEntry] | ||
| [spotsView.EntryUpdated] --> [spotsTableView.updateTableEntry] | ||
| [spotsView.EntryRemoved] --> [spotsTableView.removeTableEntry] | ||
| [spotsView.EntrySelected] --> [spotsTableView.revealTableEntry] | ||
| [spotsView.RevealEntry] --> [spotsTableView.revealTableEntry] | ||
| @enduml | ||
| ``` | ||
|
|
||
| ## Select the visible band | ||
|
|
||
| ```plantuml | ||
| @startuml | ||
| actor ui | ||
| ui --> spotsView:selectBand | ||
| spotsView --> SpotsController:SetVisibleBand | ||
| SpotsController --> SpotsController:do | ||
| activate SpotsController | ||
| group confine to bandmap, sync | ||
| note right: set visible frequency for next frame | ||
| SpotsController --> SpotsController: update | ||
| SpotsController --> spotsView: ShowFrame | ||
| end | ||
| deactivate SpotsController | ||
| spotsView --> spotsView:runAsync | ||
| activate spotsView | ||
| group later in the UI | ||
| spotsView --> spotsView:setupBands | ||
| spotsView --> spotsView:updateBands | ||
| spotsView --> spotsTableView:showInitialFrameInTable | ||
| spotsView --> spotsTableView:refreshTable | ||
| spotsView --> spotsTableView:updateHighlightedColumns | ||
| spotsView --> spotsTableView:revealTableEntry | ||
| spotsTableView --> SpotsController:EntryVisible | ||
| SpotsController --> SpotsController:do | ||
| activate SpotsController | ||
| group confine to bandmap, sync | ||
| SpotsController --> SpotsController:entryVisible | ||
| end | ||
| deactivate SpotsController | ||
| end | ||
| deactivate spotsView | ||
| @enduml | ||
| ``` | ||
|
|
||
| ## Select the active band | ||
|
|
||
| ```plantuml | ||
| @startuml | ||
| actor ui | ||
| ui --> spotsView:selectBand | ||
| spotsView --> SpotsController:SetActiveBand | ||
| SpotsController --> vfo:SetBand | ||
| activate vfo | ||
| vfo --> SpotsController:VFOFrequencyChanged | ||
| SpotsController --> SpotsController:do | ||
| note right: set activeFrequency for next frame | ||
| vfo --> SpotsController:VFOBandChanged | ||
| deactivate vfo | ||
| SpotsController --> SpotsController:do | ||
| activate SpotsController | ||
| group confine to bandmap, sync | ||
| note right: set activeBand, visibleBand for the next frame | ||
| SpotsController --> SpotsController:update | ||
| SpotsController --> spotsView:ShowFrame | ||
| end | ||
| deactivate SpotsController | ||
| spotsView --> spotsView:runAsync | ||
| activate spotsView | ||
| group later in the UI | ||
| spotsView --> spotsView:setupBands | ||
| spotsView --> spotsView:updateBands | ||
| spotsView --> spotsTableView:showInitialFrameInTable | ||
| spotsView --> spotsTableView:refreshTable | ||
| spotsView --> spotsTableView:updateHighlightedColumns | ||
| spotsView --> spotsTableView:revealTableEntry | ||
| spotsTableView --> SpotsController:EntryVisible | ||
| SpotsController --> SpotsController:do | ||
| activate SpotsController | ||
| group confine to bandmap, sync | ||
| SpotsController --> SpotsController:entryVisible | ||
| end | ||
| deactivate SpotsController | ||
| end | ||
| deactivate spotsView | ||
| @enduml | ||
| ``` | ||
|
|
||
| ## Select a table entry | ||
|
|
||
| ```plantuml | ||
| @startuml | ||
| actor ui | ||
| ui --> spotsTableView:onTableSelectionChanged | ||
| spotsTableView --> spotsTableView:getSelectedIndex | ||
| spotsTableView --> gtk | ||
| spotsTableView --> SpotsController:SelectEntry | ||
| SpotsController --> SpotsController:do | ||
| activate SpotsController | ||
| group confine to bandmap, sync | ||
| SpotsController --> entries:Select | ||
| entries --> spotsView:EntrySelected | ||
| end | ||
| deactivate SpotsController | ||
| spotsView --> spotsView:runAsync | ||
| activate spotsView | ||
| group later in the UI | ||
| spotsView --> spotsTableView:revealTableEntry | ||
| spotsTableView --> SpotsController:EntryVisible | ||
| SpotsController --> SpotsController:do | ||
| activate SpotsController | ||
| group confine to bandmap, sync | ||
| SpotsController --> SpotsController:entryVisible | ||
| end | ||
| deactivate SpotsController | ||
| end | ||
| deactivate spotsView | ||
| @enduml | ||
| ``` | ||
|
|
||
| ## Add an entry coming from the DX cluster | ||
|
|
||
| ```plantuml | ||
| @startuml | ||
| SpotsController --> spotsView:EntryAdded | ||
| spotsView --> spotsView:runAsync | ||
| activate spotsView | ||
| group later in the UI | ||
| spotsView --> spotsTableView:addTableEntry | ||
| spotsTableView --> gtk.ListStore:Insert | ||
| spotsTableView --> spotsTableView:fillEntryToTableRow | ||
| spotsTableView --> gtk.ListStore:Set | ||
| end | ||
| deactivate spotsView | ||
| @enduml | ||
| ``` | ||
|
|
||
| ## Update an existing table entry due to changes coming from the DX cluster | ||
|
|
||
| ```plantuml | ||
| @startuml | ||
| SpotsController --> spotsView:EntryUpdated | ||
| spotsView --> spotsView:runAsync | ||
| activate spotsView | ||
| group later in the UI | ||
| spotsView --> spotsTableView:updateTableEntry | ||
| spotsTableView --> spotsTableView:tableRowByIndex | ||
| spotsTableView --> gtk.ListStore:GetIterFromString | ||
| spotsTableView --> spotsTableView:fillEntryToTableRow | ||
| spotsTableView --> gtk.ListStore:Set | ||
| end | ||
| deactivate spotsView | ||
| @enduml | ||
| ``` | ||
|
|
||
| ## Remove a stale table entry | ||
|
|
||
| ```plantuml | ||
| @startuml | ||
| SpotsController --> spotsView:EntryRemoved | ||
| spotsView --> spotsView:runAsync | ||
| activate spotsView | ||
| group later in the UI | ||
| spotsView --> spotsTableView:removeTableEntry | ||
| spotsTableView --> spotsTableView:tableRowByIndex | ||
| spotsTableView --> gtk.ListStore:GetIterFromString | ||
| spotsTableView --> gtk.ListStore:Remove | ||
| end | ||
| deactivate spotsView | ||
| @enduml | ||
| ``` | ||
|
|
||
| ## Reveal an entry | ||
|
|
||
| ```plantuml | ||
| @startuml | ||
| SpotsController --> spotsView:RevealEntry | ||
| spotsView --> spotsView:runAsync | ||
| activate spotsView | ||
| group later in the UI | ||
| spotsView --> spotsTableView:revealTableEntry | ||
| spotsTableView --> SpotsController:EntryVisible | ||
| SpotsController --> SpotsController:do | ||
| activate SpotsController | ||
| group confine to bandmap, sync | ||
| SpotsController --> SpotsController:entryVisible | ||
| end | ||
| deactivate SpotsController | ||
| spotsTableView --> gtk.ListStore:GetIterFromString | ||
| spotsTableView --> gtk.ListStore:GetPath | ||
| spotsTableView --> gtk.TreeView:GetColumn | ||
| end | ||
| deactivate spotsView | ||
| @enduml | ||
| ``` |