Measure how many bytes and messages pass through the filter. More...

#include <filters.h>

Inheritance diagram for MeterFilter:

Collaboration diagram for MeterFilter:

Classes
struct	MessageRange

Public Member Functions
virtual	~MeterFilter ()

	MeterFilter (BufferedTransformation *attachment=NULL, bool transparent=true)
	Construct a MeterFilter. More...

void	SetTransparent (bool transparent)
	Set or change the transparent mode of this object. More...

void	AddRangeToSkip (unsigned int message, lword position, lword size, bool sortNow=true)
	Adds a range to skip during processing. More...

void	ResetMeter ()
	Resets the meter. More...

void	IsolatedInitialize (const NameValuePairs &parameters)
	Initialize or reinitialize this object, without signal propagation. More...

lword	GetCurrentMessageBytes () const

lword	GetTotalBytes () const

unsigned int	GetCurrentSeriesMessages () const

unsigned int	GetTotalMessages () const

unsigned int	GetTotalMessageSeries () const

byte *	CreatePutSpace (size_t &size)
	Request space which can be written into by the caller. More...

size_t	Put2 (const byte *inString, size_t length, int messageEnd, bool blocking)
	Input multiple bytes for processing. More...

size_t	PutModifiable2 (byte *inString, size_t length, int messageEnd, bool blocking)
	Input multiple bytes that may be modified by callee. More...

bool	IsolatedMessageSeriesEnd (bool blocking)
	Marks the end of a series of messages, without signal propagation. More...

Public Member Functions inherited from Bufferless< Filter >
bool	IsolatedFlush (bool hardFlush, bool blocking)

Public Member Functions inherited from Filter
virtual	~Filter ()

size_t	TransferTo2 (BufferedTransformation &target, lword &transferBytes, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
	Transfer bytes from this object to another BufferedTransformation. More...

size_t	CopyRangeTo2 (BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const
	Copy bytes from this object to another BufferedTransformation. More...

void	Initialize (const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)
	Initialize or reinitialize this object, with signal propagation. More...

bool	Flush (bool hardFlush, int propagation=-1, bool blocking=true)
	Flush buffered input and/or output, with signal propagation. More...

bool	MessageSeriesEnd (int propagation=-1, bool blocking=true)
	Marks the end of a series of messages, with signal propagation. More...

	Filter (BufferedTransformation *attachment=NULL)
	Construct a Filter. More...

bool	Attachable ()
	Determine if attachable. More...

BufferedTransformation *	AttachedTransformation ()
	Retrieve attached transformation. More...

const BufferedTransformation *	AttachedTransformation () const
	Retrieve attached transformation. More...

void	Detach (BufferedTransformation *newAttachment=NULL)
	Replace an attached transformation. More...

Public Member Functions inherited from BufferedTransformation
virtual	~BufferedTransformation ()

	BufferedTransformation ()
	Construct a BufferedTransformation. More...

BufferedTransformation &	Ref ()
	Provides a reference to this object. More...

size_t	Put (byte inByte, bool blocking=true)
	Input a byte for processing. More...

size_t	Put (const byte *inString, size_t length, bool blocking=true)
	Input a byte buffer for processing. More...

size_t	PutWord16 (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 16-bit word for processing. More...

size_t	PutWord32 (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 32-bit word for processing. More...

virtual bool	CanModifyInput () const
	Determines whether input can be modified by the callee. More...

size_t	PutModifiable (byte *inString, size_t length, bool blocking=true)
	Input multiple bytes that may be modified by callee. More...

bool	MessageEnd (int propagation=-1, bool blocking=true)
	Signals the end of messages to the object. More...

size_t	PutMessageEnd (const byte *inString, size_t length, int propagation=-1, bool blocking=true)
	Input multiple bytes for processing and signal the end of a message. More...

unsigned int	GetMaxWaitObjectCount () const
	Retrieves the maximum number of waitable objects. More...

void	GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
	Retrieves waitable objects. More...

virtual void	SetAutoSignalPropagation (int propagation)
	Set propagation of automatically generated and transferred signals. More...

virtual int	GetAutoSignalPropagation () const
	Retrieve automatic signal propagation value. More...

virtual lword	MaxRetrievable () const
	Provides the number of bytes ready for retrieval. More...

virtual bool	AnyRetrievable () const
	Determines whether bytes are ready for retrieval. More...

virtual size_t	Get (byte &outByte)
	Retrieve a 8-bit byte. More...

virtual size_t	Get (byte *outString, size_t getMax)
	Retrieve a block of bytes. More...

virtual size_t	Peek (byte &outByte) const
	Peek a 8-bit byte. More...

virtual size_t	Peek (byte *outString, size_t peekMax) const
	Peek a block of bytes. More...

size_t	GetWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER)
	Retrieve a 16-bit word. More...

size_t	GetWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER)
	Retrieve a 32-bit word. More...

size_t	PeekWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
	Peek a 16-bit word. More...

size_t	PeekWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
	Peek a 32-bit word. More...

lword	TransferTo (BufferedTransformation &target, lword transferMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL)
	move transferMax bytes of the buffered output to target as input More...

virtual lword	Skip (lword skipMax=LWORD_MAX)
	Discard skipMax bytes from the output buffer. More...

lword	CopyTo (BufferedTransformation &target, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
	copy copyMax bytes of the buffered output to target as input More...

lword	CopyRangeTo (BufferedTransformation &target, lword position, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
	Copy bytes from this object using an index to another BufferedTransformation. More...

virtual lword	TotalBytesRetrievable () const
	Provides the number of bytes ready for retrieval. More...

virtual unsigned int	NumberOfMessages () const
	Provides the number of meesages processed by this object. More...

virtual bool	AnyMessages () const
	Determines if any messages are available for retrieval. More...

virtual bool	GetNextMessage ()
	Start retrieving the next message. More...

virtual unsigned int	SkipMessages (unsigned int count=UINT_MAX)
	Skip a number of meessages. More...

unsigned int	TransferMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL)
	Transfer messages from this object to another BufferedTransformation. More...

unsigned int	CopyMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL) const
	Copy messages from this object to another BufferedTransformation. More...

virtual void	SkipAll ()
	Skip all messages in the series. More...

void	TransferAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL)
	Transfer all bytes from this object to another BufferedTransformation. More...

void	CopyAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL) const
	Copy messages from this object to another BufferedTransformation. More...

virtual bool	GetNextMessageSeries ()
	Retrieve the next message in a series. More...

virtual unsigned int	NumberOfMessagesInThisSeries () const
	Provides the number of messages in a series. More...

virtual unsigned int	NumberOfMessageSeries () const
	Provides the number of messages in a series. More...

size_t	TransferMessagesTo2 (BufferedTransformation &target, unsigned int &messageCount, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
	Transfer messages from this object to another BufferedTransformation. More...

size_t	TransferAllTo2 (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
	Transfer all bytes from this object to another BufferedTransformation. More...

size_t	ChannelPut (const std::string &channel, byte inByte, bool blocking=true)
	Input a byte for processing on a channel. More...

size_t	ChannelPut (const std::string &channel, const byte *inString, size_t length, bool blocking=true)
	Input a byte buffer for processing on a channel. More...

size_t	ChannelPutModifiable (const std::string &channel, byte *inString, size_t length, bool blocking=true)
	Input multiple bytes that may be modified by callee on a channel. More...

size_t	ChannelPutWord16 (const std::string &channel, word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 16-bit word for processing on a channel. More...

size_t	ChannelPutWord32 (const std::string &channel, word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 32-bit word for processing on a channel. More...

bool	ChannelMessageEnd (const std::string &channel, int propagation=-1, bool blocking=true)
	Signal the end of a message. More...

size_t	ChannelPutMessageEnd (const std::string &channel, const byte *inString, size_t length, int propagation=-1, bool blocking=true)
	Input multiple bytes for processing and signal the end of a message. More...

virtual byte *	ChannelCreatePutSpace (const std::string &channel, size_t &size)
	Request space which can be written into by the caller. More...

virtual size_t	ChannelPut2 (const std::string &channel, const byte *inString, size_t length, int messageEnd, bool blocking)
	Input multiple bytes for processing on a channel. More...

virtual size_t	ChannelPutModifiable2 (const std::string &channel, byte *inString, size_t length, int messageEnd, bool blocking)
	Input multiple bytes that may be modified by callee on a channel. More...

virtual bool	ChannelFlush (const std::string &channel, bool hardFlush, int propagation=-1, bool blocking=true)
	Flush buffered input and/or output on a channel. More...

virtual bool	ChannelMessageSeriesEnd (const std::string &channel, int propagation=-1, bool blocking=true)
	Marks the end of a series of messages on a channel. More...

virtual void	SetRetrievalChannel (const std::string &channel)
	Sets the default retrieval channel. More...

virtual void	Attach (BufferedTransformation *newAttachment)
	Add newAttachment to the end of attachment chain. More...

Public Member Functions inherited from Algorithm
virtual	~Algorithm ()

	Algorithm (bool checkSelfTestStatus=true)
	Interface for all crypto algorithms. More...

virtual std::string	AlgorithmName () const
	Provides the name of this algorithm. More...

Public Member Functions inherited from Clonable
virtual	~Clonable ()

virtual Clonable *	Clone () const
	Copies this object. More...

Public Member Functions inherited from Waitable
virtual	~Waitable ()

bool	Wait (unsigned long milliseconds, CallStack const &callStack)
	Wait on this object. More...

Public Member Functions inherited from NotCopyable
	NotCopyable ()

Private Member Functions
size_t	PutMaybeModifiable (byte *inString, size_t length, int messageEnd, bool blocking, bool modifiable)

bool	ShouldPropagateMessageEnd () const

bool	ShouldPropagateMessageSeriesEnd () const

Private Attributes
bool	m_transparent

lword	m_currentMessageBytes

lword	m_totalBytes

unsigned int	m_currentSeriesMessages

unsigned int	m_totalMessages

unsigned int	m_totalMessageSeries

std::deque< MessageRange >	m_rangesToSkip

byte *	m_begin

size_t	m_length

Additional Inherited Members
Static Public Attributes inherited from BufferedTransformation
static const std::string &	NULL_CHANNEL = DEFAULT_CHANNEL

Protected Member Functions inherited from Filter
virtual BufferedTransformation *	NewDefaultAttachment () const

void	Insert (Filter *nextFilter)

void	PropagateInitialize (const NameValuePairs &parameters, int propagation)

size_t	Output (int outputSite, const byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
	Forward processed data on to attached transformation. More...

size_t	OutputModifiable (int outputSite, byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
	Output multiple bytes that may be modified by callee. More...

bool	OutputMessageEnd (int outputSite, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
	Signals the end of messages to the object. More...

bool	OutputFlush (int outputSite, bool hardFlush, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
	Flush buffered input and/or output, with signal propagation. More...

bool	OutputMessageSeriesEnd (int outputSite, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
	Marks the end of a series of messages, with signal propagation. More...

Static Protected Member Functions inherited from BufferedTransformation
static int	DecrementPropagation (int propagation)
	Decrements the propagation count while clamping at 0. More...

Protected Attributes inherited from Filter
size_t	m_inputPosition

int	m_continueAt

Detailed Description

Measure how many bytes and messages pass through the filter.

measure how many bytes and messages pass through the filter. The filter also serves as valve by maintaining a list of ranges to skip during processing.

Definition at line 220 of file filters.h.

Constructor & Destructor Documentation

virtual MeterFilter::~MeterFilter ( )

inlinevirtual

Definition at line 223 of file filters.h.

MeterFilter::MeterFilter	(	BufferedTransformation *	attachment = `NULL`,
		bool	transparent = `true`
	)

inline

Construct a MeterFilter.

Parameters

attachment	an optional attached transformation
transparent	flag indicating if the filter should function transparently

attachment can be NULL. The filter is transparent by default. If the filter is transparent, then PutMaybeModifiable() does not process a request and always returns 0.

Definition at line 230 of file filters.h.

Member Function Documentation

void MeterFilter::AddRangeToSkip	(	unsigned int	message,
		lword	position,
		lword	size,
		bool	sortNow = `true`
	)

Adds a range to skip during processing.

Parameters

message	the message to apply the range
position	the 0-based index in the current stream
size	the length of the range
sortNow	flag indicating whether the range should be sorted

Internally, MeterFilter maitains a deque of ranges to skip. As messages are processed, ranges of bytes are skipped according to the list of ranges.

Definition at line 166 of file filters.cpp.

Here is the caller graph for this function:

byte* MeterFilter::CreatePutSpace ( size_t & size )

inlinevirtual

Request space which can be written into by the caller.

Parameters

size	the requested size of the buffer

The purpose of this method is to help avoid extra memory allocations.

size is an IN and OUT parameter and used as a hint. When the call is made, size is the requested size of the buffer. When the call returns, size is the size of the array returned to the caller.

The base class implementation sets size to 0 and returns NULL.

Note: Some objects, like ArraySink, cannot create a space because its fixed. In the case of an ArraySink, the pointer to the array is returned and the size is remaining size.

Reimplemented from BufferedTransformation.

Definition at line 262 of file filters.h.

lword MeterFilter::GetCurrentMessageBytes ( ) const

inline

Definition at line 256 of file filters.h.

unsigned int MeterFilter::GetCurrentSeriesMessages ( ) const

inline

Definition at line 258 of file filters.h.

lword MeterFilter::GetTotalBytes ( ) const

inline

Definition at line 257 of file filters.h.

Here is the caller graph for this function:

unsigned int MeterFilter::GetTotalMessages ( ) const

inline

Definition at line 259 of file filters.h.

unsigned int MeterFilter::GetTotalMessageSeries ( ) const

inline

Definition at line 260 of file filters.h.

void MeterFilter::IsolatedInitialize ( const NameValuePairs & parameters )

inlinevirtual

Initialize or reinitialize this object, without signal propagation.

Parameters

parameters a set of NameValuePairs to initialize this object

Exceptions

NotImplemented

IsolatedInitialize() is used to initialize or reinitialize an object using a variable number of arbitrarily typed arguments. The function avoids the need for multiple constructors providing all possible combintations of configurable parameters.

IsolatedInitialize() does not call Initialize() on attached transformations. If initialization should be propagated, then use the Initialize() function.

If a derived class does not override IsolatedInitialize(), then the base class throws NotImplemented.

Reimplemented from BufferedTransformation.

Definition at line 253 of file filters.h.

bool MeterFilter::IsolatedMessageSeriesEnd ( bool blocking )

virtual

Marks the end of a series of messages, without signal propagation.

Parameters

blocking specifies whether the object should block when completing the processing on the current series of messages

Reimplemented from BufferedTransformation.

Definition at line 242 of file filters.cpp.

size_t MeterFilter::Put2	(	const byte *	inString,
		size_t	length,
		int	messageEnd,
		bool	blocking
	)

virtual

Input multiple bytes for processing.

Parameters

inString	the byte buffer to process
length	the size of the string, in bytes
messageEnd	means how many filters to signal MessageEnd() to, including this one
blocking	specifies whether the object should block when processing input

Derived classes must implement Put2().

Implements BufferedTransformation.

Definition at line 232 of file filters.cpp.

size_t MeterFilter::PutMaybeModifiable	(	byte *	inString,
		size_t	length,
		int	messageEnd,
		bool	blocking,
		bool	modifiable
	)

private

Definition at line 174 of file filters.cpp.

Here is the call graph for this function:

size_t MeterFilter::PutModifiable2	(	byte *	inString,
		size_t	length,
		int	messageEnd,
		bool	blocking
	)

virtual

Input multiple bytes that may be modified by callee.

Parameters

inString	the byte buffer to process.
length	the size of the string, in bytes.
messageEnd	means how many filters to signal MessageEnd() to, including this one.
blocking	specifies whether the object should block when processing input.

Internally, PutModifiable2() calls Put2().

Reimplemented from BufferedTransformation.

Definition at line 237 of file filters.cpp.

void MeterFilter::ResetMeter ( )

Resets the meter.

ResetMeter() reinitializes the meter by setting counters to 0 and removing previous skip ranges.

Definition at line 160 of file filters.cpp.

void MeterFilter::SetTransparent ( bool transparent )

inline

Set or change the transparent mode of this object.

Parameters

transparent the new transparent mode

Definition at line 237 of file filters.h.

bool MeterFilter::ShouldPropagateMessageEnd ( ) const

inlineprivatevirtual

Reimplemented from Filter.

Definition at line 270 of file filters.h.

bool MeterFilter::ShouldPropagateMessageSeriesEnd ( ) const

inlineprivatevirtual

Reimplemented from Filter.

Definition at line 271 of file filters.h.

Member Data Documentation

byte* MeterFilter::m_begin

private

Definition at line 284 of file filters.h.

lword MeterFilter::m_currentMessageBytes

private

Definition at line 281 of file filters.h.

unsigned int MeterFilter::m_currentSeriesMessages

private

Definition at line 282 of file filters.h.

size_t MeterFilter::m_length

private

Definition at line 285 of file filters.h.

std::deque<MessageRange> MeterFilter::m_rangesToSkip

private

Definition at line 283 of file filters.h.

lword MeterFilter::m_totalBytes

private

Definition at line 281 of file filters.h.

unsigned int MeterFilter::m_totalMessages

private

Definition at line 282 of file filters.h.

unsigned int MeterFilter::m_totalMessageSeries

private

Definition at line 282 of file filters.h.

bool MeterFilter::m_transparent

private

Definition at line 280 of file filters.h.

The documentation for this class was generated from the following files:

src/cryptopp/filters.h
src/cryptopp/filters.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation