Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Design document for keyboard handler #2

Merged
merged 7 commits into from
Jun 12, 2021

Conversation

MichaelOrlov
Copy link
Member

Design document for keyboard handler package.

Relates to the #735
Part of the #696

Moved content from ros2/rosbag2#768.
Also updated API with key modifiers in callbacks and added new section with known issues and design/implementation limitations.

MichaelOrlov and others added 7 commits June 10, 2021 01:29
Signed-off-by: Michael Orlov <morlovmr@gmail.com>
Signed-off-by: Michael Orlov <morlovmr@gmail.com>
…ss event got destructed before keyboard handler.

Signed-off-by: Michael Orlov <morlovmr@gmail.com>
… redirected to the file or stream

Signed-off-by: Michael Orlov <morlovmr@gmail.com>
…forms and abnormal program termination via Ctrl+C.

Signed-off-by: Michael Orlov <morlovmr@gmail.com>
…fiers to the callbacks

Signed-off-by: Michael Orlov <michael.orlov@apex.ai>
Signed-off-by: Michael Orlov <michael.orlov@apex.ai>
Copy link
Contributor

@emersonknapp emersonknapp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@MichaelOrlov MichaelOrlov merged commit b1bb170 into main Jun 12, 2021
emersonknapp pushed a commit that referenced this pull request Jun 16, 2021
* Initial creation of the keyboard handler design document

Signed-off-by: Michael Orlov <morlovmr@gmail.com>

* Add design requirements

Signed-off-by: Michael Orlov <morlovmr@gmail.com>

* Add content for the case when client's code subscribed to the key press event got destructed before keyboard handler.

Signed-off-by: Michael Orlov <morlovmr@gmail.com>

* Add content for the case when standard input from terminal or console redirected to the file or stream

Signed-off-by: Michael Orlov <morlovmr@gmail.com>

* Add content for handling input from keyboard on POSIX compatible platforms and abnormal program termination via Ctrl+C.

Signed-off-by: Michael Orlov <morlovmr@gmail.com>

* Update design doc with new API changes related to the adding key modifiers to the callbacks

Signed-off-by: Michael Orlov <michael.orlov@apex.ai>

* Added `known issues` section to the design document.

Signed-off-by: Michael Orlov <michael.orlov@apex.ai>
sloretz added a commit to sloretz/keyboard_handler that referenced this pull request Jan 14, 2022
Signed-off-by: Shane Loretz <sloretz@osrfoundation.org>
@clalancette clalancette deleted the michaelorlov/add-design-for-keyboard_handler branch July 24, 2023 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants