tyler.durden/icinga2
1
0
Fork 0
mirror of https://github.com/Icinga/icinga2.git synced 2025-07-21 12:44:58 +02:00
Code Issues Packages Projects Releases Wiki Activity

Rename AsyncJsonWriter::Flush() -> MayFlush() to reflect its usage

Browse Source
This commit is contained in:
Yonas Habteab 2025-07-11 12:56:52 +02:00
parent 89418f38ee
commit cd1ab7548c
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/base/json.cpp
View File

@ -242,7 +242,7 @@ void JsonEncoder::FlushIfSafe(boost::asio::yield_context* yc) const
// cast the m_Writer to AsyncJsonWriter without any additional checks as it is guaranteed // cast the m_Writer to AsyncJsonWriter without any additional checks as it is guaranteed
// to be an instance of AsyncJsonWriter when m_IsAsyncWriter is true. // to be an instance of AsyncJsonWriter when m_IsAsyncWriter is true.
auto ajw(static_cast<AsyncJsonWriter*>(m_Writer.get())); auto ajw(static_cast<AsyncJsonWriter*>(m_Writer.get()));
ajw->Flush(*yc); ajw->MayFlush(*yc);
} }
} }

6
lib/base/json.hpp
View File

@ -17,7 +17,7 @@ namespace icinga
* *
* All users of this class must ensure that the underlying output stream will not perform any asynchronous I/O * All users of this class must ensure that the underlying output stream will not perform any asynchronous I/O
* operations when the @c write_character() or @c write_characters() methods are called. They shall only perform * operations when the @c write_character() or @c write_characters() methods are called. They shall only perform
* such ops when the @c JsonEncoder allows them to do so by calling the @c Flush() method. * such ops when the @c JsonEncoder allows them to do so by calling the @c MayFlush() method.
* *
* @ingroup base * @ingroup base
*/ */
@ -25,7 +25,7 @@ class AsyncJsonWriter : public nlohmann::detail::output_adapter_protocol<char>
{ {
public: public:
/** /**
* Flush instructs the underlying output stream to write any buffered data to wherever it is supposed to go. * It instructs the underlying output stream to write any buffered data to wherever it is supposed to go.
* *
* The @c JsonEncoder allows the stream to even perform asynchronous operations in a safe manner by calling * The @c JsonEncoder allows the stream to even perform asynchronous operations in a safe manner by calling
* this method with a dedicated @c boost::asio::yield_context object. The stream must not perform any async * this method with a dedicated @c boost::asio::yield_context object. The stream must not perform any async
@ -37,7 +37,7 @@ public:
* *
* @param yield The yield context to use for asynchronous operations. * @param yield The yield context to use for asynchronous operations.
*/ */
virtual void Flush(boost::asio::yield_context& yield) = 0; virtual void MayFlush(boost::asio::yield_context& yield) = 0;
}; };
class String; class String;