Crypto++ 8.9
Free C++ class library of cryptographic schemes
Public Member Functions | List of all members
ArrayXorSink Class Reference

Xor input to a memory buffer. More...

#include <filters.h>

+ Inheritance diagram for ArrayXorSink:

Public Member Functions

 ArrayXorSink (byte *buf, size_t size)
 Construct an ArrayXorSink.
 
size_t Put2 (const byte *inString, size_t length, int messageEnd, bool blocking)
 Input multiple bytes for processing.
 
byteCreatePutSpace (size_t &size)
 Request space which can be written into by the caller.
 
- Public Member Functions inherited from ArraySink
 ArraySink (const NameValuePairs &parameters=g_nullNameValuePairs)
 Construct an ArraySink.
 
 ArraySink (byte *buf, size_t size)
 Construct an ArraySink.
 
size_t AvailableSize ()
 Provides the size remaining in the Sink.
 
lword TotalPutLength ()
 Provides the number of bytes written to the Sink.
 
void IsolatedInitialize (const NameValuePairs &parameters)
 Initialize or reinitialize this object, without signal propagation.
 
- Public Member Functions inherited from Bufferless< Sink >
bool IsolatedFlush (bool hardFlush, bool blocking)
 Flushes data buffered by this object, without signal propagation.
 
- 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.
 
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.
 
- Public Member Functions inherited from BufferedTransformation
 BufferedTransformation ()
 Construct a BufferedTransformation.
 
BufferedTransformationRef ()
 Provides a reference to this object.
 
virtual bool Attachable ()
 Determines whether the object allows attachment.
 
virtual BufferedTransformationAttachedTransformation ()
 Returns the object immediately attached to this object.
 
virtual const BufferedTransformationAttachedTransformation () const
 Returns the object immediately attached to this object.
 
virtual void Detach (BufferedTransformation *newAttachment=NULL)
 Delete the current attachment chain and attach a new one.
 
virtual void Attach (BufferedTransformation *newAttachment)
 Add newAttachment to the end of attachment chain.
 
size_t Put (byte inByte, bool blocking=true)
 Input a byte for processing.
 
size_t Put (const byte *inString, size_t length, bool blocking=true)
 Input a byte buffer for processing.
 
size_t PutWord16 (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 16-bit word for processing.
 
size_t PutWord32 (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 32-bit word for processing.
 
size_t PutWord64 (word64 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 Input a 64-bit word for processing.
 
virtual bool CanModifyInput () const
 Determines whether input can be modified by the callee.
 
size_t PutModifiable (byte *inString, size_t length, bool blocking=true)
 Input multiple bytes that may be modified by callee.
 
bool MessageEnd (int propagation=-1, bool blocking=true)
 Signals the end of messages to the object.
 
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.
 
virtual size_t PutModifiable2 (byte *inString, size_t length, int messageEnd, bool blocking)
 Input multiple bytes that may be modified by callee.
 
unsigned int GetMaxWaitObjectCount () const
 Retrieves the maximum number of waitable objects.
 
void GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
 Retrieves waitable objects.
 
virtual bool IsolatedMessageSeriesEnd (bool blocking)
 Marks the end of a series of messages, without signal propagation.
 
virtual void Initialize (const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)
 Initialize or reinitialize this object, with signal propagation.
 
virtual bool Flush (bool hardFlush, int propagation=-1, bool blocking=true)
 Flush buffered input and/or output, with signal propagation.
 
virtual bool MessageSeriesEnd (int propagation=-1, bool blocking=true)
 Marks the end of a series of messages, with signal propagation.
 
virtual void SetAutoSignalPropagation (int propagation)
 Set propagation of automatically generated and transferred signals.
 
virtual int GetAutoSignalPropagation () const
 Retrieve automatic signal propagation value.
 
virtual lword MaxRetrievable () const
 Provides the number of bytes ready for retrieval.
 
virtual bool AnyRetrievable () const
 Determines whether bytes are ready for retrieval.
 
virtual size_t Get (byte &outByte)
 Retrieve a 8-bit byte.
 
virtual size_t Get (byte *outString, size_t getMax)
 Retrieve a block of bytes.
 
virtual size_t Peek (byte &outByte) const
 Peek a 8-bit byte.
 
virtual size_t Peek (byte *outString, size_t peekMax) const
 Peek a block of bytes.
 
size_t GetWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 Retrieve a 16-bit word.
 
size_t GetWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 Retrieve a 32-bit word.
 
size_t GetWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 Retrieve a 64-bit word.
 
size_t PeekWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 Peek a 16-bit word.
 
size_t PeekWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 Peek a 32-bit word.
 
size_t PeekWord64 (word64 &value, ByteOrder order=BIG_ENDIAN_ORDER) const
 Peek a 64-bit word.
 
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
 
virtual lword Skip (lword skipMax=LWORD_MAX)
 Discard skipMax bytes from the output buffer.
 
lword CopyTo (BufferedTransformation &target, lword copyMax=LWORD_MAX, const std::string &channel=DEFAULT_CHANNEL) const
 Copy bytes from this object to another BufferedTransformation.
 
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.
 
virtual lword TotalBytesRetrievable () const
 Provides the number of bytes ready for retrieval.
 
virtual unsigned int NumberOfMessages () const
 Provides the number of meesages processed by this object.
 
virtual bool AnyMessages () const
 Determines if any messages are available for retrieval.
 
virtual bool GetNextMessage ()
 Start retrieving the next message.
 
virtual unsigned int SkipMessages (unsigned int count=UINT_MAX)
 Skip a number of meessages.
 
unsigned int TransferMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=DEFAULT_CHANNEL)
 Transfer messages from this object to another BufferedTransformation.
 
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.
 
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.
 
void CopyAllTo (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL) const
 Copy messages from this object to another BufferedTransformation.
 
virtual bool GetNextMessageSeries ()
 Retrieve the next message in a series.
 
virtual unsigned int NumberOfMessagesInThisSeries () const
 Provides the number of messages in a series.
 
virtual unsigned int NumberOfMessageSeries () const
 Provides the number of messages in a series.
 
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.
 
size_t TransferAllTo2 (BufferedTransformation &target, const std::string &channel=DEFAULT_CHANNEL, bool blocking=true)
 Transfer all bytes from this object to another BufferedTransformation.
 
size_t ChannelPut (const std::string &channel, byte inByte, bool blocking=true)
 Input a byte for processing on a channel.
 
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.
 
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.
 
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.
 
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.
 
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.
 
bool ChannelMessageEnd (const std::string &channel, int propagation=-1, bool blocking=true)
 Signal the end of a message.
 
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.
 
virtual byteChannelCreatePutSpace (const std::string &channel, size_t &size)
 Request space which can be written into by the caller.
 
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.
 
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.
 
virtual bool ChannelFlush (const std::string &channel, bool hardFlush, int propagation=-1, bool blocking=true)
 Flush buffered input and/or output on a channel.
 
virtual bool ChannelMessageSeriesEnd (const std::string &channel, int propagation=-1, bool blocking=true)
 Marks the end of a series of messages on a channel.
 
virtual void SetRetrievalChannel (const std::string &channel)
 Sets the default retrieval channel.
 
- Public Member Functions inherited from Algorithm
 Algorithm (bool checkSelfTestStatus=true)
 Interface for all crypto algorithms.
 
virtual std::string AlgorithmName () const
 Provides the name of this algorithm.
 
virtual std::string AlgorithmProvider () const
 Retrieve the provider of this algorithm.
 
- Public Member Functions inherited from Clonable
virtual ClonableClone () const
 Copies this object.
 
- Public Member Functions inherited from Waitable
bool Wait (unsigned long milliseconds, CallStack const &callStack)
 Wait on this object.
 

Detailed Description

Xor input to a memory buffer.

ArrayXorSink wraps a fixed size buffer. The buffer is full once Put returns non-0. When used in a pipeline, ArrayXorSink silently discards input if the buffer is full. AvailableSize() can be used to determine how much space remains in the buffer. TotalPutLength() can be used to determine how many bytes were processed.

See also
StringSink, ArraySink
Since
Crypto++ 4.0

Definition at line 1241 of file filters.h.

Constructor & Destructor Documentation

◆ ~ArrayXorSink()

virtual ArrayXorSink::~ArrayXorSink ( )
inlinevirtual

Definition at line 1244 of file filters.h.

◆ ArrayXorSink()

ArrayXorSink::ArrayXorSink ( byte * buf,
size_t size )
inline

Construct an ArrayXorSink.

Parameters
bufpointer to a memory buffer
sizelength of the memory buffer

Definition at line 1249 of file filters.h.

Member Function Documentation

◆ Put2()

size_t ArrayXorSink::Put2 ( const byte * inString,
size_t length,
int messageEnd,
bool blocking )
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
Returns
the number of bytes that remain to be processed (i.e., bytes not processed). 0 indicates all bytes were processed.

Derived classes must implement Put2().

Reimplemented from ArraySink.

◆ CreatePutSpace()

byte * ArrayXorSink::CreatePutSpace ( size_t & size)
inlinevirtual

Request space which can be written into by the caller.

Parameters
sizethe requested size of the buffer
Returns
byte pointer to the space to input data

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

Definition at line 1253 of file filters.h.


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