arne
/
cryptopp
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated documentation

pull/308/head
Jeffrey Walton 2016-09-26 11:37:21 -04:00
parent 62de6c8e3b
commit 62ca476e9e
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
filters.h
View File

@ -343,22 +343,23 @@ public:
return PutMaybeModifiable(inString, length, messageEnd, blocking, true); return PutMaybeModifiable(inString, length, messageEnd, blocking, true);
} }
//! \brief Releases buffered data for processing //! \brief Flushes data buffered by this object, without signal propagation
//! \param hardFlush //! \param hardFlush indicates whether all data should be flushed
//! \param blocking //! \param blocking specifies whether the object should block when processing input
//! \details IsolatedFlush() calls ForceNextPut() if hardFlush is true //! \details IsolatedFlush() calls ForceNextPut() if hardFlush is true
//! \note hardFlush must be used with care
bool IsolatedFlush(bool hardFlush, bool blocking); 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 <tt>lastSize != 0</tt>. //! \details The input buffer may contain more than blockSize bytes if <tt>lastSize != 0</tt>.
//! ForceNextPut() forces a call to NextPut() if this is the case. //! ForceNextPut() forces a call to NextPut() if this is the case.
void ForceNextPut(); void ForceNextPut();
protected: protected:
bool DidFirstPut() const {return m_firstInputDone;} virtual bool DidFirstPut() const {return m_firstInputDone;}
size_t GetFirstPutSize() const {return m_firstSize;} virtual size_t GetFirstPutSize() const {return m_firstSize;}
size_t GetBlockPutSize() const {return m_blockSize;} virtual size_t GetBlockPutSize() const {return m_blockSize;}
size_t GetLastPutSize() const {return m_lastSize;} virtual size_t GetLastPutSize() const {return m_lastSize;}
virtual void InitializeDerivedAndReturnNewSizes(const NameValuePairs &parameters, size_t &firstSize, size_t &blockSize, size_t &lastSize) virtual void InitializeDerivedAndReturnNewSizes(const NameValuePairs &parameters, size_t &firstSize, size_t &blockSize, size_t &lastSize)
{CRYPTOPP_UNUSED(parameters); CRYPTOPP_UNUSED(firstSize); CRYPTOPP_UNUSED(blockSize); CRYPTOPP_UNUSED(lastSize); InitializeDerived(parameters);} {CRYPTOPP_UNUSED(parameters); CRYPTOPP_UNUSED(firstSize); CRYPTOPP_UNUSED(blockSize); CRYPTOPP_UNUSED(lastSize); InitializeDerived(parameters);}