Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Classes | Public Member Functions | Static Public Attributes | List of all members
BufferedTransformation Class Referenceabstract

Interface for buffered transformations. More...

+ Inheritance diagram for BufferedTransformation:

Classes

class  BlockingInputOnly
 Exception thrown by objects that have not implemented nonblocking input processing. More...
 
struct  InvalidChannelName
 Exception thrown when a filter does not recognize a named channel. More...
 
struct  NoChannelSupport
 Exception thrown when a filter does not support named channels. More...
 

Public Member Functions

 BufferedTransformation ()
 Construct a BufferedTransformation.
 
BufferedTransformationRef ()
 Provides a reference to this object. 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...
 
- 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...
 

Static Public Attributes

static const std::string & NULL_CHANNEL = DEFAULT_CHANNEL
 

INPUT

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 modifed 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 Put2 (const byte *inString, size_t length, int messageEnd, bool blocking)=0
 Input multiple bytes for processing. More...
 
virtual size_t PutModifiable2 (byte *inString, size_t length, int messageEnd, bool blocking)
 Input multiple bytes that may be modified by callee. More...
 

WAITING

unsigned int GetMaxWaitObjectCount () const
 Retrieves the maximum number of waitable objects.
 
void GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
 Retrieves waitable objects. More...
 

SIGNALS

virtual void IsolatedInitialize (const NameValuePairs &parameters)
 Initialize or reinitialize this object, without signal propagation. More...
 
virtual bool IsolatedFlush (bool hardFlush, bool blocking)=0
 Flushes data buffered by this object, without signal propagation. More...
 
virtual bool IsolatedMessageSeriesEnd (bool blocking)
 Marks the end of a series of messages, without signal propagation. 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 void SetAutoSignalPropagation (int propagation)
 Set propagation of automatically generated and transferred signals. More...
 
virtual int GetAutoSignalPropagation () const
 Retrieve automatic signal propagation value. More...
 

RETRIEVAL OF ONE MESSAGE

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

RETRIEVAL OF MULTIPLE MESSAGES

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

NON-BLOCKING TRANSFER OF OUTPUT

virtual size_t TransferTo2 (BufferedTransformation &target, lword &byteCount, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)=0
 Transfer bytes from this object to another BufferedTransformation. More...
 
virtual size_t CopyRangeTo2 (BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) const =0
 Copy bytes from this object to another BufferedTransformation. 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...
 

CHANNELS

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

ATTACHMENT

Some BufferedTransformation objects (e.g. Filter objects) allow other BufferedTransformation objects to be attached. When this is done, the first object instead of buffering its output, sends that output to the attached object as input. The entire attachment chain is deleted when the anchor object is destructed.

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=0)
 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...
 

Detailed Description

Interface for buffered transformations.

BufferedTransformation is a generalization of BlockTransformation, StreamTransformation and HashTransformation.

A buffered transformation is an object that takes a stream of bytes as input (this may be done in stages), does some computation on them, and then places the result into an internal buffer for later retrieval. Any partial result already in the output buffer is not modified by further input.

If a method takes a "blocking" parameter, and you pass false for it, then the method will return before all input has been processed if the input cannot be processed without waiting (for network buffers to become available, for example). In this case the method will return true or a non-zero integer value. When this happens you must continue to call the method with the same parameters until it returns false or zero, before calling any other method on it or attached /p BufferedTransformation. The integer return value in this case is approximately the number of bytes left to be processed, and can be used to implement a progress bar.

For functions that take a "propagation" parameter, propagation != 0 means pass on the signal to attached BufferedTransformation objects, with propagation decremented at each step until it reaches 0. -1 means unlimited propagation.

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

Most of the input functions, like Put() and PutWord32(), return the number of bytes remaining to be processed. A 0 value means all bytes were processed, and a non-0 value means bytes remain to be processed.

Definition at line 1352 of file cryptlib.h.

Member Function Documentation

BufferedTransformation& BufferedTransformation::Ref ( )
inline

Provides a reference to this object.

Returns
A reference to this object

Useful for passing a temporary object to a function that takes a non-const reference

Definition at line 1368 of file cryptlib.h.

size_t BufferedTransformation::Put ( byte  inByte,
bool  blocking = true 
)
inline

Input a byte for processing.

Parameters
inBytethe 8-bit byte (octet) to be processed.
blockingspecifies whether the object should block when processing input.
Returns
the number of bytes that remain in the block (i.e., bytes not processed)

Put(byte) calls Put(byte*, size_t).

Definition at line 1378 of file cryptlib.h.

size_t BufferedTransformation::Put ( const byte *  inString,
size_t  length,
bool  blocking = true 
)
inline

Input a byte buffer for processing.

Parameters
inStringthe byte buffer to process
lengththe size of the string, in bytes
blockingspecifies whether the object should block when processing input
Returns
the number of bytes that remain in the block (i.e., bytes not processed)

Internally, Put() calls Put2().

Definition at line 1387 of file cryptlib.h.

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

Input a 16-bit word for processing.

Parameters
valuethe 16-bit value to be processed
orderthe ByteOrder in which the word should be processed
blockingspecifies whether the object should block when processing input
Returns
the number of bytes that remain in the block (i.e., bytes not processed)

Definition at line 717 of file cryptlib.cpp.

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

Input a 32-bit word for processing.

Parameters
valuethe 32-bit value to be processed.
orderthe ByteOrder in which the word should be processed.
blockingspecifies whether the object should block when processing input.
Returns
the number of bytes that remain in the block (i.e., bytes not processed)

Definition at line 722 of file cryptlib.cpp.

virtual byte* BufferedTransformation::CreatePutSpace ( size_t &  size)
inlinevirtual

Request space which can be written into by the caller.

Parameters
sizethe requested size of the buffer

The purpose of this method is to help avoid extra memory allocations.

size is an IN and OUT parameter and used as a hint. When the call is made, size is the requested size of the buffer. When the call returns, size is the size of the array returned to the caller.

The base class implementation sets size to 0 and returns NULL.

Note
Some objects, like ArraySink, cannot create a space because its fixed. In the case of an ArraySink, the pointer to the array is returned and the size is remaining size.

Reimplemented in ArrayXorSink, ArraySink, OutputProxy, Redirector, HashFilter, MeterFilter, and ByteQueue.

Definition at line 1413 of file cryptlib.h.

virtual bool BufferedTransformation::CanModifyInput ( ) const
inlinevirtual

Determines whether input can be modifed by the callee.

Returns
true if input can be modified, false otherwise

The base class implementation returns false.

Reimplemented in Redirector.

Definition at line 1419 of file cryptlib.h.

size_t BufferedTransformation::PutModifiable ( byte *  inString,
size_t  length,
bool  blocking = true 
)
inline

Input multiple bytes that may be modified by callee.

Parameters
inStringthe byte buffer to process
lengththe size of the string, in bytes
blockingspecifies whether the object should block when processing input
Returns
0 indicates all bytes were processed during the call. Non-0 indicates the number of bytes that were not processed

Definition at line 1428 of file cryptlib.h.

bool BufferedTransformation::MessageEnd ( int  propagation = -1,
bool  blocking = true 
)
inline

Signals the end of messages to the object.

Parameters
propagationthe number of attached transformations the MessageEnd() signal should be passed
blockingspecifies whether the object should block when processing input

propagation count includes this object. Setting propagation to 1 means this object only. Setting propagation to -1 means unlimited propagation.

Definition at line 1436 of file cryptlib.h.

size_t BufferedTransformation::PutMessageEnd ( const byte *  inString,
size_t  length,
int  propagation = -1,
bool  blocking = true 
)
inline

Input multiple bytes for processing and signal the end of a message.

Parameters
inStringthe byte buffer to process
lengththe size of the string, in bytes
propagationthe number of attached transformations the MessageEnd() signal should be passed
blockingspecifies whether the object should block when processing input
Returns
the number of bytes that remain in the block (i.e., bytes not processed)

Internally, PutMessageEnd() calls Put2() with a modified propagation to ensure all attached transformations finish processing the message.

propagation count includes this object. Setting propagation to 1 means this object only. Setting propagation to -1 means unlimited propagation.

Definition at line 1449 of file cryptlib.h.

virtual size_t BufferedTransformation::Put2 ( const byte *  inString,
size_t  length,
int  messageEnd,
bool  blocking 
)
pure virtual

Input multiple bytes for processing.

Parameters
inStringthe byte buffer to process
lengththe size of the string, in bytes
messageEndmeans how many filters to signal MessageEnd() to, including this one
blockingspecifies whether the object should block when processing input

Derived classes must implement Put2().

Implemented in FilterTester, ArrayXorSink, ArraySink, RandomNumberSink, StringSinkTemplate< T >, StringSinkTemplate< std::string >, OutputProxy, PK_DefaultDecryptionFilter, Redirector, PK_DefaultEncryptionFilter, SignerFilter, HashFilter, FilterWithInputQueue, FilterWithBufferedInput, BitBucket, MeterFilter, NetworkSink, PaddingRemover, InputRejecting< BufferedTransformation >, InputRejecting< Filter >, Grouper, Deflator, InformationDispersal, Inflator, FileSink, MaurerRandomnessTest, BaseN_Decoder, SecretSharing, BaseN_Encoder, ByteQueue, and MessageQueue.

virtual size_t BufferedTransformation::PutModifiable2 ( byte *  inString,
size_t  length,
int  messageEnd,
bool  blocking 
)
inlinevirtual

Input multiple bytes that may be modified by callee.

Parameters
inStringthe byte buffer to process.
lengththe size of the string, in bytes.
messageEndmeans how many filters to signal MessageEnd() to, including this one.
blockingspecifies whether the object should block when processing input.

Internally, PutModifiable2() calls Put2().

Reimplemented in OutputProxy, FilterWithBufferedInput, and MeterFilter.

Definition at line 1466 of file cryptlib.h.

void BufferedTransformation::GetWaitObjects ( WaitObjectContainer container,
CallStack const &  callStack 
)
virtual

Retrieves waitable objects.

Parameters
containerthe wait container to receive the references to the objects
callStackCallStack object used to select waitable objects

GetWaitObjects is usually called in one of two ways. First, it can be called like something.GetWaitObjects(c, CallStack("my func after X", 0));. Second, if in an outer GetWaitObjects() method that itself takes a callStack parameter, it can be called like innerThing.GetWaitObjects(c, CallStack("MyClass::GetWaitObjects at X", &callStack));.

Implements Waitable.

Reimplemented in Redirector, NetworkSink, and NetworkSource.

Definition at line 431 of file cryptlib.cpp.

virtual void BufferedTransformation::IsolatedInitialize ( const NameValuePairs parameters)
inlinevirtual

Initialize or reinitialize this object, without signal propagation.

Parameters
parametersa 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 constuctors 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 in SourceTemplate< T >, SourceTemplate< FileStore >, SourceTemplate< RandomNumberStore >, SourceTemplate< StringStore >, ArraySink, RandomNumberSink, StringSinkTemplate< T >, StringSinkTemplate< std::string >, SignerFilter, AuthenticatedEncryptionFilter, HashFilter, FilterWithBufferedInput, BitBucket, MeterFilter, Store, Base64URLDecoder, PaddingRemover, Grouper, InformationRecovery, Base64URLEncoder, Deflator, InformationDispersal, Inflator, ChannelSwitch, FileSink, SecretRecovery, ByteQueue::Walker, Base32Decoder, BaseN_Decoder, Base64Decoder, SecretSharing, Base32Encoder, Base64Encoder, BaseN_Encoder, HexDecoder, ByteQueue, RawIDA, HexEncoder, and MessageQueue.

Definition at line 1505 of file cryptlib.h.

virtual bool BufferedTransformation::IsolatedFlush ( bool  hardFlush,
bool  blocking 
)
pure virtual

Flushes data buffered by this object, without signal propagation.

Parameters
hardFlushindicates whether all data should be flushed
blockingspecifies whether the object should block when processing input
Note
hardFlush must be used with care

Implemented in ProxyFilter, FilterWithBufferedInput, NonblockingSink, Deflator, Inflator, FileSink, and MessageQueue.

virtual bool BufferedTransformation::IsolatedMessageSeriesEnd ( bool  blocking)
inlinevirtual

Marks the end of a series of messages, without signal propagation.

Parameters
blockingspecifies whether the object should block when completing the processing on the current series of messages

Reimplemented in MeterFilter, and MessageQueue.

Definition at line 1519 of file cryptlib.h.

void BufferedTransformation::Initialize ( const NameValuePairs parameters = g_nullNameValuePairs,
int  propagation = -1 
)
virtual

Initialize or reinitialize this object, with signal propagation.

Parameters
parametersa set of NameValuePairs to initialize or reinitialize this object
propagationthe number of attached transformations the Initialize() signal should be passed

Initialize() is used to initialize or reinitialize an object using a variable number of arbitrarily typed arguments. The function avoids the need for multiple constuctors providing all possible combintations of configurable parameters.

propagation count includes this object. Setting propagation to 1 means this object only. Setting propagation to -1 means unlimited propagation.

Reimplemented in OutputProxy, Redirector, and Filter.

Definition at line 438 of file cryptlib.cpp.

bool BufferedTransformation::Flush ( bool  hardFlush,
int  propagation = -1,
bool  blocking = true 
)
virtual

Flush buffered input and/or output, with signal propagation.

Parameters
hardFlushis used to indicate whether all data should be flushed
propagationthe number of attached transformations the Flush() signal should be passed
blockingspecifies whether the object should block when processing input

propagation count includes this object. Setting propagation to 1 means this object only. Setting propagation to -1 means unlimited propagation.

Note
Hard flushes must be used with care. It means try to process and output everything, even if there may not be enough data to complete the action. For example, hard flushing a HexDecoder would cause an error if you do it after inputing an odd number of hex encoded characters.
For some types of filters, like ZlibDecompressor, hard flushes can only be done at "synchronization points". These synchronization points are positions in the data stream that are created by hard flushes on the corresponding reverse filters, in this example ZlibCompressor. This is useful when zlib compressed data is moved across a network in packets and compression state is preserved across packets, as in the SSH2 protocol.

Reimplemented in OutputProxy, Redirector, InformationDispersal, Filter, and SecretSharing.

Definition at line 445 of file cryptlib.cpp.

bool BufferedTransformation::MessageSeriesEnd ( int  propagation = -1,
bool  blocking = true 
)
virtual

Marks the end of a series of messages, with signal propagation.

Parameters
propagationthe number of attached transformations the MessageSeriesEnd() signal should be passed
blockingspecifies whether the object should block when processing input

Each object that receives the signal will perform its processing, decrement propagation, and then pass the signal on to attached transformations if the value is not 0.

propagation count includes this object. Setting propagation to 1 means this object only. Setting propagation to -1 means unlimited propagation.

Note
There should be a MessageEnd() immediately before MessageSeriesEnd().

Reimplemented in OutputProxy, Redirector, and Filter.

Definition at line 452 of file cryptlib.cpp.

virtual void BufferedTransformation::SetAutoSignalPropagation ( int  propagation)
inlinevirtual

Set propagation of automatically generated and transferred signals.

Parameters
propagationthen new value

Setting propagation to 0 means do not automaticly generate signals. Setting propagation to -1 means unlimited propagation.

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

Definition at line 1562 of file cryptlib.h.

virtual int BufferedTransformation::GetAutoSignalPropagation ( ) const
inlinevirtual

Retrieve automatic signal propagation value.

Returns
the number of attached transformations the signal is propogated to. 0 indicates the signal is only witnessed by this object

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

Definition at line 1568 of file cryptlib.h.

lword BufferedTransformation::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 in NullStore, RandomNumberStore, ByteQueue::Walker, FileStore, MessageQueue, and ByteQueue.

Definition at line 499 of file cryptlib.cpp.

bool BufferedTransformation::AnyRetrievable ( ) const
virtual

Determines whether bytes are ready for retrieval.

Returns
true if bytes are available for retrieval, false otherwise

Reimplemented in RandomNumberStore, MessageQueue, and ByteQueue.

Definition at line 507 of file cryptlib.cpp.

size_t BufferedTransformation::Get ( byte &  outByte)
virtual

Retrieve a 8-bit byte.

Parameters
outBytethe 8-bit value to be retrieved
Returns
the number of bytes consumed during the call.

Use the return value of Get to detect short reads.

Reimplemented in ByteQueue::Walker, and ByteQueue.

Definition at line 518 of file cryptlib.cpp.

size_t BufferedTransformation::Get ( byte *  outString,
size_t  getMax 
)
virtual

Retrieve a block of bytes.

Parameters
outStringa block of bytes
getMaxthe number of bytes to Get
Returns
the number of bytes consumed during the call.

Use the return value of Get to detect short reads.

Reimplemented in ByteQueue::Walker, and ByteQueue.

Definition at line 526 of file cryptlib.cpp.

size_t BufferedTransformation::Peek ( byte &  outByte) const
virtual

Peek a 8-bit byte.

Parameters
outBytethe 8-bit value to be retrieved
Returns
the number of bytes read during the call.

Peek does not remove bytes from the object. Use the return value of Get to detect short reads.

Reimplemented in ByteQueue::Walker, and ByteQueue.

Definition at line 537 of file cryptlib.cpp.

size_t BufferedTransformation::Peek ( byte *  outString,
size_t  peekMax 
) const
virtual

Peek a block of bytes.

Parameters
outStringa block of bytes
peekMaxthe number of bytes to Peek
Returns
the number of bytes read during the call.

Peek does not remove bytes from the object. Use the return value of Get to detect short reads.

Reimplemented in ByteQueue::Walker, and ByteQueue.

Definition at line 545 of file cryptlib.cpp.

size_t BufferedTransformation::GetWord16 ( word16 &  value,
ByteOrder  order = BIG_ENDIAN_ORDER 
)

Retrieve a 16-bit word.

Parameters
valuethe 16-bit value to be retrieved
orderthe ByteOrder in which the word should be retrieved
Returns
the number of bytes consumed during the call.

Use the return value of GetWord16 to detect short reads.

Definition at line 753 of file cryptlib.cpp.

size_t BufferedTransformation::GetWord32 ( word32 &  value,
ByteOrder  order = BIG_ENDIAN_ORDER 
)

Retrieve a 32-bit word.

Parameters
valuethe 32-bit value to be retrieved
orderthe ByteOrder in which the word should be retrieved
Returns
the number of bytes consumed during the call.

Use the return value of GetWord16 to detect short reads.

Definition at line 758 of file cryptlib.cpp.

size_t BufferedTransformation::PeekWord16 ( word16 &  value,
ByteOrder  order = BIG_ENDIAN_ORDER 
) const

Peek a 16-bit word.

Parameters
valuethe 16-bit value to be retrieved
orderthe ByteOrder in which the word should be retrieved
Returns
the number of bytes consumed during the call.

Peek does not consume bytes in the stream. Use the return value of GetWord16 to detect short reads.

Definition at line 727 of file cryptlib.cpp.

size_t BufferedTransformation::PeekWord32 ( word32 &  value,
ByteOrder  order = BIG_ENDIAN_ORDER 
) const

Peek a 32-bit word.

Parameters
valuethe 32-bit value to be retrieved
orderthe ByteOrder in which the word should be retrieved
Returns
the number of bytes consumed during the call.

Peek does not consume bytes in the stream. Use the return value of GetWord16 to detect short reads.

Definition at line 740 of file cryptlib.cpp.

lword BufferedTransformation::TransferTo ( BufferedTransformation target,
lword  transferMax = LWORD_MAX,
const std::string &  channel = DEFAULT_CHANNEL 
)
inline

move transferMax bytes of the buffered output to target as input

Transfer bytes from this object to another BufferedTransformation

Parameters
targetthe destination BufferedTransformation
transferMaxthe number of bytes to transfer
channelthe channel on which the transfer should occur
Returns
the number of bytes transferred during the call.

TransferTo removes bytes from this object and moves them to the destination.

The function always returns transferMax. If an accurate count is needed, then use TransferTo2.

Definition at line 1656 of file cryptlib.h.

lword BufferedTransformation::Skip ( lword  skipMax = LWORD_MAX)
virtual

Discard skipMax bytes from the output buffer.

Parameters
skipMaxthe number of bytes to discard

Skip always returns skipMax.

Reimplemented in FileStore.

Definition at line 556 of file cryptlib.cpp.

lword BufferedTransformation::CopyTo ( BufferedTransformation target,
lword  copyMax = LWORD_MAX,
const std::string &  channel = DEFAULT_CHANNEL 
) const
inline

copy copyMax bytes of the buffered output to target as input

Copy bytes from this object to another BufferedTransformation

Parameters
targetthe destination BufferedTransformation
copyMaxthe number of bytes to copy
channelthe channel on which the transfer should occur
Returns
the number of bytes copied during the call.

CopyTo copies bytes from this object to the destination. The bytes are not removed from this object.

The function always returns copyMax. If an accurate count is needed, then use CopyRangeTo2.

Definition at line 1673 of file cryptlib.h.

lword BufferedTransformation::CopyRangeTo ( BufferedTransformation target,
lword  position,
lword  copyMax = LWORD_MAX,
const std::string &  channel = DEFAULT_CHANNEL 
) const
inline

Copy bytes from this object using an index to another BufferedTransformation.

Parameters
targetthe destination BufferedTransformation
positionthe 0-based index of the byte stream to begin the copying
copyMaxthe number of bytes to copy
channelthe channel on which the transfer should occur
Returns
the number of bytes copied during the call.

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

The function returns the new position in the stream after transferring the bytes starting at the index.

Definition at line 1686 of file cryptlib.h.

lword BufferedTransformation::TotalBytesRetrievable ( ) const
virtual

Provides the number of bytes ready for retrieval.

Returns
the number of bytes ready for retrieval

Reimplemented in MessageQueue.

Definition at line 564 of file cryptlib.cpp.

unsigned int BufferedTransformation::NumberOfMessages ( ) const
virtual

Provides the number of meesages processed by this object.

Returns
the number of meesages processed by this object

NumberOfMessages returns number of times MessageEnd() has been received minus messages retrieved or skipped

Reimplemented in Store, and MessageQueue.

Definition at line 572 of file cryptlib.cpp.

bool BufferedTransformation::AnyMessages ( ) const
virtual

Determines if any messages are available for retrieval.

Returns
true if NumberOfMessages() > 0, false otherwise

AnyMessages returns true if NumberOfMessages() > 0

Definition at line 580 of file cryptlib.cpp.

bool BufferedTransformation::GetNextMessage ( )
virtual

Start retrieving the next message.

Returns
true if a message is ready for retrieval

GetNextMessage() returns true if a message is ready for retrieval; false if no more messages exist or this message is not completely retrieved.

Reimplemented in Store, and MessageQueue.

Definition at line 588 of file cryptlib.cpp.

unsigned int BufferedTransformation::SkipMessages ( unsigned int  count = UINT_MAX)
virtual

Skip a number of meessages.

Returns
0 if the requested number of messages was skipped, non-0 otherwise

SkipMessages() skips count number of messages. If there is an AttachedTransformation() then SkipMessages() is called on the attached transformation. If there is no attached transformation, then count number of messages are sent to TheBitBucket() using TransferMessagesTo().

Definition at line 599 of file cryptlib.cpp.

unsigned int BufferedTransformation::TransferMessagesTo ( BufferedTransformation target,
unsigned int  count = UINT_MAX,
const std::string &  channel = DEFAULT_CHANNEL 
)
inline

Transfer messages from this object to another BufferedTransformation.

Parameters
targetthe destination BufferedTransformation
countthe number of messages to transfer
channelthe channel on which the transfer should occur
Returns
the number of bytes that remain in the current transfer block (i.e., bytes not transferred)

TransferMessagesTo2() removes messages from this object and moves them to the destination. If all bytes are not transferred for a message, then processing stops and the number of remaining bytes is returned. TransferMessagesTo() does not proceed to the next message.

A return value of 0 indicates all messages were successfully transferred.

Definition at line 1734 of file cryptlib.h.

unsigned int BufferedTransformation::CopyMessagesTo ( BufferedTransformation target,
unsigned int  count = UINT_MAX,
const std::string &  channel = DEFAULT_CHANNEL 
) const

Copy messages from this object to another BufferedTransformation.

Parameters
targetthe destination BufferedTransformation
countthe number of messages to transfer
channelthe channel on which the transfer should occur
Returns
the number of bytes that remain in the current transfer block (i.e., bytes not transferred)

CopyMessagesTo copies messages from this object and copies them to the destination. If all bytes are not transferred for a message, then processing stops and the number of remaining bytes is returned. CopyMessagesTo() does not proceed to the next message.

A return value of 0 indicates all messages were successfully copied.

Definition at line 637 of file cryptlib.cpp.

void BufferedTransformation::TransferAllTo ( BufferedTransformation target,
const std::string &  channel = DEFAULT_CHANNEL 
)
inline

Transfer all bytes from this object to another BufferedTransformation.

Parameters
targetthe destination BufferedTransformation
channelthe channel on which the transfer should occur
Returns
the number of bytes that remain in the current transfer block (i.e., bytes not transferred)

TransferMessagesTo2() removes messages from this object and moves them to the destination. Internally TransferAllTo() calls TransferAllTo2().

Definition at line 1757 of file cryptlib.h.

void BufferedTransformation::CopyAllTo ( BufferedTransformation target,
const std::string &  channel = DEFAULT_CHANNEL 
) const

Copy messages from this object to another BufferedTransformation.

Parameters
targetthe destination BufferedTransformation
channelthe channel on which the transfer should occur

CopyAllTo copies messages from this object and copies them to the destination.

Definition at line 688 of file cryptlib.cpp.

virtual bool BufferedTransformation::GetNextMessageSeries ( )
inlinevirtual

Retrieve the next message in a series.

Returns
true if a message was retreved, false otherwise

Internally, the base class implementation returns false.

Definition at line 1769 of file cryptlib.h.

virtual unsigned int BufferedTransformation::NumberOfMessagesInThisSeries ( ) const
inlinevirtual

Provides the number of messages in a series.

Returns
the number of messages in this series

Reimplemented in MessageQueue.

Definition at line 1772 of file cryptlib.h.

virtual unsigned int BufferedTransformation::NumberOfMessageSeries ( ) const
inlinevirtual

Provides the number of messages in a series.

Returns
the number of messages in this series

Reimplemented in MessageQueue.

Definition at line 1775 of file cryptlib.h.

virtual size_t BufferedTransformation::TransferTo2 ( BufferedTransformation target,
lword &  byteCount,
const std::string &  channel = DEFAULT_CHANNEL,
bool  blocking = true 
)
pure 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)

TransferTo() 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.

Implemented in NullStore, RandomNumberStore, StringStore, Sink, BERGeneralDecoder, ByteQueue::Walker, Filter, ByteQueue, MessageQueue, and FileStore.

virtual size_t BufferedTransformation::CopyRangeTo2 ( BufferedTransformation target,
lword &  begin,
lword  end = LWORD_MAX,
const std::string &  channel = DEFAULT_CHANNEL,
bool  blocking = true 
) const
pure 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 tahn end). begin can be used for subsequent calls to CopyRangeTo2.

Implemented in NullStore, RandomNumberStore, StringStore, Sink, BERGeneralDecoder, ByteQueue::Walker, Filter, ByteQueue, MessageQueue, and FileStore.

size_t BufferedTransformation::TransferMessagesTo2 ( BufferedTransformation target,
unsigned int &  messageCount,
const std::string &  channel = DEFAULT_CHANNEL,
bool  blocking = true 
)

Transfer messages from this object to another BufferedTransformation.

Parameters
targetthe destination BufferedTransformation
messageCountthe number of messages 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 current transfer block (i.e., bytes not transferred)

TransferMessagesTo2() removes messages from this object and moves them to the destination.

messageCount is an IN and OUT parameter. When the call is made, messageCount is the the number of messages requested to be transferred. When the call returns, messageCount is the number of messages actually transferred.

Definition at line 607 of file cryptlib.cpp.

size_t BufferedTransformation::TransferAllTo2 ( BufferedTransformation target,
const std::string &  channel = DEFAULT_CHANNEL,
bool  blocking = true 
)

Transfer all bytes from this object to another BufferedTransformation.

Parameters
targetthe destination BufferedTransformation
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 current transfer block (i.e., bytes not transferred)

TransferMessagesTo2() removes messages from this object and moves them to the destination.

Definition at line 656 of file cryptlib.cpp.

size_t BufferedTransformation::ChannelPut ( const std::string &  channel,
byte  inByte,
bool  blocking = true 
)
inline

Input a byte for processing on a channel.

Parameters
channelthe channel to process the data.
inBytethe 8-bit byte (octet) to be processed.
blockingspecifies whether the object should block when processing input.
Returns
0 indicates all bytes were processed during the call. Non-0 indicates the number of bytes that were not processed.

Definition at line 1858 of file cryptlib.h.

size_t BufferedTransformation::ChannelPut ( const std::string &  channel,
const byte *  inString,
size_t  length,
bool  blocking = true 
)
inline

Input a byte buffer for processing on a channel.

Parameters
channelthe channel to process the data
inStringthe byte buffer to process
lengththe size of the string, in bytes
blockingspecifies whether the object should block when processing input
Returns
0 indicates all bytes were processed during the call. Non-0 indicates the number of bytes that were not processed.

Definition at line 1868 of file cryptlib.h.

size_t BufferedTransformation::ChannelPutModifiable ( const std::string &  channel,
byte *  inString,
size_t  length,
bool  blocking = true 
)
inline

Input multiple bytes that may be modified by callee on a channel.

Parameters
channelthe channel to process the data.
inStringthe byte buffer to process
lengththe size of the string, in bytes
blockingspecifies whether the object should block when processing input
Returns
0 indicates all bytes were processed during the call. Non-0 indicates the number of bytes that were not processed.

Definition at line 1878 of file cryptlib.h.

size_t BufferedTransformation::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.

Parameters
channelthe channel to process the data.
valuethe 16-bit value to be processed.
orderthe ByteOrder in which the word should be processed.
blockingspecifies whether the object should block when processing input.
Returns
0 indicates all bytes were processed during the call. Non-0 indicates the number of bytes that were not processed.

Definition at line 705 of file cryptlib.cpp.

size_t BufferedTransformation::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.

Parameters
channelthe channel to process the data.
valuethe 32-bit value to be processed.
orderthe ByteOrder in which the word should be processed.
blockingspecifies whether the object should block when processing input.
Returns
0 indicates all bytes were processed during the call. Non-0 indicates the number of bytes that were not processed.

Definition at line 711 of file cryptlib.cpp.

bool BufferedTransformation::ChannelMessageEnd ( const std::string &  channel,
int  propagation = -1,
bool  blocking = true 
)
inline

Signal the end of a message.

Parameters
channelthe channel to process the data.
propagationthe number of attached transformations the ChannelMessageEnd() signal should be passed
blockingspecifies whether the object should block when processing input
Returns
0 indicates all bytes were processed during the call. Non-0 indicates the number of bytes that were not processed.

propagation count includes this object. Setting propagation to 1 means this object only. Setting propagation to -1 means unlimited propagation.

Definition at line 1907 of file cryptlib.h.

size_t BufferedTransformation::ChannelPutMessageEnd ( const std::string &  channel,
const byte *  inString,
size_t  length,
int  propagation = -1,
bool  blocking = true 
)
inline

Input multiple bytes for processing and signal the end of a message.

Parameters
channelthe channel to process the data.
inStringthe byte buffer to process
lengththe size of the string, in bytes
propagationthe number of attached transformations the ChannelPutMessageEnd() signal should be passed
blockingspecifies whether the object should block when processing input
Returns
the number of bytes that remain in the block (i.e., bytes not processed)

propagation count includes this object. Setting propagation to 1 means this object only. Setting propagation to -1 means unlimited propagation.

Definition at line 1919 of file cryptlib.h.

byte * BufferedTransformation::ChannelCreatePutSpace ( const std::string &  channel,
size_t &  size 
)
virtual

Request space which can be written into by the caller.

Parameters
channelthe channel to process the data
sizethe requested size of the buffer
Returns
a pointer to a memroy block with length size

The purpose of this method is to help avoid extra memory allocations.

size is an IN and OUT parameter and used as a hint. When the call is made, size is the requested size of the buffer. When the call returns, size is the size of the array returned to the caller.

The base class implementation sets size to 0 and returns NULL.

Note
Some objects, like ArraySink(), cannot create a space because its fixed. In the case of an ArraySink(), the pointer to the array is returned and the size is remaining size.

Reimplemented in OutputProxy, Redirector, AuthenticatedDecryptionFilter, AuthenticatedEncryptionFilter, and ChannelSwitch.

Definition at line 459 of file cryptlib.cpp.

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

Input multiple bytes for processing on a channel.

Parameters
channelthe channel to process the data.
inStringthe byte buffer to process.
lengththe size of the string, in bytes.
messageEndmeans how many filters to signal MessageEnd() to, including this one.
blockingspecifies 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 OutputProxy, Redirector, AuthenticatedDecryptionFilter, AuthenticatedEncryptionFilter, ChannelSwitch, EqualityComparisonFilter, and RawIDA.

Definition at line 467 of file cryptlib.cpp.

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

Input multiple bytes that may be modified by callee on a channel.

Parameters
channelthe channel to process the data
inStringthe byte buffer to process
lengththe size of the string, in bytes
messageEndmeans how many filters to signal MessageEnd() to, including this one
blockingspecifies 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 OutputProxy, Redirector, and ChannelSwitch.

Definition at line 475 of file cryptlib.cpp.

bool BufferedTransformation::ChannelFlush ( const std::string &  channel,
bool  hardFlush,
int  propagation = -1,
bool  blocking = true 
)
virtual

Flush buffered input and/or output on a channel.

Parameters
channelthe channel to flush the data
hardFlushis used to indicate whether all data should be flushed
propagationthe number of attached transformations the ChannelFlush() signal should be passed
blockingspecifies whether the object should block when processing input
Returns
true of the Flush was successful

propagation count includes this object. Setting propagation to 1 means this object only. Setting propagation to -1 means unlimited propagation.

Reimplemented in OutputProxy, Redirector, and ChannelSwitch.

Definition at line 483 of file cryptlib.cpp.

bool BufferedTransformation::ChannelMessageSeriesEnd ( const std::string &  channel,
int  propagation = -1,
bool  blocking = true 
)
virtual

Marks the end of a series of messages on a channel.

Parameters
channelthe channel to signal the end of a series of messages
propagationthe number of attached transformations the ChannelMessageSeriesEnd() signal should be passed
blockingspecifies whether the object should block when processing input

Each object that receives the signal will perform its processing, decrement propagation, and then pass the signal on to attached transformations if the value is not 0.

propagation count includes this object. Setting propagation to 1 means this object only. Setting propagation to -1 means unlimited propagation.

Note
There should be a MessageEnd() immediately before MessageSeriesEnd().

Reimplemented in OutputProxy, Redirector, ChannelSwitch, and EqualityComparisonFilter.

Definition at line 491 of file cryptlib.cpp.

void BufferedTransformation::SetRetrievalChannel ( const std::string &  channel)
virtual

Sets the default retrieval channel.

Parameters
channelthe channel to signal the end of a series of messages
Note
this function may not be implemented in all objects that should support it.

Definition at line 699 of file cryptlib.cpp.

virtual bool BufferedTransformation::Attachable ( )
inlinevirtual

Determines whether the object allows attachment.

Returns
true if the object allows an attachment, false otherwise

Sources and Filters will return true, while Sinks and other objects will return false.

Reimplemented in Filter.

Definition at line 1989 of file cryptlib.h.

virtual BufferedTransformation* BufferedTransformation::AttachedTransformation ( )
inlinevirtual

Returns the object immediately attached to this object.

Returns
the attached transformation

AttachedTransformation() returns NULL if there is no attachment. The non-const version of AttachedTransformation() always returns NULL.

Reimplemented in Filter.

Definition at line 1995 of file cryptlib.h.

virtual const BufferedTransformation* BufferedTransformation::AttachedTransformation ( ) const
inlinevirtual

Returns the object immediately attached to this object.

Returns
the attached transformation

AttachedTransformation() returns NULL if there is no attachment. The non-const version of AttachedTransformation() always returns NULL.

Reimplemented in Filter.

Definition at line 2001 of file cryptlib.h.

virtual void BufferedTransformation::Detach ( BufferedTransformation newAttachment = 0)
inlinevirtual

Delete the current attachment chain and attach a new one.

Parameters
newAttachmentthe new BufferedTransformation to attach
Exceptions
NotImplemented

Detach delete the current attachment chain and replace it with an optional newAttachment

If a derived class does not override Detach, then the base class throws NotImplemented.

Reimplemented in Filter.

Definition at line 2010 of file cryptlib.h.

void BufferedTransformation::Attach ( BufferedTransformation newAttachment)
virtual

Add newAttachment to the end of attachment chain.

Parameters
newAttachmentthe attachment to add to the end of the chain

Definition at line 763 of file cryptlib.cpp.


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