Divides an input stream into discrete blocks. More...

#include <filters.h>

Inheritance diagram for FilterWithBufferedInput:

Collaboration diagram for FilterWithBufferedInput:

Classes
class	BlockQueue

Public Member Functions
virtual	~FilterWithBufferedInput ()

	FilterWithBufferedInput (BufferedTransformation *attachment)
	Construct a FilterWithBufferedInput with an attached transformation. More...

	FilterWithBufferedInput (size_t firstSize, size_t blockSize, size_t lastSize, BufferedTransformation *attachment)
	Construct a FilterWithBufferedInput with an attached transformation. More...

void	IsolatedInitialize (const NameValuePairs &parameters)
	Initialize or reinitialize this object, without signal propagation. 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	IsolatedFlush (bool hardFlush, bool blocking)
	Flushes data buffered by this object, without signal propagation. More...

void	ForceNextPut ()
	Flushes data buffered by this object. More...

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 byte *	CreatePutSpace (size_t &size)
	Request space which can be written into by the caller. 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 bool	IsolatedMessageSeriesEnd (bool blocking)
	Marks the end of a series of messages, without signal propagation. 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 ()

Protected Member Functions
virtual bool	DidFirstPut () const

virtual size_t	GetFirstPutSize () const

virtual size_t	GetBlockPutSize () const

virtual size_t	GetLastPutSize () const

virtual void	InitializeDerivedAndReturnNewSizes (const NameValuePairs &parameters, size_t &firstSize, size_t &blockSize, size_t &lastSize)

virtual void	InitializeDerived (const NameValuePairs &parameters)

virtual void	FirstPut (const byte *inString)=0

virtual void	NextPutSingle (const byte *inString)

virtual void	NextPutMultiple (const byte *inString, size_t length)

virtual void	NextPutModifiable (byte *inString, size_t length)

virtual void	LastPut (const byte *inString, size_t length)=0
	Input the last block of data. More...

virtual void	FlushDerived ()

size_t	PutMaybeModifiable (byte *begin, size_t length, int messageEnd, bool blocking, bool modifiable)

void	NextPutMaybeModifiable (byte *inString, size_t length, bool modifiable)

virtual int	NextPut (const byte *inString, size_t length)

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

void	Insert (Filter *nextFilter)

virtual bool	ShouldPropagateMessageEnd () const

virtual bool	ShouldPropagateMessageSeriesEnd () const

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...

Protected Attributes
size_t	m_firstSize

size_t	m_blockSize

size_t	m_lastSize

bool	m_firstInputDone

BlockQueue	m_queue

Protected Attributes inherited from Filter
size_t	m_inputPosition

int	m_continueAt

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

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

Detailed Description

Divides an input stream into discrete blocks.

FilterWithBufferedInput divides the input stream into a first block, a number of middle blocks, and a last block. First and last blocks are optional, and middle blocks may be a stream instead (i.e. blockSize == 1).

See also: AuthenticatedEncryptionFilter, AuthenticatedDecryptionFilter, HashVerificationFilter, SignatureVerificationFilter, StreamTransformationFilter

Definition at line 317 of file filters.h.

Constructor & Destructor Documentation

virtual FilterWithBufferedInput::~FilterWithBufferedInput ( )

inlinevirtual

Definition at line 320 of file filters.h.

FilterWithBufferedInput::FilterWithBufferedInput ( BufferedTransformation * attachment )

Construct a FilterWithBufferedInput with an attached transformation.

Parameters

attachment an attached transformation

Definition at line 315 of file filters.cpp.

FilterWithBufferedInput::FilterWithBufferedInput	(	size_t	firstSize,
		size_t	blockSize,
		size_t	lastSize,
		BufferedTransformation *	attachment
	)

Construct a FilterWithBufferedInput with an attached transformation.

Parameters

firstSize	the size of the first block
blockSize	the size of middle blocks
lastSize	the size of the last block
attachment	an attached transformation

firstSize and lastSize may be 0. blockSize must be at least 1.

Definition at line 320 of file filters.cpp.

Here is the call graph for this function:

Member Function Documentation

virtual bool FilterWithBufferedInput::DidFirstPut ( ) const

inlineprotectedvirtual

Definition at line 357 of file filters.h.

virtual void FilterWithBufferedInput::FirstPut ( const byte * inString )

protectedpure virtual

Implemented in SimpleProxyFilter, SignatureVerificationFilter, AuthenticatedDecryptionFilter, HashVerificationFilter, StreamTransformationFilter, DataDecryptorWithMAC< BC, H, MAC, Info >, DataEncryptorWithMAC< BC, H, MAC, Info >, DataDecryptor< BC, H, Info >, and DataEncryptor< BC, H, Info >.

Here is the caller graph for this function:

virtual void FilterWithBufferedInput::FlushDerived ( )

inlineprotectedvirtual

Definition at line 390 of file filters.h.

Here is the caller graph for this function:

void FilterWithBufferedInput::ForceNextPut ( )

Flushes data buffered by this object.

The input buffer may contain more than blockSize bytes if lastSize != 0. ForceNextPut() forces a call to NextPut() if this is the case.

Definition at line 441 of file filters.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual size_t FilterWithBufferedInput::GetBlockPutSize ( ) const

inlineprotectedvirtual

Definition at line 359 of file filters.h.

virtual size_t FilterWithBufferedInput::GetFirstPutSize ( ) const

inlineprotectedvirtual

Definition at line 358 of file filters.h.

virtual size_t FilterWithBufferedInput::GetLastPutSize ( ) const

inlineprotectedvirtual

Definition at line 360 of file filters.h.

virtual void FilterWithBufferedInput::InitializeDerived ( const NameValuePairs & parameters )

inlineprotectedvirtual

Definition at line 364 of file filters.h.

virtual void FilterWithBufferedInput::InitializeDerivedAndReturnNewSizes	(	const NameValuePairs &	parameters,
		size_t &	firstSize,
		size_t &	blockSize,
		size_t &	lastSize
	)

inlineprotectedvirtual

Reimplemented in SignatureVerificationFilter, AuthenticatedDecryptionFilter, HashVerificationFilter, and StreamTransformationFilter.

Definition at line 362 of file filters.h.

Here is the caller graph for this function:

bool FilterWithBufferedInput::IsolatedFlush	(	bool	hardFlush,
		bool	blocking
	)

virtual

Flushes data buffered by this object, without signal propagation.

Parameters

hardFlush	indicates whether all data should be flushed
blocking	specifies whether the object should block when processing input

IsolatedFlush() calls ForceNextPut() if hardFlush is true

Note: hardFlush must be used with care

Implements BufferedTransformation.

Reimplemented in ProxyFilter.

Definition at line 338 of file filters.cpp.

Here is the call graph for this function:

void FilterWithBufferedInput::IsolatedInitialize ( const NameValuePairs & parameters )

virtual

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.

Reimplemented in AuthenticatedEncryptionFilter, and HexEncoder.

Definition at line 329 of file filters.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void FilterWithBufferedInput::LastPut	(	const byte *	inString,
		size_t	length
	)

protectedpure virtual

Input the last block of data.

Parameters

inString	the input byte buffer
length	the size of the input buffer, in bytes

LastPut() processes the last block of data and signals attached filters to do the same. LastPut() is always called. The pseudo algorithm for the logic is:

    if totalLength < firstSize then length == totalLength
    else if totalLength <= firstSize+lastSize then length == totalLength-firstSize
    else lastSize <= length < lastSize+blockSize

Implemented in SimpleProxyFilter, SignatureVerificationFilter, AuthenticatedDecryptionFilter, AuthenticatedEncryptionFilter, HashVerificationFilter, StreamTransformationFilter, DataDecryptorWithMAC< BC, H, MAC, Info >, DataEncryptorWithMAC< BC, H, MAC, Info >, DataDecryptor< BC, H, Info >, and DataEncryptor< BC, H, Info >.

Here is the caller graph for this function:

virtual int FilterWithBufferedInput::NextPut	(	const byte *	inString,
		size_t	length
	)

inlineprotectedvirtual

Definition at line 402 of file filters.h.

void FilterWithBufferedInput::NextPutMaybeModifiable	(	byte *	inString,
		size_t	length,
		bool	modifiable
	)

inlineprotected

Definition at line 394 of file filters.h.

Here is the caller graph for this function:

virtual void FilterWithBufferedInput::NextPutModifiable	(	byte *	inString,
		size_t	length
	)

inlineprotectedvirtual

Reimplemented in ProxyFilter, and StreamTransformationFilter.

Definition at line 377 of file filters.h.

Here is the caller graph for this function:

void FilterWithBufferedInput::NextPutMultiple	(	const byte *	inString,
		size_t	length
	)

protectedvirtual

Reimplemented in ProxyFilter, SignatureVerificationFilter, AuthenticatedDecryptionFilter, HashVerificationFilter, and StreamTransformationFilter.

Definition at line 459 of file filters.cpp.

Here is the call graph for this function:

virtual void FilterWithBufferedInput::NextPutSingle ( const byte * inString )

inlineprotectedvirtual

Definition at line 371 of file filters.h.

Here is the caller graph for this function:

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

inlinevirtual

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 335 of file filters.h.

Here is the caller graph for this function:

size_t FilterWithBufferedInput::PutMaybeModifiable	(	byte *	begin,
		size_t	length,
		int	messageEnd,
		bool	blocking,
		bool	modifiable
	)

protected

Definition at line 350 of file filters.cpp.

Here is the call graph for this function:

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

inlinevirtual

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 339 of file filters.h.

Member Data Documentation

size_t FilterWithBufferedInput::m_blockSize

protected

Definition at line 422 of file filters.h.

bool FilterWithBufferedInput::m_firstInputDone

protected

Definition at line 423 of file filters.h.

size_t FilterWithBufferedInput::m_firstSize

protected

Definition at line 422 of file filters.h.

size_t FilterWithBufferedInput::m_lastSize

protected

Definition at line 422 of file filters.h.

BlockQueue FilterWithBufferedInput::m_queue

protected

Definition at line 424 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

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation