summaryrefslogtreecommitdiffstats
path: root/host-cmd-manager.hpp
diff options
context:
space:
mode:
authorPatrick Venture <venture@google.com>2018-08-31 11:55:55 -0700
committerPatrick Venture <venture@google.com>2018-09-07 23:45:41 +0000
commit0b02be925a29357f69abbc9e9a58e7c5aaed2eab (patch)
treec1b39f817d98ffda7b987f9e3f864f576e3bf9ea /host-cmd-manager.hpp
parent26f80ab2cc41deadc913190d906f71266c4ed224 (diff)
downloadphosphor-host-ipmid-0b02be925a29357f69abbc9e9a58e7c5aaed2eab.tar.gz
phosphor-host-ipmid-0b02be925a29357f69abbc9e9a58e7c5aaed2eab.zip
add .clang-format
Change-Id: I7c2a527b4751a560703a61fcbe9638b150546af5 Signed-off-by: Patrick Venture <venture@google.com>
Diffstat (limited to 'host-cmd-manager.hpp')
-rw-r--r--host-cmd-manager.hpp154
1 files changed, 77 insertions, 77 deletions
diff --git a/host-cmd-manager.hpp b/host-cmd-manager.hpp
index c25706c..949e798 100644
--- a/host-cmd-manager.hpp
+++ b/host-cmd-manager.hpp
@@ -1,11 +1,11 @@
#pragma once
-#include <tuple>
+#include <host-ipmid/ipmid-host-cmd-utils.hpp>
#include <queue>
#include <sdbusplus/bus.hpp>
#include <sdbusplus/bus/match.hpp>
#include <timer.hpp>
-#include <host-ipmid/ipmid-host-cmd-utils.hpp>
+#include <tuple>
namespace phosphor
{
@@ -19,92 +19,92 @@ namespace command
*/
class Manager
{
- public:
- Manager() = delete;
- ~Manager() = default;
- Manager(const Manager&) = delete;
- Manager& operator=(const Manager&) = delete;
- Manager(Manager&&) = delete;
- Manager& operator=(Manager&&) = delete;
+ public:
+ Manager() = delete;
+ ~Manager() = default;
+ Manager(const Manager&) = delete;
+ Manager& operator=(const Manager&) = delete;
+ Manager(Manager&&) = delete;
+ Manager& operator=(Manager&&) = delete;
- /** @brief Constructs Manager object
- *
- * @param[in] bus - dbus handler
- * @param[in] event - pointer to sd_event
- */
- Manager(sdbusplus::bus::bus& bus, sd_event* event);
+ /** @brief Constructs Manager object
+ *
+ * @param[in] bus - dbus handler
+ * @param[in] event - pointer to sd_event
+ */
+ Manager(sdbusplus::bus::bus& bus, sd_event* event);
- /** @brief Extracts the next entry in the queue and returns
- * Command and data part of it.
- *
- * @detail Also calls into the registered handlers so that they can now
- * send the CommandComplete signal since the interface contract
- * is that we emit this signal once the message has been
- * passed to the host (which is required when calling this)
- *
- * Also, if the queue has more commands, then it will alert the
- * host
- */
- IpmiCmdData getNextCommand();
+ /** @brief Extracts the next entry in the queue and returns
+ * Command and data part of it.
+ *
+ * @detail Also calls into the registered handlers so that they can now
+ * send the CommandComplete signal since the interface contract
+ * is that we emit this signal once the message has been
+ * passed to the host (which is required when calling this)
+ *
+ * Also, if the queue has more commands, then it will alert the
+ * host
+ */
+ IpmiCmdData getNextCommand();
- /** @brief Pushes the command onto the queue.
- *
- * @detail If the queue is empty, then it alerts the Host. If not,
- * then it returns and the API documented above will handle
- * the commands in Queue.
- *
- * @param[in] command - tuple of <IPMI command, data, callback>
- */
- void execute(CommandHandler command);
+ /** @brief Pushes the command onto the queue.
+ *
+ * @detail If the queue is empty, then it alerts the Host. If not,
+ * then it returns and the API documented above will handle
+ * the commands in Queue.
+ *
+ * @param[in] command - tuple of <IPMI command, data, callback>
+ */
+ void execute(CommandHandler command);
- private:
- /** @brief Check if anything in queue and alert host if so */
- void checkQueueAndAlertHost();
+ private:
+ /** @brief Check if anything in queue and alert host if so */
+ void checkQueueAndAlertHost();
- /** @brief Call back interface on message timeouts to host.
- *
- * @detail When this happens, a failure message would be sent
- * to all the commands that are in the Queue and queue
- * will be purged
- */
- void hostTimeout();
+ /** @brief Call back interface on message timeouts to host.
+ *
+ * @detail When this happens, a failure message would be sent
+ * to all the commands that are in the Queue and queue
+ * will be purged
+ */
+ void hostTimeout();
- /** @brief Clears the command queue
- *
- * @detail Clears the command queue and calls all callbacks
- * specifying the command wasn't successful.
- */
- void clearQueue();
+ /** @brief Clears the command queue
+ *
+ * @detail Clears the command queue and calls all callbacks
+ * specifying the command wasn't successful.
+ */
+ void clearQueue();
- /** @brief Clears the command queue on a power on
- *
- * @detail The properties changed handler for the
- * RequestedHostTransition property. When this property
- * changes to 'On', this function will purge the command
- * queue.
- *
- * This is done to avoid having commands that were issued
- * before the host powers on from getting sent to the host,
- * either due to race conditions around state transitions
- * or from a user doing something like requesting an already
- * powered off system to power off again and then immediately
- * requesting a power on.
- *
- * @param[in] msg - the sdbusplus message containing the property
- */
- void clearQueueOnPowerOn(sdbusplus::message::message& msg);
+ /** @brief Clears the command queue on a power on
+ *
+ * @detail The properties changed handler for the
+ * RequestedHostTransition property. When this property
+ * changes to 'On', this function will purge the command
+ * queue.
+ *
+ * This is done to avoid having commands that were issued
+ * before the host powers on from getting sent to the host,
+ * either due to race conditions around state transitions
+ * or from a user doing something like requesting an already
+ * powered off system to power off again and then immediately
+ * requesting a power on.
+ *
+ * @param[in] msg - the sdbusplus message containing the property
+ */
+ void clearQueueOnPowerOn(sdbusplus::message::message& msg);
- /** @brief Reference to the dbus handler */
- sdbusplus::bus::bus& bus;
+ /** @brief Reference to the dbus handler */
+ sdbusplus::bus::bus& bus;
- /** @brief Queue to store the requested commands */
- std::queue<CommandHandler> workQueue{};
+ /** @brief Queue to store the requested commands */
+ std::queue<CommandHandler> workQueue{};
- /** @brief Timer for commands to host */
- phosphor::ipmi::Timer timer;
+ /** @brief Timer for commands to host */
+ phosphor::ipmi::Timer timer;
- /** @brief Match handler for the requested host state */
- sdbusplus::bus::match_t hostTransitionMatch;
+ /** @brief Match handler for the requested host state */
+ sdbusplus::bus::match_t hostTransitionMatch;
};
} // namespace command
OpenPOWER on IntegriCloud