summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeffrey Walton <noloader@gmail.com>2016-02-29 11:39:20 -0500
committerJeffrey Walton <noloader@gmail.com>2016-02-29 11:39:20 -0500
commit1743b976f7b5e6c67cc9288afa27a3b08a84dd38 (patch)
tree2a0256489ea1c730bf9a3c057501d8f15eed2388
parentcc6db9b1397653d8bc9719d119ad7a87efd92306 (diff)
downloadcryptopp-git-1743b976f7b5e6c67cc9288afa27a3b08a84dd38.tar.gz
Update documentation
-rw-r--r--filters.h22
1 files changed, 13 insertions, 9 deletions
diff --git a/filters.h b/filters.h
index 779b991f..5f835b18 100644
--- a/filters.h
+++ b/filters.h
@@ -36,6 +36,9 @@ NAMESPACE_BEGIN(CryptoPP)
class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Filter : public BufferedTransformation, public NotCopyable
{
public:
+#ifndef CRYPTOPP_MAINTAIN_BACKWARDS_COMPATIBILITY_562
+ virtual ~Filter() {}
+#endif
//! \name ATTACHMENT
//@{
@@ -74,10 +77,6 @@ public:
void Initialize(const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1);
bool Flush(bool hardFlush, int propagation=-1, bool blocking=true);
bool MessageSeriesEnd(int propagation=-1, bool blocking=true);
-
-#ifndef CRYPTOPP_MAINTAIN_BACKWARDS_COMPATIBILITY_562
- virtual ~Filter() {}
-#endif
protected:
virtual BufferedTransformation * NewDefaultAttachment() const;
@@ -316,7 +315,7 @@ public:
class CRYPTOPP_DLL FilterWithBufferedInput : public Filter
{
public:
-
+
#if !defined(CRYPTOPP_MAINTAIN_BACKWARDS_COMPATIBILITY_562)
//! default FilterWithBufferedInput for temporaries
FilterWithBufferedInput();
@@ -1013,7 +1012,12 @@ public:
ArraySink(byte *buf, size_t size)
: m_buf(buf), m_size(size), m_total(0) {}
+ //! \brief Provides the size remaining in the Sink
+ //! \returns size remaining in the Sink, in bytes
size_t AvailableSize() {return SaturatingSubtract(m_size, m_total);}
+
+ //! \brief Provides the number of bytes written to the Sink
+ //! \returns number of bytes written to the Sink, in bytes
lword TotalPutLength() {return m_total;}
void IsolatedInitialize(const NameValuePairs &parameters);
@@ -1128,6 +1132,10 @@ private:
class CRYPTOPP_DLL CRYPTOPP_NO_VTABLE Source : public InputRejecting<Filter>
{
public:
+#ifndef CRYPTOPP_MAINTAIN_BACKWARDS_COMPATIBILITY_562
+ virtual ~Source() {}
+#endif
+
//! \brief Construct a Source
//! \param attachment an optional attached transformation
Source(BufferedTransformation *attachment = NULL)
@@ -1182,10 +1190,6 @@ public:
virtual bool SourceExhausted() const =0;
//@}
-
-#ifndef CRYPTOPP_MAINTAIN_BACKWARDS_COMPATIBILITY_562
- virtual ~Source() {}
-#endif
protected:
void SourceInitialize(bool pumpAll, const NameValuePairs &parameters)