brailcom/speechd

Adding user data context parameter to callbacks

Open

#856 opened on Sep 16, 2023

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C (86 forks)auto 404
enhancementgood first issuehelp wantedpriority

Repository metrics

Stars
 (325 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe.

When a callback is called, it is generally useful to have the context of the callback (e.g. OO container etc.)

Describe the solution you'd like

The callbacks should have an additional pointer parameter that can be decided at callback registration.

Describe alternatives you've considered

Using client_id is possible, but not very convenient.

Contributor guide

Research direction
Examine the existing callback registration mechanism in speech dispatcher source code. Add a void* user data field to the callback structure and corresponding registration functions. Pass the user data pointer when the callback is invoked. Update all existing callbacks to accept the new parameter, ensuring backward compatibility by providing a default NULL value.
Tech stack
c
Domain
api
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45