userver: testsuite::TestpointClientBase Class Reference
No Matches
testsuite::TestpointClientBase Class Referenceabstract

#include <userver/testsuite/testpoint_control.hpp>

Detailed Description

Base testpoint client. Used to report TESTPOINT executions to testsuite.

Do not use directly unless you are writing a component for handling testpoints.

Definition at line 23 of file testpoint_control.hpp.

+ Inheritance diagram for testsuite::TestpointClientBase:

Public Types

using Callback = utils::function_ref<void(const formats::json::Value&)>

Public Member Functions

virtual void Execute (std::string_view name, const formats::json::Value &json, Callback callback) const =0

Protected Member Functions

void Unregister () noexcept
 Must be called in destructors of derived classes.

Member Typedef Documentation

◆ Callback

using testsuite::TestpointClientBase::Callback = utils::function_ref<void(const formats::json::Value&)>

Definition at line 25 of file testpoint_control.hpp.

Member Function Documentation

◆ Execute()

virtual void testsuite::TestpointClientBase::Execute ( std::string_view name,
const formats::json::Value & json,
Callback callback ) const
pure virtual
namethe name of the testpoint
jsonthe request that will be passed to testsuite handler
callbackwill be invoked with the response if the testpoint has been handled on the testsuite side successfully

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