From 62ca476e9ecd19522c9a63b54263fec4c6c4aba4 Mon Sep 17 00:00:00 2001 From: Jeffrey Walton Date: Mon, 26 Sep 2016 11:37:21 -0400 Subject: [PATCH] Updated documentation --- filters.h | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/filters.h b/filters.h index eb993123..0324b468 100644 --- a/filters.h +++ b/filters.h @@ -343,22 +343,23 @@ public: return PutMaybeModifiable(inString, length, messageEnd, blocking, true); } - //! \brief Releases buffered data for processing - //! \param hardFlush - //! \param blocking + //! \brief Flushes data buffered by this object, without signal propagation + //! \param hardFlush indicates whether all data should be flushed + //! \param blocking specifies whether the object should block when processing input //! \details IsolatedFlush() calls ForceNextPut() if hardFlush is true + //! \note hardFlush must be used with care bool IsolatedFlush(bool hardFlush, bool blocking); - //! \brief Releases buffered data for processing + //! \brief Flushes data buffered by this object //! \details The input buffer may contain more than blockSize bytes if lastSize != 0. //! ForceNextPut() forces a call to NextPut() if this is the case. void ForceNextPut(); protected: - bool DidFirstPut() const {return m_firstInputDone;} - size_t GetFirstPutSize() const {return m_firstSize;} - size_t GetBlockPutSize() const {return m_blockSize;} - size_t GetLastPutSize() const {return m_lastSize;} + virtual bool DidFirstPut() const {return m_firstInputDone;} + virtual size_t GetFirstPutSize() const {return m_firstSize;} + virtual size_t GetBlockPutSize() const {return m_blockSize;} + virtual size_t GetLastPutSize() const {return m_lastSize;} virtual void InitializeDerivedAndReturnNewSizes(const NameValuePairs ¶meters, size_t &firstSize, size_t &blockSize, size_t &lastSize) {CRYPTOPP_UNUSED(parameters); CRYPTOPP_UNUSED(firstSize); CRYPTOPP_UNUSED(blockSize); CRYPTOPP_UNUSED(lastSize); InitializeDerived(parameters);}