Fabcoin Core  0.16.2
P2P Digital Currency
Public Member Functions | List of all members
SimpleProxyFilter Class Reference

Proxy filter that doesn't modify the underlying filter's input or output. More...

#include <filters.h>

Inheritance diagram for SimpleProxyFilter:
[legend]
Collaboration diagram for SimpleProxyFilter:
[legend]

Public Member Functions

 SimpleProxyFilter (BufferedTransformation *filter, BufferedTransformation *attachment)
 Construct a SimpleProxyFilter. More...
 
void FirstPut (const byte *inString)
 
void LastPut (const byte *inString, size_t length)
 Input the last block of data. More...
 
- Public Member Functions inherited from ProxyFilter
virtual ~ProxyFilter ()
 
 ProxyFilter (BufferedTransformation *filter, size_t firstSize, size_t lastSize, BufferedTransformation *attachment)
 Construct a ProxyFilter. More...
 
bool IsolatedFlush (bool hardFlush, bool blocking)
 Flushes data buffered by this object, without signal propagation. More...
 
void SetFilter (Filter *filter)
 Sets the OutputProxy filter. More...
 
void NextPutMultiple (const byte *s, size_t len)
 
void NextPutModifiable (byte *inString, size_t length)
 
- Public Member Functions inherited from FilterWithBufferedInput
virtual ~FilterWithBufferedInput ()
 
 FilterWithBufferedInput (BufferedTransformation *attachment)
 Construct a FilterWithBufferedInput with an attached transformation. More...
 
 FilterWithBufferedInput (size_t firstSize, size_t blockSize, size_t lastSize, BufferedTransformation *attachment)
 Construct a FilterWithBufferedInput with an attached transformation. More...
 
void IsolatedInitialize (const NameValuePairs &parameters)
 Initialize or reinitialize this object, without signal propagation. More...
 
size_t Put2 (const byte *inString, size_t length, int messageEnd, bool blocking)
 Input multiple bytes for processing. More...
 
size_t PutModifiable2 (byte *inString, size_t length, int messageEnd, bool blocking)
 Input multiple bytes that may be modified by callee. More...
 
void ForceNextPut ()
 Flushes data buffered by this object. More...
 
- Public Member Functions inherited from Filter
virtual ~Filter ()
 
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...
 
void Initialize (const NameValuePairs &parameters=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...
 
 Filter (BufferedTransformation *attachment=NULL)
 Construct a Filter. More...
 
bool Attachable ()
 Determine if attachable. More...
 
BufferedTransformationAttachedTransformation ()
 Retrieve attached transformation. More...
 
const BufferedTransformationAttachedTransformation () const
 Retrieve attached transformation. More...
 
void Detach (BufferedTransformation *newAttachment=NULL)
 Replace an attached transformation. More...
 
- Public Member Functions inherited from BufferedTransformation
virtual ~BufferedTransformation ()
 
 BufferedTransformation ()
 Construct a BufferedTransformation. More...
 
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...
 
virtual byteCreatePutSpace (size_t &size)
 Request space which can be written into by the caller. More...
 
virtual bool CanModifyInput () const
 Determines whether input can be modified by the callee. More...
 
size_t PutModifiable (byte *inString, size_t length, bool blocking=true)
 Input multiple bytes that may be modified by callee. More...
 
bool MessageEnd (int propagation=-1, bool blocking=true)
 Signals the end of messages to the object. More...
 
size_t PutMessageEnd (const byte *inString, size_t length, int propagation=-1, bool blocking=true)
 Input multiple bytes for processing and signal the end of a message. More...
 
unsigned int GetMaxWaitObjectCount () const
 Retrieves the maximum number of waitable objects. More...
 
void GetWaitObjects (WaitObjectContainer &container, CallStack const &callStack)
 Retrieves waitable objects. 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. More...
 
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 byteChannelCreatePutSpace (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...
 
- Public Member Functions inherited from Algorithm
virtual ~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 ~Clonable ()
 
virtual ClonableClone () const
 Copies this object. More...
 
- Public Member Functions inherited from Waitable
virtual ~Waitable ()
 
bool Wait (unsigned long milliseconds, CallStack const &callStack)
 Wait on this object. More...
 
- Public Member Functions inherited from NotCopyable
 NotCopyable ()
 

Additional Inherited Members

- Static Public Attributes inherited from BufferedTransformation
static const std::string & NULL_CHANNEL = DEFAULT_CHANNEL
 
- Protected Member Functions inherited from FilterWithBufferedInput
virtual bool DidFirstPut () const
 
virtual size_t GetFirstPutSize () const
 
virtual size_t GetBlockPutSize () const
 
virtual size_t GetLastPutSize () const
 
virtual void InitializeDerivedAndReturnNewSizes (const NameValuePairs &parameters, size_t &firstSize, size_t &blockSize, size_t &lastSize)
 
virtual void InitializeDerived (const NameValuePairs &parameters)
 
virtual void NextPutSingle (const byte *inString)
 
virtual void FlushDerived ()
 
size_t PutMaybeModifiable (byte *begin, size_t length, int messageEnd, bool blocking, bool modifiable)
 
void NextPutMaybeModifiable (byte *inString, size_t length, bool modifiable)
 
virtual int NextPut (const byte *inString, size_t length)
 
- Protected Member Functions inherited from Filter
virtual BufferedTransformationNewDefaultAttachment () const
 
void Insert (Filter *nextFilter)
 
virtual bool ShouldPropagateMessageEnd () const
 
virtual bool ShouldPropagateMessageSeriesEnd () const
 
void PropagateInitialize (const NameValuePairs &parameters, int propagation)
 
size_t Output (int outputSite, const byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Forward processed data on to attached transformation. More...
 
size_t OutputModifiable (int outputSite, byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Output multiple bytes that may be modified by callee. More...
 
bool OutputMessageEnd (int outputSite, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Signals the end of messages to the object. More...
 
bool OutputFlush (int outputSite, bool hardFlush, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Flush buffered input and/or output, with signal propagation. More...
 
bool OutputMessageSeriesEnd (int outputSite, int propagation, bool blocking, const std::string &channel=DEFAULT_CHANNEL)
 Marks the end of a series of messages, with signal propagation. More...
 
- Static Protected Member Functions inherited from BufferedTransformation
static int DecrementPropagation (int propagation)
 Decrements the propagation count while clamping at 0. More...
 
- Protected Attributes inherited from ProxyFilter
member_ptr< BufferedTransformationm_filter
 
- Protected Attributes inherited from FilterWithBufferedInput
size_t m_firstSize
 
size_t m_blockSize
 
size_t m_lastSize
 
bool m_firstInputDone
 
BlockQueue m_queue
 
- Protected Attributes inherited from Filter
size_t m_inputPosition
 
int m_continueAt
 

Detailed Description

Proxy filter that doesn't modify the underlying filter's input or output.

Definition at line 977 of file filters.h.

Constructor & Destructor Documentation

SimpleProxyFilter::SimpleProxyFilter ( BufferedTransformation filter,
BufferedTransformation attachment 
)
inline

Construct a SimpleProxyFilter.

Parameters
filteran output filter
attachmentan attached transformation

Definition at line 983 of file filters.h.

Member Function Documentation

void SimpleProxyFilter::FirstPut ( const byte inString)
inlinevirtual

Implements FilterWithBufferedInput.

Definition at line 986 of file filters.h.

void SimpleProxyFilter::LastPut ( const byte inString,
size_t  length 
)
inlinevirtual

Input the last block of data.

Parameters
inStringthe input byte buffer
lengththe size of the input buffer, in bytes

LastPut() processes the last block of data and signals attached filters to do the same. LastPut() is always called. The pseudo algorithm for the logic is:

    if totalLength < firstSize then length == totalLength
    else if totalLength <= firstSize+lastSize then length == totalLength-firstSize
    else lastSize <= length < lastSize+blockSize

Implements FilterWithBufferedInput.

Definition at line 999 of file filters.h.


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