Files
flipper/xplat/Sonar/SonarStep.h
John Knox e76a6ef529 Document SonarStep.h
Summary: It may not be immediately obvious how this works, so adding comments.

Reviewed By: passy

Differential Revision: D9333321

fbshipit-source-id: 79740b3d2a9589b3ba48c47b0068afdaf26f35a3
2018-08-15 06:12:30 -07:00

33 lines
673 B
C++

/*
* Copyright (c) 2018-present, Facebook, Inc.
*
* This source code is licensed under the MIT license found in the LICENSE
* file in the root directory of this source tree.
*
*/
#pragma once
#include <string>
class SonarState;
class SonarStep {
public:
/* Mark this step as completed successfully
* failing to call complete() will be registered as a failure
* when the destructor is executed. */
void complete();
// Mark the step as failed, and provide a message.
void fail(std::string message);
SonarStep(std::string name, SonarState* state);
~SonarStep();
private:
std::string name;
bool isLogged = false;
SonarState* state;
};