Crypto++  5.6.3
Free C++ class library of cryptographic schemes
Public Types | Public Member Functions | List of all members
Redirector Class Reference

Redirect input to another BufferedTransformation without owning it. More...

+ Inheritance diagram for Redirector:

Public Types

enum  Behavior { DATA_ONLY = 0x00, PASS_SIGNALS = 0x01, PASS_WAIT_OBJECTS = 0x02, PASS_EVERYTHING = PASS_SIGNALS | PASS_WAIT_OBJECTS }
 Controls signal propagation behavior. More...
 

Public Member Functions

 Redirector ()
 Construct a Redirector.
 
 Redirector (BufferedTransformation &target, Behavior behavior=PASS_EVERYTHING)
 Construct a Redirector. More...
 
void Redirect (BufferedTransformation &target)
 Redirect input to another BufferedTransformation. More...
 
void StopRedirection ()
 Stop redirecting input.
 
Behavior GetBehavior ()
 
void SetBehavior (Behavior behavior)
 
bool GetPassSignals () const
 
void SetPassSignals (bool pass)
 
bool GetPassWaitObjects () const
 
void SetPassWaitObjects (bool pass)
 
bool CanModifyInput () const
 Determines whether input can be modifed by the callee. More...
 
void Initialize (const NameValuePairs &parameters, int propagation)
 Initialize or reinitialize this object, with signal propagation. More...
 
byte * CreatePutSpace (size_t &size)
 Request space which can be written into by the caller. More...
 
size_t Put2 (const byte *inString, size_t length, int messageEnd, bool blocking)
 Input multiple bytes for processing. 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...
 
byte * ChannelCreatePutSpace (const std::string &channel, size_t &size)
 Request space which can be written into by the caller. More...
 
size_t ChannelPut2 (const std::string &channel, const byte *begin, size_t length, int messageEnd, bool blocking)
 Input multiple bytes for processing on a channel. More...
 
size_t ChannelPutModifiable2 (const std::string &channel, byte *begin, size_t length, int messageEnd, bool blocking)
 Input multiple bytes that may be modified by callee on a channel. More...
 
bool ChannelFlush (const std::string &channel, bool completeFlush, int propagation=-1, bool blocking=true)
 Flush buffered input and/or output on a channel. More...
 
bool ChannelMessageSeriesEnd (const std::string &channel, int propagation=-1, bool blocking=true)
 Marks the end of a series of messages on a channel. More...
 
unsigned int GetMaxWaitObjectCount () const
 Retrieves the maximum number of waitable objects.
 
void GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
 Retrieves waitable objects. More...
 
SIGNALS
- 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. 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...
 
- Public Member Functions inherited from BufferedTransformation
 BufferedTransformation ()
 Construct a BufferedTransformation.
 
BufferedTransformationRef ()
 Provides a reference to this object. More...
 
size_t Put (byte inByte, bool blocking=true)
 Input a byte for processing. More...
 
size_t Put (const byte *inString, size_t length, bool blocking=true)
 Input a byte buffer for processing. More...
 
size_t PutWord16 (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 16-bit word for processing. More...
 
size_t PutWord32 (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 32-bit word for processing. More...
 
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...
 
virtual bool IsolatedMessageSeriesEnd (bool blocking)
 Marks the end of a series of messages, without signal propagation. More...
 
virtual void SetAutoSignalPropagation (int propagation)
 Set propagation of automatically generated and transferred signals. More...
 
virtual int GetAutoSignalPropagation () const
 Retrieve automatic signal propagation value. More...
 
virtual lword MaxRetrievable () const
 Provides the number of bytes ready for retrieval. More...
 
virtual bool AnyRetrievable () const
 Determines whether bytes are ready for retrieval. More...
 
virtual size_t Get (byte &outByte)
 Retrieve a 8-bit byte. More...
 
virtual size_t Get (byte *outString, size_t getMax)
 Retrieve a block of bytes. More...
 
virtual size_t Peek (byte &outByte) const
 Peek a 8-bit byte. More...
 
virtual size_t Peek (byte *outString, size_t peekMax) const
 Peek a block of bytes. More...
 
size_t GetWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 Retrieve a 16-bit word. More...
 
size_t GetWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 Retrieve a 32-bit word. More...
 
size_t PeekWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 Peek a 16-bit word. More...
 
size_t PeekWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 Peek a 32-bit word. More...
 
lword TransferTo (BufferedTransformation &target, lword transferMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL)
 move transferMax bytes of the buffered output to target as input More...
 
virtual lword Skip (lword skipMax=LWORD_MAX)
 Discard skipMax bytes from the output buffer. More...
 
lword CopyTo (BufferedTransformation &target, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
 copy copyMax bytes of the buffered output to target as input More...
 
lword CopyRangeTo (BufferedTransformation &target, lword position, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
 Copy bytes from this object using an index to another BufferedTransformation. More...
 
virtual lword TotalBytesRetrievable () const
 Provides the number of bytes ready for retrieval. More...
 
virtual unsigned int NumberOfMessages () const
 Provides the number of meesages processed by this object. More...
 
virtual bool AnyMessages () const
 Determines if any messages are available for retrieval. More...
 
virtual bool GetNextMessage ()
 Start retrieving the next message. More...
 
virtual unsigned int SkipMessages (unsigned int count=UINT_MAX)
 Skip a number of meessages. More...
 
unsigned int TransferMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL)
 Transfer messages from this object to another BufferedTransformation. More...
 
unsigned int CopyMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL) const
 Copy messages from this object to another BufferedTransformation. More...
 
virtual void SkipAll ()
 Skip all messages in the series.
 
void TransferAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL)
 Transfer all bytes from this object to another BufferedTransformation. More...
 
void CopyAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL) const
 Copy messages from this object to another BufferedTransformation. More...
 
virtual bool GetNextMessageSeries ()
 Retrieve the next message in a series. More...
 
virtual unsigned int NumberOfMessagesInThisSeries () const
 Provides the number of messages in a series. More...
 
virtual unsigned int NumberOfMessageSeries () const
 Provides the number of messages in a series. More...
 
size_t TransferMessagesTo2 (BufferedTransformation &target, unsigned int &messageCount, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
 Transfer messages from this object to another BufferedTransformation. More...
 
size_t TransferAllTo2 (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
 Transfer all bytes from this object to another BufferedTransformation. More...
 
size_t ChannelPut (const std::string &channel, byte inByte, bool blocking=true)
 Input a byte for processing on a channel. More...
 
size_t ChannelPut (const std::string &channel, const byte *inString, size_t length, bool blocking=true)
 Input a byte buffer for processing on a channel. More...
 
size_t ChannelPutModifiable (const std::string &channel, byte *inString, size_t length, bool blocking=true)
 Input multiple bytes that may be modified by callee on a channel. More...
 
size_t ChannelPutWord16 (const std::string &channel, word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 16-bit word for processing on a channel. More...
 
size_t ChannelPutWord32 (const std::string &channel, word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 32-bit word for processing on a channel. More...
 
bool ChannelMessageEnd (const std::string &channel, int propagation=-1, bool blocking=true)
 Signal the end of a message. More...
 
size_t ChannelPutMessageEnd (const std::string &channel, const byte *inString, size_t length, int propagation=-1, bool blocking=true)
 Input multiple bytes for processing and signal the end of a message. More...
 
virtual void SetRetrievalChannel (const std::string &channel)
 Sets the default retrieval channel. 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=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...
 
- 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...
 

Additional Inherited Members

- Static Public Attributes inherited from BufferedTransformation
static const std::string & NULL_CHANNEL = DEFAULT_CHANNEL
 

Detailed Description

Redirect input to another BufferedTransformation without owning it.

Definition at line 755 of file filters.h.

Member Enumeration Documentation

Controls signal propagation behavior.

Enumerator
DATA_ONLY 

Pass data only.

PASS_SIGNALS 

Pass signals.

PASS_WAIT_OBJECTS 

Pass wait events.

PASS_EVERYTHING 

Pass everything.

PASS_EVERYTHING is default

Definition at line 760 of file filters.h.

Constructor & Destructor Documentation

Redirector::Redirector ( BufferedTransformation target,
Behavior  behavior = PASS_EVERYTHING 
)
inline

Construct a Redirector.

Parameters
targetthe destination BufferedTransformation
behaviorflags specifying signal propagation

Definition at line 779 of file filters.h.

Member Function Documentation

void Redirector::Redirect ( BufferedTransformation target)
inline

Redirect input to another BufferedTransformation.

Parameters
targetthe destination BufferedTransformation

Definition at line 784 of file filters.h.

bool Redirector::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 from BufferedTransformation.

Definition at line 795 of file filters.h.

void Redirector::Initialize ( const NameValuePairs parameters,
int  propagation 
)
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.

Implements CustomSignalPropagation< Sink >.

Definition at line 480 of file filters.cpp.

byte* Redirector::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 from BufferedTransformation.

Definition at line 799 of file filters.h.

size_t Redirector::Put2 ( const byte *  inString,
size_t  length,
int  messageEnd,
bool  blocking 
)
inlinevirtual

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

Implements BufferedTransformation.

Definition at line 809 of file filters.h.

bool Redirector::Flush ( bool  hardFlush,
int  propagation = -1,
bool  blocking = true 
)
inlinevirtual

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.

Implements CustomFlushPropagation< Sink >.

Definition at line 811 of file filters.h.

bool Redirector::MessageSeriesEnd ( int  propagation = -1,
bool  blocking = true 
)
inlinevirtual

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

Definition at line 813 of file filters.h.

byte* Redirector::ChannelCreatePutSpace ( const std::string &  channel,
size_t &  size 
)
inlinevirtual

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

Definition at line 816 of file filters.h.

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

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

Definition at line 826 of file filters.h.

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

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

Definition at line 828 of file filters.h.

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

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

Definition at line 830 of file filters.h.

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

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

Definition at line 832 of file filters.h.

void Redirector::GetWaitObjects ( WaitObjectContainer container,
CallStack const &  callStack 
)
inlinevirtual

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

Reimplemented from BufferedTransformation.

Definition at line 837 of file filters.h.


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