Implementation of BufferedTransformation's attachment interface. More...

#include <filters.h>

Inheritance diagram for Source:

Collaboration diagram for Source:

Public Member Functions
virtual	~Source ()

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

PIPELINE
lword	Pump (lword pumpMax=(size_t) SIZE_MAX)
	Pump data to attached transformation. More...

unsigned int	PumpMessages (unsigned int count=UINT_MAX)
	Pump messages to attached transformation. More...

void	PumpAll ()
	Pump all data to attached transformation. More...

virtual size_t	Pump2 (lword &byteCount, bool blocking=true)=0
	Pump data to attached transformation. More...

virtual size_t	PumpMessages2 (unsigned int &messageCount, bool blocking=true)=0
	Pump messages to attached transformation. More...

virtual size_t	PumpAll2 (bool blocking=true)
	Pump all data to attached transformation. More...

virtual bool	SourceExhausted () const =0
	Determines if the Source is exhausted. More...

Public Member Functions inherited from InputRejecting< Filter >
size_t	Put2 (const byte *inString, size_t length, int messageEnd, bool blocking)
	Input a byte array for processing. More...

bool	IsolatedFlush (bool hardFlush, bool blocking)

bool	IsolatedMessageSeriesEnd (bool blocking)

size_t	ChannelPut2 (const std::string &channel, const byte *inString, size_t length, int messageEnd, bool blocking)

bool	ChannelMessageSeriesEnd (const std::string &channel, int messageEnd, 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 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...

virtual size_t	PutModifiable2 (byte *inString, size_t length, int messageEnd, bool blocking)
	Input multiple bytes that may be modified by callee. 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	IsolatedInitialize (const NameValuePairs &parameters)
	Initialize or reinitialize this object, 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	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 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
void	SourceInitialize (bool pumpAll, const NameValuePairs &parameters)

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

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

Protected Attributes inherited from Filter
size_t	m_inputPosition

int	m_continueAt

Detailed Description

Implementation of BufferedTransformation's attachment interface.

Source is a cornerstone of the Pipeline trinitiy. Data flows from Sources, through Filters, and then terminates in Sinks. The difference between a Source and Filter is a Source pumps data, while a Filter does not. The difference between a Filter and a Sink is a Filter allows an attached transformation, while a Sink does not.

See the discussion of BufferedTransformation in cryptlib.h for more details.

See also: Store and SourceTemplate

Definition at line 1239 of file filters.h.

Constructor & Destructor Documentation

virtual Source::~Source ( )

inlinevirtual

Definition at line 1242 of file filters.h.

Source::Source ( BufferedTransformation * attachment = NULL )

inline

Construct a Source.

Parameters

attachment an optional attached transformation

Definition at line 1246 of file filters.h.

Here is the call graph for this function:

Member Function Documentation

lword Source::Pump ( lword pumpMax = (size_t)SIZE_MAX )

inline

Pump data to attached transformation.

Parameters

pumpMax the maximpum number of bytes to pump

Returns: the number of bytes that remain in the block (i.e., bytes not processed)

Internally, Pump() calls Pump2().

Note: pumpMax is a lword, which is a 64-bit value that typically uses LWORD_MAX. The default argument is a size_t that uses SIZE_MAX, and it can be 32-bits or 64-bits.

Definition at line 1258 of file filters.h.

Here is the caller graph for this function:

virtual size_t Source::Pump2	(	lword &	byteCount,
		bool	blocking = `true`
	)

pure virtual

Pump data to attached transformation.

Parameters

byteCount	the maximpum number of bytes to pump
blocking	specifies whether the object should block when processing input

Returns: the number of bytes that remain in the block (i.e., bytes not processed)

byteCount is an IN and OUT parameter. When the call is made, byteCount is the requested size of the pump. When the call returns, byteCount is the number of bytes that were pumped.

Implemented in SourceTemplate< T >, SourceTemplate< FileStore >, SourceTemplate< RandomNumberStore >, and SourceTemplate< StringStore >.

void Source::PumpAll ( )

inline

Pump all data to attached transformation.

Internally, PumpAll() calls PumpAll2().

Definition at line 1270 of file filters.h.

Here is the caller graph for this function:

size_t Source::PumpAll2 ( bool blocking = true )

virtual

Pump all data to attached transformation.

Parameters

blocking specifies whether the object should block when processing input

Returns: the number of bytes that remain in the block (i.e., bytes not processed)

Reimplemented in SourceTemplate< T >, SourceTemplate< FileStore >, SourceTemplate< RandomNumberStore >, and SourceTemplate< StringStore >.

Definition at line 1054 of file filters.cpp.

unsigned int Source::PumpMessages ( unsigned int count = UINT_MAX )

inline

Pump messages to attached transformation.

Parameters

count the maximpum number of messages to pump

Returns: TODO

Internally, PumpMessages() calls PumpMessages2().

Definition at line 1265 of file filters.h.

virtual size_t Source::PumpMessages2	(	unsigned int &	messageCount,
		bool	blocking = `true`
	)

pure virtual

Pump messages to attached transformation.

Parameters

messageCount	the maximpum number of messages to pump
blocking	specifies whether the object should block when processing input

messageCount is an IN and OUT parameter.

Implemented in SourceTemplate< T >, SourceTemplate< FileStore >, SourceTemplate< RandomNumberStore >, and SourceTemplate< StringStore >.

virtual bool Source::SourceExhausted ( ) const

pure virtual

Determines if the Source is exhausted.

Returns: true if the source has been exhausted

Implemented in SourceTemplate< T >, SourceTemplate< FileStore >, SourceTemplate< RandomNumberStore >, and SourceTemplate< StringStore >.

void Source::SourceInitialize	(	bool	pumpAll,
		const NameValuePairs &	parameters
	)

inlineprotected

Definition at line 1300 of file filters.h.

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

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation