Implementation of Store interface. More...

#include <files.h>

Inheritance diagram for FileSink:

Classes
class	Err
	Exception thrown when file-based error is encountered. More...

class	OpenErr
	Exception thrown when file-based open error is encountered. More...

class	WriteErr
	Exception thrown when file-based write error is encountered. More...

Public Member Functions
	FileSink ()
	Construct a FileSink.

	FileSink (std::ostream &out)
	Construct a FileSink.

	FileSink (const char *filename, bool binary=true)
	Construct a FileSink.

std::ostream *	GetStream ()
	Retrieves the internal stream.

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

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

bool	IsolatedFlush (bool hardFlush, bool blocking)
	Flushes data buffered by this object, without signal propagation.

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

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.

Public Member Functions inherited from BufferedTransformation
	BufferedTransformation ()
	Construct a BufferedTransformation.

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

virtual bool	Attachable ()
	Determines whether the object allows attachment.

virtual BufferedTransformation *	AttachedTransformation ()
	Returns the object immediately attached to this object.

virtual const BufferedTransformation *	AttachedTransformation () const
	Returns the object immediately attached to this object.

virtual void	Detach (BufferedTransformation *newAttachment=NULLPTR)
	Delete the current attachment chain and attach a new one.

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

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

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

size_t	PutWord16 (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)

size_t	PutWord32 (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)

size_t	PutWord64 (word64 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

size_t	GetWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER)
	Retrieve a 64-bit word.

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

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

size_t	PeekWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
	Peek a 64-bit word.

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

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

lword	CopyTo (BufferedTransformation &target, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
	Copy bytes from this object to another BufferedTransformation.

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.

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

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

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

virtual bool	GetNextMessage ()
	Start retrieving the next message.

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

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

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.

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

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

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

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

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

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

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.

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

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

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.

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.

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.

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.

size_t	ChannelPutWord64 (const std::string &channel, word64 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 64-bit word for processing on a channel.

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

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.

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

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.

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.

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

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

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

Public Member Functions inherited from Algorithm
	Algorithm (bool checkSelfTestStatus=true)
	Interface for all crypto algorithms.

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

virtual std::string	AlgorithmProvider () const
	Retrieve the provider of this algorithm.

Public Member Functions inherited from Clonable
virtual Clonable *	Clone () const
	Copies this object.

Public Member Functions inherited from Waitable
bool	Wait (unsigned long milliseconds, CallStack const &callStack)
	Wait on this object.

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

Detailed Description

Implementation of Store interface.

file-based implementation of Sink interface

Definition at line 130 of file files.h.

Constructor & Destructor Documentation

◆ FileSink() [1/3]

FileSink::FileSink ( )

inline

Construct a FileSink.

Definition at line 145 of file files.h.

◆ FileSink() [2/3]

FileSink::FileSink ( std::ostream & out )

inline

Construct a FileSink.

Parameters

out	an existing stream

Definition at line 149 of file files.h.

◆ FileSink() [3/3]

FileSink::FileSink	(	const char *	filename,
		bool	binary = `true`
	)

inline

Construct a FileSink.

Parameters

filename	the narrow name of the file to open
binary	flag indicating if the file is binary

Definition at line 155 of file files.h.

Member Function Documentation

◆ GetStream()

std::ostream * FileSink::GetStream ( )

inline

Retrieves the internal stream.

Returns: the internal stream pointer

Definition at line 168 of file files.h.

◆ IsolatedFlush()

bool FileSink::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

Returns: true if the flush was successful, false otherwise

Note: hardFlush must be used with care

Implements BufferedTransformation.

Definition at line 260 of file files.cpp.

◆ IsolatedInitialize()

void FileSink::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.

Definition at line 221 of file files.cpp.

◆ Put2()

size_t FileSink::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

Returns: the number of bytes that remain to be processed (i.e., bytes not processed). 0 indicates all bytes were processed.

Derived classes must implement Put2().

Implements BufferedTransformation.

Definition at line 273 of file files.cpp.

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

G:/work/subversion/scol-technologies/trunk/scol/plugins/security/cryptopp/files.h
G:/work/subversion/scol-technologies/trunk/scol/plugins/security/cryptopp/files.cpp

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FileSink() [1/3]

◆ FileSink() [2/3]

◆ FileSink() [3/3]

Member Function Documentation

◆ GetStream()

◆ IsolatedFlush()

◆ IsolatedInitialize()

◆ Put2()