KhronosGroup / KhronosGroup/KSCAF_DocRequirements

System-interaction: proceed with transition from mode to another mode

Open
#42 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
4
Forks
2
PR merge metrics
No merged PRs in 30d

Description

SC profile shall define means through which the API user can indicate that the API implementation may proceed with transition from the current mode to another mode.

Rationale: API-user application may invoke API functionality over a period, during which it expects the implementation to remain in a certain mode. Since the length of this period cannot be known in advance, if there is no means for the application to indicate the end of this period, the API implementation may inadvertently proceed with transition to a different mode before the end of the mentioned period.

Example: SC profile can define function Result transition(Mode paramMode) which indicates to the API implementation that the implementation may proceed with transition to mode paramMode, where Mode can be defined as enum class Mode { non_safe, safe }, and where result can be defined as enum class Result { error, in_progress, transitioned }.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the SC profile requirement in this issue and review how the API user is expected to indicate that a mode transition may proceed. Define the transition means and its outcomes, including the proposed transition(Mode paramMode) interface and the error, in_progress, and transitioned results; done means the SC profile specifies this behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.