diff options
author | lloyd <[email protected]> | 2010-06-21 14:29:40 +0000 |
---|---|---|
committer | lloyd <[email protected]> | 2010-06-21 14:29:40 +0000 |
commit | 928760016bae3887dedf1344d4b3d2e70155ef63 (patch) | |
tree | c3d028dccca62ac83c38266c65131b1201935f35 | |
parent | a62eaa2f7447d930db84f966986736d30ef522bb (diff) |
Doxygen
-rw-r--r-- | src/filters/buf_filt.h | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/src/filters/buf_filt.h b/src/filters/buf_filt.h index 1ab402df7..3acf1f809 100644 --- a/src/filters/buf_filt.h +++ b/src/filters/buf_filt.h @@ -26,14 +26,27 @@ class BOTAN_DLL Buffered_Filter virtual ~Buffered_Filter() {} protected: + /** + * @return name of this filter object + */ virtual std::string name() const = 0; virtual void buffered_block(const byte input[], u32bit length) = 0; virtual void buffered_final(const byte input[], u32bit length) = 0; + /** + * @return block size of inputs + */ u32bit buffered_block_size() const { return main_block_mod; } + /** + * @return current position in the buffer + */ u32bit current_position() const { return buffer_pos; } + + /** + * Reset the buffer position + */ void buffer_reset() { buffer_pos = 0; } private: u32bit main_block_mod, final_minimum; |