From 2ea141a14989bc00e2e8faada762c7d6242efea0 Mon Sep 17 00:00:00 2001 From: Michael Davidsaver Date: Thu, 8 Dec 2022 11:21:32 -0800 Subject: [PATCH] doc --- src/pvxs/source.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/pvxs/source.h b/src/pvxs/source.h index c70a532..607dd3b 100644 --- a/src/pvxs/source.h +++ b/src/pvxs/source.h @@ -109,12 +109,12 @@ public: * be sent before a client ack. must be received. By default both high and low levels are zero. * * onLowMark callback is not currently implemented and the 'low' level is not used. - * onHighMark callback will be invoked when a client ack. increases the window size above (>) 'high'. + * onHighMark callback will be invoked when a client ack. is received and the window size is above (>) 'high'. */ virtual void setWatermarks(size_t low, size_t high) =0; //! Callback when client resumes/pauses updates - virtual void onStart(std::function&&) =0; + virtual void onStart(std::function&&) =0; virtual void onHighMark(std::function&&) =0; virtual void onLowMark(std::function&&) =0; }; @@ -130,6 +130,7 @@ public: //! The queue is initially stopped. //! @throws std::runtime_error if the client pvRequest() field mask does not select any fields of prototype. virtual std::unique_ptr connect(const Value& prototype) =0; + //! Indicate that this operation can not be setup virtual void error(const std::string& msg) =0; @@ -144,7 +145,7 @@ public: struct PVXS_API ChannelControl : public OpBase { virtual ~ChannelControl() =0; - //! Invoked when a new GET, PUT, or RPC Operation is requested through this Channel + //! Invoked when a new GET or PUT Operation is requested through this Channel virtual void onOp(std::function&&)>&& ) =0; //! Invoked when the peer executes an RPC virtual void onRPC(std::function&&, Value&&)>&& fn)=0;