Crypto++  8.8
Free C++ class library of cryptographic schemes
Classes | Public Member Functions | List of all members
FileStore Class Reference

Implementation of Store interface. More...

+ Inheritance diagram for FileStore:

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  ReadErr
 Exception thrown when file-based read error is encountered. More...
 

Public Member Functions

 FileStore ()
 Construct a FileStore.
 
 FileStore (std::istream &in)
 Construct a FileStore. More...
 
 FileStore (const char *filename)
 Construct a FileStore. More...
 
 FileStore (const wchar_t *filename)
 Construct a FileStore. More...
 
std::istream * GetStream ()
 Retrieves the internal stream. More...
 
const std::istream * GetStream () const
 Retrieves the internal stream. More...
 
lword MaxRetrievable () const
 Provides the number of bytes ready for retrieval. 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...
 
lword Skip (lword skipMax=ULONG_MAX)
 Discard skipMax bytes from the output buffer. More...
 
- Public Member Functions inherited from Store
 Store ()
 Construct a Store.
 
void IsolatedInitialize (const NameValuePairs &parameters)
 Initialize or reinitialize this object, without signal propagation. More...
 
unsigned int NumberOfMessages () const
 Provides the number of meesages processed by this object. More...
 
bool GetNextMessage ()
 Start retrieving the next message. More...
 
unsigned int CopyMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL) const
 
- Public Member Functions inherited from AutoSignaling< InputRejecting< BufferedTransformation > >
 AutoSignaling (int propagation=-1)
 Construct an AutoSignaling. 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 InputRejecting< BufferedTransformation >
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 BufferedTransformation
 BufferedTransformation ()
 Construct a BufferedTransformation.
 
BufferedTransformationRef ()
 Provides a reference to this object. More...
 
virtual bool Attachable ()
 Determines whether the object allows attachment. More...
 
virtual BufferedTransformationAttachedTransformation ()
 Returns the object immediately attached to this object. More...
 
virtual const BufferedTransformationAttachedTransformation () const
 Returns the object immediately attached to this object. More...
 
virtual void Detach (BufferedTransformation *newAttachment=NULL)
 Delete the current attachment chain and attach a new one. 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 byteCreatePutSpace (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.
 
void GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
 Retrieves waitable objects. More...
 
virtual void Initialize (const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)
 Initialize or reinitialize this object, with signal propagation. More...
 
virtual bool Flush (bool hardFlush, int propagation=-1, bool blocking=true)
 Flush buffered input and/or output, with signal propagation. More...
 
virtual bool MessageSeriesEnd (int propagation=-1, bool blocking=true)
 Marks the end of a series of messages, with signal propagation. 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...
 
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 bool AnyMessages () const
 Determines if any messages are available for retrieval. 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 byteChannelCreatePutSpace (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 ClonableClone () const
 Copies this object. More...
 
- Public Member Functions inherited from Waitable
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 22 of file files.h.

Constructor & Destructor Documentation

◆ FileStore() [1/3]

FileStore::FileStore ( std::istream &  in)
inline

Construct a FileStore.

Parameters
inan existing stream

Definition at line 41 of file files.h.

◆ FileStore() [2/3]

FileStore::FileStore ( const char *  filename)
inline

Construct a FileStore.

Parameters
filenamethe narrow name of the file to open

Definition at line 46 of file files.h.

◆ FileStore() [3/3]

FileStore::FileStore ( const wchar_t *  filename)
inline

Construct a FileStore.

Parameters
filenamethe Unicode name of the file to open

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

Definition at line 53 of file files.h.

Member Function Documentation

◆ GetStream() [1/2]

std::istream* FileStore::GetStream ( )
inline

Retrieves the internal stream.

Returns
the internal stream pointer

Definition at line 59 of file files.h.

◆ GetStream() [2/2]

const std::istream* FileStore::GetStream ( ) const
inline

Retrieves the internal stream.

Returns
the internal stream pointer

Definition at line 63 of file files.h.

◆ MaxRetrievable()

lword FileStore::MaxRetrievable ( ) const
virtual

Provides the number of bytes ready for retrieval.

Returns
the number of bytes ready for retrieval

All retrieval functions return the actual number of bytes retrieved, which is the lesser of the request number and MaxRetrievable()

Reimplemented from BufferedTransformation.

◆ TransferTo2()

size_t FileStore::TransferTo2 ( BufferedTransformation target,
lword byteCount,
const std::string &  channel = DEFAULT_CHANNEL,
bool  blocking = true 
)
virtual

Transfer bytes from this object to another BufferedTransformation.

Parameters
targetthe destination BufferedTransformation
byteCountthe number of bytes to transfer
channelthe channel on which the transfer should occur
blockingspecifies whether the object should block when processing input
Returns
the number of bytes that remain in the transfer block (i.e., bytes not transferred)

TransferTo2() removes bytes from this object and moves them to the destination. Transfer begins at the index position in the current stream, and not from an absolute position in the stream.

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

Implements BufferedTransformation.

◆ CopyRangeTo2()

size_t FileStore::CopyRangeTo2 ( BufferedTransformation target,
lword begin,
lword  end = LWORD_MAX,
const std::string &  channel = DEFAULT_CHANNEL,
bool  blocking = true 
) const
virtual

Copy bytes from this object to another BufferedTransformation.

Parameters
targetthe destination BufferedTransformation
beginthe 0-based index of the first byte to copy in the stream
endthe 0-based index of the last byte to copy in the stream
channelthe channel on which the transfer should occur
blockingspecifies whether the object should block when processing input
Returns
the number of bytes that remain in the copy block (i.e., bytes not copied)

CopyRangeTo2 copies bytes from this object to the destination. The bytes are not removed from this object. Copying begins at the index position in the current stream, and not from an absolute position in the stream.

begin is an IN and OUT parameter. When the call is made, begin is the starting position of the copy. When the call returns, begin is the position of the first byte that was not copied (which may be different than end). begin can be used for subsequent calls to CopyRangeTo2().

Implements BufferedTransformation.

◆ Skip()

lword FileStore::Skip ( lword  skipMax = ULONG_MAX)
virtual

Discard skipMax bytes from the output buffer.

Parameters
skipMaxthe number of bytes to discard

Skip() discards bytes from the output buffer, which is the AttachedTransformation(), if present. The function always returns the parameter skipMax.

If you want to skip bytes from a Source, then perform the following.

  StringSource ss(str, false, new Redirector(TheBitBucket()));
  ss.Pump(10);    // Skip 10 bytes from Source
  ss.Detach(new FilterChain(...));
  ss.PumpAll();

Reimplemented from BufferedTransformation.


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