Implementation of Store interface. More...

#include <files.h>

Inheritance diagram for FileSource:

Public Types
typedef FileStore::Err	Err

typedef FileStore::OpenErr	OpenErr

typedef FileStore::ReadErr	ReadErr

Public Member Functions
	FileSource (BufferedTransformation *attachment=NULL)
	Construct a FileSource. More...

	FileSource (std::istream &in, bool pumpAll, BufferedTransformation *attachment=NULL)
	Construct a FileSource. More...

	FileSource (const char filename, bool pumpAll, BufferedTransformation attachment=NULL, bool binary=true)
	Construct a FileSource. More...

	FileSource (const wchar_t filename, bool pumpAll, BufferedTransformation attachment=NULL, bool binary=true)
	Construct a FileSource. More...

std::istream *	GetStream ()
	Retrieves the internal stream. More...

Public Member Functions inherited from SourceTemplate< FileStore >
	SourceTemplate (BufferedTransformation *attachment)
	Construct a SourceTemplate. More...

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

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

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

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

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

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

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

Public Member Functions inherited from Source
	Source (BufferedTransformation *attachment=NULL)
	Construct a Source. More...

lword	Pump (lword pumpMax=...)
	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...

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)
	Flushes data buffered by this object, without signal propagation. More...

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

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

bool	ChannelMessageSeriesEnd (const std::string &channel, int messageEnd, bool blocking)
	Marks the end of a series of messages on a channel. More...

Public Member Functions inherited from Filter
	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...

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

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

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

virtual void	Attach (BufferedTransformation *newAttachment)
	Add newAttachment to the end of attachment chain. 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...

size_t	PutWord64 (word64 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
	Input a 64-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 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	GetWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER)
	Retrieve a 64-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...

size_t	PeekWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
	Peek a 64-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 bytes from this object to another BufferedTransformation. 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.

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

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

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

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

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

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

Public Member Functions inherited from Waitable
virtual unsigned int	GetMaxWaitObjectCount () const =0
	Maximum number of wait objects that this object can return. More...

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

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

Detailed Description

Implementation of Store interface.

file-based implementation of Store interface

Definition at line 86 of file files.h.

Member Typedef Documentation

◆ Err

typedef FileStore::Err FileSource::Err

Definition at line 89 of file files.h.

◆ OpenErr

typedef FileStore::OpenErr FileSource::OpenErr

Definition at line 90 of file files.h.

◆ ReadErr

typedef FileStore::ReadErr FileSource::ReadErr

Definition at line 91 of file files.h.

Constructor & Destructor Documentation

◆ FileSource() [1/4]

FileSource::FileSource ( BufferedTransformation * attachment = NULL )

inline

Construct a FileSource.

Definition at line 94 of file files.h.

◆ FileSource() [2/4]

FileSource::FileSource	(	std::istream &	in,
		bool	pumpAll,
		BufferedTransformation *	attachment = `NULL`
	)

inline

Construct a FileSource.

Parameters

in	an existing stream
pumpAll	flag indicating if source data should be pumped to its attached transformation
attachment	an optional attached transformation

Definition at line 101 of file files.h.

◆ FileSource() [3/4]

FileSource::FileSource	(	const char *	filename,
		bool	pumpAll,
		BufferedTransformation *	attachment = `NULL`,
		bool	binary = `true`
	)

inline

Construct a FileSource.

Parameters

filename	the narrow name of the file to open
pumpAll	flag indicating if source data should be pumped to its attached transformation
attachment	an optional attached transformation
binary	flag indicating if the file is binary

Definition at line 109 of file files.h.

◆ FileSource() [4/4]

FileSource::FileSource	(	const wchar_t *	filename,
		bool	pumpAll,
		BufferedTransformation *	attachment = `NULL`,
		bool	binary = `true`
	)

inline

Construct a FileSource.

Parameters

filename	the Unicode name of the file to open
pumpAll	flag indicating if source data should be pumped to its attached transformation
attachment	an optional attached transformation
binary	flag indicating if the file is binary

On non-Windows OS, this function assumes that setlocale() has been called.

Definition at line 119 of file files.h.

Member Function Documentation

◆ GetStream()

std::istream * FileSource::GetStream ( )

inline

Retrieves the internal stream.

Returns: the internal stream pointer

Definition at line 125 of file files.h.

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

files.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ Err

◆ OpenErr

◆ ReadErr

Constructor & Destructor Documentation

◆ FileSource() [1/4]

◆ FileSource() [2/4]

◆ FileSource() [3/4]

◆ FileSource() [4/4]

Member Function Documentation

◆ GetStream()