Crypto++
8.3
Free C++ class library of cryptographic schemes
|
Implementation of BufferedTransformation's attachment interface. More...
Public Member Functions | |
ATTACHMENT | |
Filter (BufferedTransformation *attachment=NULL) | |
Construct a Filter. More... | |
bool | Attachable () |
Determine if attachable. More... | |
BufferedTransformation * | AttachedTransformation () |
Retrieve attached transformation. More... | |
const BufferedTransformation * | AttachedTransformation () const |
Retrieve attached transformation. More... | |
void | Detach (BufferedTransformation *newAttachment=NULL) |
Replace an attached transformation. More... | |
RETRIEVAL OF ONE MESSAGE | |
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... | |
![]() | |
BufferedTransformation () | |
Construct a BufferedTransformation. | |
BufferedTransformation & | Ref () |
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 | PutWord64 (word64 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true) |
Input a 64-bit word for processing. More... | |
virtual byte * | CreatePutSpace (size_t &size) |
Request space which can be written into by the caller. More... | |
virtual bool | CanModifyInput () const |
Determines whether input can be modified by the callee. More... | |
size_t | PutModifiable (byte *inString, size_t length, bool blocking=true) |
Input multiple bytes that may be modified by callee. More... | |
bool | MessageEnd (int propagation=-1, bool blocking=true) |
Signals the end of messages to the object. More... | |
size_t | PutMessageEnd (const byte *inString, size_t length, int propagation=-1, bool blocking=true) |
Input multiple bytes for processing and signal the end of a message. More... | |
virtual size_t | 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... | |
unsigned int | GetMaxWaitObjectCount () const |
Retrieves the maximum number of waitable objects. | |
void | GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack) |
Retrieves waitable objects. More... | |
virtual void | IsolatedInitialize (const NameValuePairs ¶meters) |
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 | 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 | GetWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER) |
Retrieve a 64-bit word. More... | |
size_t | PeekWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) const |
Peek a 16-bit word. More... | |
size_t | PeekWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) const |
Peek a 32-bit word. More... | |
size_t | PeekWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER) const |
Peek a 64-bit word. More... | |
lword | TransferTo (BufferedTransformation &target, lword transferMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) |
move transferMax bytes of the buffered output to target as input More... | |
virtual lword | Skip (lword skipMax=LWORD_MAX) |
Discard skipMax bytes from the output buffer. More... | |
lword | CopyTo (BufferedTransformation &target, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const |
Copy bytes from this object to another BufferedTransformation. More... | |
lword | CopyRangeTo (BufferedTransformation &target, lword position, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const |
Copy bytes from this object using an index to another BufferedTransformation. More... | |
virtual lword | TotalBytesRetrievable () const |
Provides the number of bytes ready for retrieval. More... | |
virtual unsigned int | NumberOfMessages () const |
Provides the number of meesages processed by this object. More... | |
virtual bool | AnyMessages () const |
Determines if any messages are available for retrieval. More... | |
virtual bool | GetNextMessage () |
Start retrieving the next message. More... | |
virtual unsigned int | SkipMessages (unsigned int count=UINT_MAX) |
Skip a number of meessages. More... | |
unsigned int | TransferMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL) |
Transfer messages from this object to another BufferedTransformation. More... | |
unsigned int | CopyMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL) const |
Copy messages from this object to another BufferedTransformation. More... | |
virtual void | SkipAll () |
Skip all messages in the series. | |
void | TransferAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL) |
Transfer all bytes from this object to another BufferedTransformation. More... | |
void | CopyAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL) const |
Copy messages from this object to another BufferedTransformation. More... | |
virtual bool | GetNextMessageSeries () |
Retrieve the next message in a series. More... | |
virtual unsigned int | NumberOfMessagesInThisSeries () const |
Provides the number of messages in a series. More... | |
virtual unsigned int | NumberOfMessageSeries () const |
Provides the number of messages in a series. More... | |
size_t | TransferMessagesTo2 (BufferedTransformation &target, unsigned int &messageCount, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) |
Transfer messages from this object to another BufferedTransformation. More... | |
size_t | TransferAllTo2 (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true) |
Transfer all bytes from this object to another BufferedTransformation. More... | |
size_t | ChannelPut (const std::string &channel, byte inByte, bool blocking=true) |
Input a byte for processing on a channel. More... | |
size_t | ChannelPut (const std::string &channel, const byte *inString, size_t length, bool blocking=true) |
Input a byte buffer for processing on a channel. More... | |
size_t | ChannelPutModifiable (const std::string &channel, byte *inString, size_t length, bool blocking=true) |
Input multiple bytes that may be modified by callee on a channel. More... | |
size_t | ChannelPutWord16 (const std::string &channel, word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true) |
Input a 16-bit word for processing on a channel. More... | |
size_t | ChannelPutWord32 (const std::string &channel, word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true) |
Input a 32-bit word for processing on a channel. More... | |
size_t | ChannelPutWord64 (const std::string &channel, word64 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true) |
Input a 64-bit word for processing on a channel. More... | |
bool | ChannelMessageEnd (const std::string &channel, int propagation=-1, bool blocking=true) |
Signal the end of a message. More... | |
size_t | ChannelPutMessageEnd (const std::string &channel, const byte *inString, size_t length, int propagation=-1, bool blocking=true) |
Input multiple bytes for processing and signal the end of a message. More... | |
virtual byte * | ChannelCreatePutSpace (const std::string &channel, size_t &size) |
Request space which can be written into by the caller. More... | |
virtual size_t | 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... | |
virtual void | Attach (BufferedTransformation *newAttachment) |
Add newAttachment to the end of attachment chain. More... | |
![]() | |
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... | |
![]() | |
virtual Clonable * | Clone () const |
Copies this object. More... | |
![]() | |
bool | Wait (unsigned long milliseconds, CallStack const &callStack) |
Wait on this object. More... | |
SIGNALS | |
void | Initialize (const NameValuePairs ¶meters=g_nullNameValuePairs, int propagation=-1) |
Initialize or reinitialize this object, with signal propagation. More... | |
bool | Flush (bool hardFlush, int propagation=-1, bool blocking=true) |
Flush buffered input and/or output, with signal propagation. More... | |
bool | MessageSeriesEnd (int propagation=-1, bool blocking=true) |
Marks the end of a series of messages, with signal propagation. More... | |
Implementation of BufferedTransformation's attachment interface.
Filter is a cornerstone of the Pipeline trinitiy. Data flows from Sources, through Filters, and then terminates in Sinks. The difference between a Source and Filter is a Source pumps data, while a Filter does not. The difference between a Filter and a Sink is a Filter allows an attached transformation, while a Sink does not. See the discussion of BufferedTransformation in cryptlib.h for more details.
Filter::Filter | ( | BufferedTransformation * | attachment = NULL | ) |
Construct a Filter.
attachment | an optional attached transformation attachment can be NULL. |
Definition at line 26 of file filters.cpp.
|
inlinevirtual |
|
virtual |
Retrieve attached transformation.
Reimplemented from BufferedTransformation.
Definition at line 36 of file filters.cpp.
|
virtual |
Retrieve attached transformation.
Reimplemented from BufferedTransformation.
Definition at line 43 of file filters.cpp.
|
virtual |
Replace an attached transformation.
newAttachment | an optional attached transformation newAttachment can be a single filter, a chain of filters or NULL. Pass NULL to remove an existing BufferedTransformation or chain of filters |
Reimplemented from BufferedTransformation.
Definition at line 50 of file filters.cpp.
|
virtual |
Transfer bytes from this object to another BufferedTransformation.
target | the destination BufferedTransformation |
byteCount | the number of bytes to transfer |
channel | the channel on which the transfer should occur |
blocking | specifies whether the object should block when processing input |
Implements BufferedTransformation.
Definition at line 66 of file filters.cpp.
|
virtual |
Copy bytes from this object to another BufferedTransformation.
target | the destination BufferedTransformation |
begin | the 0-based index of the first byte to copy in the stream |
end | the 0-based index of the last byte to copy in the stream |
channel | the channel on which the transfer should occur |
blocking | specifies whether the object should block when processing input |
Implements BufferedTransformation.
Definition at line 61 of file filters.cpp.
|
virtual |
Initialize or reinitialize this object, with signal propagation.
parameters | a set of NameValuePairs to initialize or reinitialize this object |
propagation | the 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 constructors 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 from BufferedTransformation.
Definition at line 71 of file filters.cpp.
|
virtual |
Flush buffered input and/or output, with signal propagation.
hardFlush | is used to indicate whether all data should be flushed |
propagation | the number of attached transformations the Flush() signal should be passed |
blocking | specifies whether the object should block when processing input |
1
means this object only. Setting propagation to -1
means unlimited propagation. Reimplemented from BufferedTransformation.
Reimplemented in CustomFlushPropagation< Filter >, Multichannel< Filter >, InformationDispersal, SecretSharing, Unflushable< Filter >, and Unflushable< Multichannel< Filter > >.
Definition at line 78 of file filters.cpp.
|
virtual |
Marks the end of a series of messages, with signal propagation.
propagation | the number of attached transformations the MessageSeriesEnd() signal should be passed |
blocking | specifies whether the object should block when processing input |
1
means this object only. Setting propagation to -1
means unlimited propagation. Reimplemented from BufferedTransformation.
Reimplemented in Multichannel< Filter >.
Definition at line 95 of file filters.cpp.