Data Fields
settings_scope Struct Reference

A setting scope. More...

#include <settings.h>

Data Fields

uint8_t dummy
 Dummy field. More...

Detailed Description

A setting scope.

Users can construct tags for settings that are not explicitly known to iPXE using the generic syntax for numerical settings. For example, the setting name "60" will be interpreted as referring to DHCP option 60 (the vendor class identifier).

This creates a potential for namespace collisions, since the interpretation of the numerical description will vary according to the settings block. When a user attempts to fetch a generic numerical setting, we need to ensure that only the intended settings blocks interpret this numerical description. (For example, we do not want to attempt to retrieve the subnet mask from SMBIOS, or the system UUID from DHCP.)

This potential problem is resolved by including a user-invisible "scope" within the definition of each setting. Settings blocks may use this to determine whether or not the setting is applicable. Any settings constructed from a numerical description (e.g. "smbios/1.4.0") will be assigned the default scope of the settings block specified in the description (e.g. "smbios"); this provides behaviour matching the user's expectations in most circumstances.

Definition at line 176 of file settings.h.

Field Documentation

◆ dummy

uint8_t settings_scope::dummy

Dummy field.

This is included only to ensure that pointers to different scopes always compare differently.

Definition at line 182 of file settings.h.

The documentation for this struct was generated from the following file: