`box_status` exposed in C API.
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Added new C function box_status, that can be used to get the current
status of the instance. It is either "running", "loading", "orphan" or
"hot_standby" reflecting the box.info.status Lua API behavior. The
return values are:
- running – the instance is loaded
- loading – the instance is either recovering xlogs/snapshots or
bootstrapping - orphan – the instance has not (yet) succeeded in joining the required
number of masters (see orphan status) - hot_standby – the instance is standing by another instance
const char * box_status(void);
Requested by @LevKats in https://github.com/tarantool/tarantool/commit/18f28bdf66feede9a3516d9884ebf64e6407940b.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue identifies the C API entry point as box_status and provides its signature and four status values. No documentation file or test is named, so first locate the C API reference and the existing box.info.status documentation; done means documenting box_status consistently with those semantics and return values.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100