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

Expose key flags on DataCenterNode #33

Open
alexrp opened this issue May 23, 2022 · 2 comments
Open

Expose key flags on DataCenterNode #33

alexrp opened this issue May 23, 2022 · 2 comments
Assignees
Labels
area: formats Issues related to the file format APIs. state: approved Feature requests and housekeeping tasks that have been approved. type: feature Issues that are classified as feature requests.
Milestone

Comments

@alexrp
Copy link
Sponsor Member

alexrp commented May 23, 2022

// TODO: Should we allow setting 0b0001 in the API?
if (keyFlags is not 0b0000 or 0b0001)
throw new InvalidDataException($"Node has invalid key flags 0x{keyFlags:x1}.");

`key_flags` is `0` in official data center files. It may have a combination of
the following values:
```cpp
enum DataCenterKeyFlags : uint8_t
{
DATA_CENTER_KEY_FLAGS_NONE = 0b0000,
DATA_CENTER_KEY_FLAGS_UNCACHED = 0b0001,
};
```
If `DATA_CENTER_KEY_FLAGS_UNCACHED` is set, the results of a query against this
node will not be cached by the client.

@alexrp alexrp added state: deliberation Issues that require considerable deliberation and/or discussion before a resolution can be found. type: feature Issues that are classified as feature requests. area: formats Issues related to the file format APIs. labels May 23, 2022
@alexrp alexrp added this to the v2.0 milestone May 23, 2022
@alexrp alexrp self-assigned this May 23, 2022
@alexrp alexrp modified the milestones: v2.0, v3.0 Jun 11, 2022
@alexrp
Copy link
Sponsor Member Author

alexrp commented Jun 17, 2023

As of #21, we can both consume and produce deduplicated data center files, so general memory usage is down quite a bit. That fact makes this issue more palatable since adding an extra field to DataCenterNode is no longer so bad.

That said, need to think about how this will be represented in XML form.

@alexrp alexrp modified the milestones: v3.0, v2.1 Aug 17, 2023
@alexrp
Copy link
Sponsor Member Author

alexrp commented Jan 1, 2024

In XML form, we will likely just have a dc:flags attribute in the XSD, like we have dc:keys.

@alexrp alexrp added state: approved Feature requests and housekeeping tasks that have been approved. and removed state: deliberation Issues that require considerable deliberation and/or discussion before a resolution can be found. labels Jan 1, 2024
@alexrp alexrp changed the title Consider exposing key flags on DataCenterNode Expose key flags on DataCenterNode Jan 1, 2024
@alexrp alexrp modified the milestones: v2.1, Future Jan 6, 2024
@alexrp alexrp modified the milestones: Future, v4.0 Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: formats Issues related to the file format APIs. state: approved Feature requests and housekeeping tasks that have been approved. type: feature Issues that are classified as feature requests.
Development

No branches or pull requests

1 participant