Consistently name AsyncResp variables
In about half of our code, AsyncResp objects take the name asyncResp,
and in the other half they take the name aResp. While the difference
between them is negligeble and arbitrary, having two naming conventions
makes it more difficult to do automated changes over time via grep.
This commit was generated automtatically with the command:
git grep -l 'aResp' | xargs sed -i 's|aResp|asyncResp|g'
Tested: Code compiles.
Change-Id: Id363437b6a78f51e91cbf60aa0a0c2286f36a037
Signed-off-by: Ed Tanous <edtanous@google.com>
diff --git a/redfish-core/lib/pcie.hpp b/redfish-core/lib/pcie.hpp
index f98d6c8..1c36b18 100644
--- a/redfish-core/lib/pcie.hpp
+++ b/redfish-core/lib/pcie.hpp
@@ -38,7 +38,7 @@
static inline void handlePCIeDevicePath(
const std::string& pcieDeviceId,
- const std::shared_ptr<bmcweb::AsyncResp>& aResp,
+ const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const dbus::utility::MapperGetSubTreePathsResponse& pcieDevicePaths,
const std::function<void(const std::string& pcieDevicePath,
const std::string& service)>& callback)
@@ -55,13 +55,13 @@
dbus::utility::getDbusObject(
pcieDevicePath, {},
- [pcieDevicePath, aResp,
+ [pcieDevicePath, asyncResp,
callback](const boost::system::error_code& ec,
const dbus::utility::MapperGetObject& object) {
if (ec || object.empty())
{
BMCWEB_LOG_ERROR << "DBUS response error " << ec;
- messages::internalError(aResp->res);
+ messages::internalError(asyncResp->res);
return;
}
callback(pcieDevicePath, object.begin()->first);
@@ -70,61 +70,63 @@
}
BMCWEB_LOG_WARNING << "PCIe Device not found";
- messages::resourceNotFound(aResp->res, "PCIeDevice", pcieDeviceId);
+ messages::resourceNotFound(asyncResp->res, "PCIeDevice", pcieDeviceId);
}
static inline void getValidPCIeDevicePath(
const std::string& pcieDeviceId,
- const std::shared_ptr<bmcweb::AsyncResp>& aResp,
+ const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const std::function<void(const std::string& pcieDevicePath,
const std::string& service)>& callback)
{
dbus::utility::getSubTreePaths(
inventoryPath, 0, pcieDeviceInterface,
- [pcieDeviceId, aResp,
+ [pcieDeviceId, asyncResp,
callback](const boost::system::error_code& ec,
const dbus::utility::MapperGetSubTreePathsResponse&
pcieDevicePaths) {
if (ec)
{
BMCWEB_LOG_ERROR << "D-Bus response error on GetSubTree " << ec;
- messages::internalError(aResp->res);
+ messages::internalError(asyncResp->res);
return;
}
- handlePCIeDevicePath(pcieDeviceId, aResp, pcieDevicePaths, callback);
+ handlePCIeDevicePath(pcieDeviceId, asyncResp, pcieDevicePaths,
+ callback);
return;
});
}
static inline void handlePCIeDeviceCollectionGet(
crow::App& app, const crow::Request& req,
- const std::shared_ptr<bmcweb::AsyncResp>& aResp,
+ const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const std::string& systemName)
{
- if (!redfish::setUpRedfishRoute(app, req, aResp))
+ if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
if (systemName != "system")
{
- messages::resourceNotFound(aResp->res, "ComputerSystem", systemName);
+ messages::resourceNotFound(asyncResp->res, "ComputerSystem",
+ systemName);
return;
}
- aResp->res.addHeader(boost::beast::http::field::link,
- "</redfish/v1/JsonSchemas/PCIeDeviceCollection/"
- "PCIeDeviceCollection.json>; rel=describedby");
- aResp->res.jsonValue["@odata.type"] =
+ asyncResp->res.addHeader(boost::beast::http::field::link,
+ "</redfish/v1/JsonSchemas/PCIeDeviceCollection/"
+ "PCIeDeviceCollection.json>; rel=describedby");
+ asyncResp->res.jsonValue["@odata.type"] =
"#PCIeDeviceCollection.PCIeDeviceCollection";
- aResp->res.jsonValue["@odata.id"] =
+ asyncResp->res.jsonValue["@odata.id"] =
"/redfish/v1/Systems/system/PCIeDevices";
- aResp->res.jsonValue["Name"] = "PCIe Device Collection";
- aResp->res.jsonValue["Description"] = "Collection of PCIe Devices";
- aResp->res.jsonValue["Members"] = nlohmann::json::array();
- aResp->res.jsonValue["Members@odata.count"] = 0;
+ asyncResp->res.jsonValue["Name"] = "PCIe Device Collection";
+ asyncResp->res.jsonValue["Description"] = "Collection of PCIe Devices";
+ asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
+ asyncResp->res.jsonValue["Members@odata.count"] = 0;
collection_util::getCollectionMembers(
- aResp, boost::urls::url("/redfish/v1/Systems/system/PCIeDevices"),
+ asyncResp, boost::urls::url("/redfish/v1/Systems/system/PCIeDevices"),
pcieDeviceInterface);
}
@@ -178,48 +180,50 @@
return std::nullopt;
}
-inline void getPCIeDeviceState(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
- const std::string& pcieDevicePath,
- const std::string& service)
+inline void
+ getPCIeDeviceState(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
+ const std::string& pcieDevicePath,
+ const std::string& service)
{
sdbusplus::asio::getProperty<bool>(
*crow::connections::systemBus, service, pcieDevicePath,
"xyz.openbmc_project.Inventory.Item", "Present",
- [aResp](const boost::system::error_code& ec, const bool value) {
+ [asyncResp](const boost::system::error_code& ec, const bool value) {
if (ec)
{
if (ec.value() != EBADR)
{
BMCWEB_LOG_ERROR << "DBUS response error for State";
- messages::internalError(aResp->res);
+ messages::internalError(asyncResp->res);
}
return;
}
if (!value)
{
- aResp->res.jsonValue["Status"]["State"] = "Absent";
+ asyncResp->res.jsonValue["Status"]["State"] = "Absent";
}
});
}
-inline void getPCIeDeviceAsset(const std::shared_ptr<bmcweb::AsyncResp>& aResp,
- const std::string& pcieDevicePath,
- const std::string& service)
+inline void
+ getPCIeDeviceAsset(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
+ const std::string& pcieDevicePath,
+ const std::string& service)
{
sdbusplus::asio::getAllProperties(
*crow::connections::systemBus, service, pcieDevicePath,
"xyz.openbmc_project.Inventory.Decorator.Asset",
- [pcieDevicePath,
- aResp{aResp}](const boost::system::error_code& ec,
- const dbus::utility::DBusPropertiesMap& assetList) {
+ [pcieDevicePath, asyncResp{asyncResp}](
+ const boost::system::error_code& ec,
+ const dbus::utility::DBusPropertiesMap& assetList) {
if (ec)
{
if (ec.value() != EBADR)
{
BMCWEB_LOG_ERROR << "DBUS response error for Properties"
<< ec.value();
- messages::internalError(aResp->res);
+ messages::internalError(asyncResp->res);
}
return;
}
@@ -237,32 +241,32 @@
if (!success)
{
- messages::internalError(aResp->res);
+ messages::internalError(asyncResp->res);
return;
}
if (manufacturer != nullptr)
{
- aResp->res.jsonValue["Manufacturer"] = *manufacturer;
+ asyncResp->res.jsonValue["Manufacturer"] = *manufacturer;
}
if (model != nullptr)
{
- aResp->res.jsonValue["Model"] = *model;
+ asyncResp->res.jsonValue["Model"] = *model;
}
if (partNumber != nullptr)
{
- aResp->res.jsonValue["PartNumber"] = *partNumber;
+ asyncResp->res.jsonValue["PartNumber"] = *partNumber;
}
if (serialNumber != nullptr)
{
- aResp->res.jsonValue["SerialNumber"] = *serialNumber;
+ asyncResp->res.jsonValue["SerialNumber"] = *serialNumber;
}
if (sparePartNumber != nullptr && !sparePartNumber->empty())
{
- aResp->res.jsonValue["SparePartNumber"] = *sparePartNumber;
+ asyncResp->res.jsonValue["SparePartNumber"] = *sparePartNumber;
}
});
}
@@ -321,7 +325,7 @@
}
inline void getPCIeDeviceProperties(
- const std::shared_ptr<bmcweb::AsyncResp>& aResp,
+ const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const std::string& pcieDevicePath, const std::string& service,
const std::function<void(
const dbus::utility::DBusPropertiesMap& pcieDevProperties)>&& callback)
@@ -329,7 +333,7 @@
sdbusplus::asio::getAllProperties(
*crow::connections::systemBus, service, pcieDevicePath,
"xyz.openbmc_project.Inventory.Item.PCIeDevice",
- [aResp,
+ [asyncResp,
callback](const boost::system::error_code& ec,
const dbus::utility::DBusPropertiesMap& pcieDevProperties) {
if (ec)
@@ -337,7 +341,7 @@
if (ec.value() != EBADR)
{
BMCWEB_LOG_ERROR << "DBUS response error for Properties";
- messages::internalError(aResp->res);
+ messages::internalError(asyncResp->res);
}
return;
}
@@ -346,47 +350,49 @@
}
inline void addPCIeDeviceCommonProperties(
- const std::shared_ptr<bmcweb::AsyncResp>& aResp,
+ const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const std::string& pcieDeviceId)
{
- aResp->res.addHeader(
+ asyncResp->res.addHeader(
boost::beast::http::field::link,
"</redfish/v1/JsonSchemas/PCIeDevice/PCIeDevice.json>; rel=describedby");
- aResp->res.jsonValue["@odata.type"] = "#PCIeDevice.v1_9_0.PCIeDevice";
- aResp->res.jsonValue["@odata.id"] = boost::urls::format(
+ asyncResp->res.jsonValue["@odata.type"] = "#PCIeDevice.v1_9_0.PCIeDevice";
+ asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
"/redfish/v1/Systems/system/PCIeDevices/{}", pcieDeviceId);
- aResp->res.jsonValue["Name"] = "PCIe Device";
- aResp->res.jsonValue["Id"] = pcieDeviceId;
- aResp->res.jsonValue["Status"]["State"] = "Enabled";
+ asyncResp->res.jsonValue["Name"] = "PCIe Device";
+ asyncResp->res.jsonValue["Id"] = pcieDeviceId;
+ asyncResp->res.jsonValue["Status"]["State"] = "Enabled";
}
-inline void handlePCIeDeviceGet(App& app, const crow::Request& req,
- const std::shared_ptr<bmcweb::AsyncResp>& aResp,
- const std::string& systemName,
- const std::string& pcieDeviceId)
+inline void
+ handlePCIeDeviceGet(App& app, const crow::Request& req,
+ const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
+ const std::string& systemName,
+ const std::string& pcieDeviceId)
{
- if (!redfish::setUpRedfishRoute(app, req, aResp))
+ if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
if (systemName != "system")
{
- messages::resourceNotFound(aResp->res, "ComputerSystem", systemName);
+ messages::resourceNotFound(asyncResp->res, "ComputerSystem",
+ systemName);
return;
}
getValidPCIeDevicePath(
- pcieDeviceId, aResp,
- [aResp, pcieDeviceId](const std::string& pcieDevicePath,
- const std::string& service) {
- addPCIeDeviceCommonProperties(aResp, pcieDeviceId);
- getPCIeDeviceAsset(aResp, pcieDevicePath, service);
- getPCIeDeviceState(aResp, pcieDevicePath, service);
+ pcieDeviceId, asyncResp,
+ [asyncResp, pcieDeviceId](const std::string& pcieDevicePath,
+ const std::string& service) {
+ addPCIeDeviceCommonProperties(asyncResp, pcieDeviceId);
+ getPCIeDeviceAsset(asyncResp, pcieDevicePath, service);
+ getPCIeDeviceState(asyncResp, pcieDevicePath, service);
getPCIeDeviceProperties(
- aResp, pcieDevicePath, service,
- [aResp, pcieDeviceId](
+ asyncResp, pcieDevicePath, service,
+ [asyncResp, pcieDeviceId](
const dbus::utility::DBusPropertiesMap& pcieDevProperties) {
- addPCIeDeviceProperties(aResp->res, pcieDeviceId,
+ addPCIeDeviceProperties(asyncResp->res, pcieDeviceId,
pcieDevProperties);
});
});
@@ -439,34 +445,35 @@
inline void handlePCIeFunctionCollectionGet(
App& app, const crow::Request& req,
- const std::shared_ptr<bmcweb::AsyncResp>& aResp,
+ const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const std::string& pcieDeviceId)
{
- if (!redfish::setUpRedfishRoute(app, req, aResp))
+ if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
getValidPCIeDevicePath(
- pcieDeviceId, aResp,
- [aResp, pcieDeviceId](const std::string& pcieDevicePath,
- const std::string& service) {
- aResp->res.addHeader(
+ pcieDeviceId, asyncResp,
+ [asyncResp, pcieDeviceId](const std::string& pcieDevicePath,
+ const std::string& service) {
+ asyncResp->res.addHeader(
boost::beast::http::field::link,
"</redfish/v1/JsonSchemas/PCIeFunctionCollection/PCIeFunctionCollection.json>; rel=describedby");
- aResp->res.jsonValue["@odata.type"] =
+ asyncResp->res.jsonValue["@odata.type"] =
"#PCIeFunctionCollection.PCIeFunctionCollection";
- aResp->res.jsonValue["@odata.id"] = boost::urls::format(
+ asyncResp->res.jsonValue["@odata.id"] = boost::urls::format(
"/redfish/v1/Systems/system/PCIeDevices/{}/PCIeFunctions",
pcieDeviceId);
- aResp->res.jsonValue["Name"] = "PCIe Function Collection";
- aResp->res.jsonValue["Description"] =
+ asyncResp->res.jsonValue["Name"] = "PCIe Function Collection";
+ asyncResp->res.jsonValue["Description"] =
"Collection of PCIe Functions for PCIe Device " + pcieDeviceId;
getPCIeDeviceProperties(
- aResp, pcieDevicePath, service,
- [aResp, pcieDeviceId](
+ asyncResp, pcieDevicePath, service,
+ [asyncResp, pcieDeviceId](
const dbus::utility::DBusPropertiesMap& pcieDevProperties) {
- addPCIeFunctionList(aResp->res, pcieDeviceId, pcieDevProperties);
+ addPCIeFunctionList(asyncResp->res, pcieDeviceId,
+ pcieDevProperties);
});
});
}
@@ -576,11 +583,11 @@
inline void
handlePCIeFunctionGet(App& app, const crow::Request& req,
- const std::shared_ptr<bmcweb::AsyncResp>& aResp,
+ const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const std::string& pcieDeviceId,
const std::string& pcieFunctionIdStr)
{
- if (!redfish::setUpRedfishRoute(app, req, aResp))
+ if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
@@ -589,31 +596,25 @@
&*pcieFunctionIdStr.begin(), &*pcieFunctionIdStr.end(), pcieFunctionId);
if (result.ec != std::errc{} || result.ptr != &*pcieFunctionIdStr.end())
{
- messages::resourceNotFound(aResp->res, "PCIeFunction",
+ messages::resourceNotFound(asyncResp->res, "PCIeFunction",
pcieFunctionIdStr);
return;
}
- getValidPCIeDevicePath(
- pcieDeviceId, aResp,
- [aResp, pcieDeviceId, pcieFunctionId](const std::string& pcieDevicePath,
- const std::string& service) {
+ getValidPCIeDevicePath(pcieDeviceId, asyncResp,
+ [asyncResp, pcieDeviceId,
+ pcieFunctionId](const std::string& pcieDevicePath,
+ const std::string& service) {
getPCIeDeviceProperties(
- aResp, pcieDevicePath, service,
- [aResp, pcieDeviceId, pcieFunctionId](
+ asyncResp, pcieDevicePath, service,
+ [asyncResp, pcieDeviceId, pcieFunctionId](
const dbus::utility::DBusPropertiesMap& pcieDevProperties) {
- if (!validatePCIeFunctionId(pcieFunctionId, pcieDevProperties))
- {
- messages::resourceNotFound(aResp->res, "PCIeFunction",
- std::to_string(pcieFunctionId));
- return;
- }
- addPCIeFunctionCommonProperties(aResp->res, pcieDeviceId,
+ addPCIeFunctionCommonProperties(asyncResp->res, pcieDeviceId,
pcieFunctionId);
- addPCIeFunctionProperties(aResp->res, pcieFunctionId,
+ addPCIeFunctionProperties(asyncResp->res, pcieFunctionId,
pcieDevProperties);
});
- });
+ });
}
inline void requestRoutesSystemPCIeFunction(App& app)