Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

OpaqueFilter Class Reference

#include <filters.h>

Inheritance diagram for OpaqueFilter:

MeterFilter Bufferless< Filter > Filter BufferedTransformation NotCopyable Algorithm Waitable Clonable List of all members.

Detailed Description

_

Definition at line 120 of file filters.h.

Public Member Functions

 OpaqueFilter (BufferedTransformation *attachment=NULL)
void SetTransparent (bool transparent)
void ResetMeter ()
unsigned long GetCurrentMessageBytes () const
unsigned long GetTotalBytes ()
unsigned int GetCurrentSeriesMessages ()
unsigned int GetTotalMessages ()
unsigned int GetTotalMessageSeries ()
byte * CreatePutSpace (unsigned int &size)
 request space which can be written into by the caller, and then used as input to Put()
unsigned int Put2 (const byte *begin, unsigned int length, int messageEnd, bool blocking)
 input multiple bytes for blocking or non-blocking processing
unsigned int PutModifiable2 (byte *inString, unsigned int length, int messageEnd, bool blocking)
 input multiple bytes that may be modified by callee for blocking or non-blocking processing
bool IsolatedMessageSeriesEnd (bool blocking)
bool IsolatedFlush (bool hardFlush, bool blocking)
bool Attachable ()
 returns whether this object allows attachment
BufferedTransformationAttachedTransformation ()
 returns the object immediately attached to this object or NULL for no attachment
const BufferedTransformationAttachedTransformation () const
void Detach (BufferedTransformation *newAttachment=NULL)
 delete the current attachment chain and replace it with newAttachment
unsigned int TransferTo2 (BufferedTransformation &target, unsigned long &transferBytes, const std::string &channel=NULL_CHANNEL, bool blocking=true)
unsigned int CopyRangeTo2 (BufferedTransformation &target, unsigned long &begin, unsigned long end=ULONG_MAX, const std::string &channel=NULL_CHANNEL, bool blocking=true) const
void Initialize (const NameValuePairs &parameters=g_nullNameValuePairs, int propagation=-1)
 initialize or reinitialize this object
bool Flush (bool hardFlush, int propagation=-1, bool blocking=true)
 flush buffered input and/or output
bool MessageSeriesEnd (int propagation=-1, bool blocking=true)
 mark end of a series of messages
BufferedTransformationRef ()
 return a reference to this object
virtual std::string AlgorithmName () const
 returns name of this algorithm, not universally implemented yet
virtual ClonableClone () const
 this is not implemented by most classes yet
bool Wait (unsigned long milliseconds)
 wait on this object
INPUT
unsigned int Put (byte inByte, bool blocking=true)
 input a byte for processing
unsigned int Put (const byte *inString, unsigned int length, bool blocking=true)
 input multiple bytes
unsigned int PutWord16 (word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 input a 16-bit word
unsigned int PutWord32 (word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
 input a 32-bit word
virtual bool CanModifyInput () const
unsigned int PutModifiable (byte *inString, unsigned int length, bool blocking=true)
 input multiple bytes that may be modified by callee
bool MessageEnd (int propagation=-1, bool blocking=true)
unsigned int PutMessageEnd (const byte *inString, unsigned int length, int propagation=-1, bool blocking=true)
WAITING
unsigned int GetMaxWaitObjectCount () const
 maximum number of wait objects that this object can return
void GetWaitObjects (WaitObjectContainer &container)
 put wait objects into container
SIGNALS
virtual void IsolatedInitialize (const NameValuePairs &parameters)
virtual void SetAutoSignalPropagation (int propagation)
 set propagation of automatically generated and transferred signals
virtual int GetAutoSignalPropagation () const
RETRIEVAL OF ONE MESSAGE
virtual unsigned long MaxRetrievable () const
 returns number of bytes that is currently ready for retrieval
virtual bool AnyRetrievable () const
 returns whether any bytes are currently ready for retrieval
virtual unsigned int Get (byte &outByte)
 try to retrieve a single byte
virtual unsigned int Get (byte *outString, unsigned int getMax)
 try to retrieve multiple bytes
virtual unsigned int Peek (byte &outByte) const
 peek at the next byte without removing it from the output buffer
virtual unsigned int Peek (byte *outString, unsigned int peekMax) const
 peek at multiple bytes without removing them from the output buffer
unsigned int GetWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 try to retrieve a 16-bit word
unsigned int GetWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 try to retrieve a 32-bit word
unsigned int PeekWord16 (word16 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 try to peek at a 16-bit word
unsigned int PeekWord32 (word32 &value, ByteOrder order=BIG_ENDIAN_ORDER)
 try to peek at a 32-bit word
unsigned long TransferTo (BufferedTransformation &target, unsigned long transferMax=ULONG_MAX, const std::string &channel=NULL_CHANNEL)
 move transferMax bytes of the buffered output to target as input
virtual unsigned long Skip (unsigned long skipMax=ULONG_MAX)
 discard skipMax bytes from the output buffer
unsigned long CopyTo (BufferedTransformation &target, unsigned long copyMax=ULONG_MAX, const std::string &channel=NULL_CHANNEL) const
 copy copyMax bytes of the buffered output to target as input
unsigned long CopyRangeTo (BufferedTransformation &target, unsigned long position, unsigned long copyMax=ULONG_MAX, const std::string &channel=NULL_CHANNEL) const
 copy copyMax bytes of the buffered output, starting at position (relative to current position), to target as input
RETRIEVAL OF MULTIPLE MESSAGES
virtual unsigned long TotalBytesRetrievable () const
virtual unsigned int NumberOfMessages () const
 number of times MessageEnd() has been received minus messages retrieved or skipped
virtual bool AnyMessages () const
 returns true if NumberOfMessages() > 0
virtual bool GetNextMessage ()
 start retrieving the next message
virtual unsigned int SkipMessages (unsigned int count=UINT_MAX)
 skip count number of messages
unsigned int TransferMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=NULL_CHANNEL)
unsigned int CopyMessagesTo (BufferedTransformation &target, unsigned int count=UINT_MAX, const std::string &channel=NULL_CHANNEL) const
virtual void SkipAll ()
void TransferAllTo (BufferedTransformation &target, const std::string &channel=NULL_CHANNEL)
void CopyAllTo (BufferedTransformation &target, const std::string &channel=NULL_CHANNEL) const
virtual bool GetNextMessageSeries ()
virtual unsigned int NumberOfMessagesInThisSeries () const
virtual unsigned int NumberOfMessageSeries () const
NON-BLOCKING TRANSFER OF OUTPUT
unsigned int TransferMessagesTo2 (BufferedTransformation &target, unsigned int &messageCount, const std::string &channel=NULL_CHANNEL, bool blocking=true)
unsigned int TransferAllTo2 (BufferedTransformation &target, const std::string &channel=NULL_CHANNEL, bool blocking=true)
CHANNELS
unsigned int ChannelPut (const std::string &channel, byte inByte, bool blocking=true)
unsigned int ChannelPut (const std::string &channel, const byte *inString, unsigned int length, bool blocking=true)
unsigned int ChannelPutModifiable (const std::string &channel, byte *inString, unsigned int length, bool blocking=true)
unsigned int ChannelPutWord16 (const std::string &channel, word16 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
unsigned int ChannelPutWord32 (const std::string &channel, word32 value, ByteOrder order=BIG_ENDIAN_ORDER, bool blocking=true)
bool ChannelMessageEnd (const std::string &channel, int propagation=-1, bool blocking=true)
unsigned int ChannelPutMessageEnd (const std::string &channel, const byte *inString, unsigned int length, int propagation=-1, bool blocking=true)
virtual byte * ChannelCreatePutSpace (const std::string &channel, unsigned int &size)
virtual unsigned int ChannelPut2 (const std::string &channel, const byte *begin, unsigned int length, int messageEnd, bool blocking)
virtual unsigned int ChannelPutModifiable2 (const std::string &channel, byte *begin, unsigned int length, int messageEnd, bool blocking)
virtual bool ChannelFlush (const std::string &channel, bool hardFlush, int propagation=-1, bool blocking=true)
virtual bool ChannelMessageSeriesEnd (const std::string &channel, int propagation=-1, bool blocking=true)
virtual void SetRetrievalChannel (const std::string &channel)
ATTACHMENT
virtual void Attach (BufferedTransformation *newAttachment)
 add newAttachment to the end of attachment chain

Static Public Attributes

static const std::string NULL_CHANNEL

Protected Member Functions

virtual BufferedTransformationNewDefaultAttachment () const
void Insert (Filter *nextFilter)
void PropagateInitialize (const NameValuePairs &parameters, int propagation)
unsigned int Output (int outputSite, const byte *inString, unsigned int length, int messageEnd, bool blocking, const std::string &channel=NULL_CHANNEL)
unsigned int OutputModifiable (int outputSite, byte *inString, unsigned int length, int messageEnd, bool blocking, const std::string &channel=NULL_CHANNEL)
bool OutputMessageEnd (int outputSite, int propagation, bool blocking, const std::string &channel=NULL_CHANNEL)
bool OutputFlush (int outputSite, bool hardFlush, int propagation, bool blocking, const std::string &channel=NULL_CHANNEL)
bool OutputMessageSeriesEnd (int outputSite, int propagation, bool blocking, const std::string &channel=NULL_CHANNEL)

Static Protected Member Functions

static int DecrementPropagation (int propagation)

Protected Attributes

unsigned int m_inputPosition
int m_continueAt


Member Function Documentation

byte* MeterFilter::CreatePutSpace unsigned int &  size  )  [inline, virtual, inherited]
 

request space which can be written into by the caller, and then used as input to Put()

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

Reimplemented from BufferedTransformation.

Definition at line 97 of file filters.h.

unsigned int MeterFilter::Put2 const byte *  begin,
unsigned int  length,
int  messageEnd,
bool  blocking
[virtual, inherited]
 

input multiple bytes for blocking or non-blocking processing

Parameters:
messageEnd means how many filters to signal MessageEnd to, including this one

Implements BufferedTransformation.

Definition at line 144 of file filters.cpp.

unsigned int MeterFilter::PutModifiable2 byte *  begin,
unsigned int  length,
int  messageEnd,
bool  blocking
[virtual, inherited]
 

input multiple bytes that may be modified by callee for blocking or non-blocking processing

Parameters:
messageEnd means how many filters to signal MessageEnd to, including this one

Reimplemented from BufferedTransformation.

Definition at line 165 of file filters.cpp.

bool Filter::Attachable  )  [inline, virtual, inherited]
 

returns whether this object allows 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, sents that output to the attached object as input. The entire attachment chain is deleted when the anchor object is destructed.

Reimplemented from BufferedTransformation.

Definition at line 19 of file filters.h.

bool Filter::Flush bool  hardFlush,
int  propagation = -1,
bool  blocking = true
[virtual, inherited]
 

flush buffered input and/or output

Parameters:
hardFlush is used to indicate whether all data should be flushed
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, for example 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 from BufferedTransformation.

Reimplemented in SecretSharing, InformationDispersal, Unflushable< Filter >, Unflushable< Multichannel< Filter > >, and Multichannel< Filter >.

Definition at line 68 of file filters.cpp.

References Filter::m_continueAt, and Filter::OutputFlush().

bool Filter::MessageSeriesEnd int  propagation = -1,
bool  blocking = true
[virtual, inherited]
 

mark end of a series of messages

There should be a MessageEnd immediately before MessageSeriesEnd.

Reimplemented from BufferedTransformation.

Reimplemented in Multichannel< Filter >.

Definition at line 82 of file filters.cpp.

References BufferedTransformation::IsolatedMessageSeriesEnd(), Filter::m_continueAt, Filter::OutputMessageSeriesEnd(), and Filter::ShouldPropagateMessageSeriesEnd().

BufferedTransformation& BufferedTransformation::Ref  )  [inline, inherited]
 

return a reference to this object

This function is useful for passing a temporary BufferedTransformation object to a function that takes a non-const reference.

Definition at line 711 of file cryptlib.h.

virtual void BufferedTransformation::SetAutoSignalPropagation int  propagation  )  [inline, virtual, inherited]
 

set propagation of automatically generated and transferred signals

propagation == 0 means do not automaticly generate signals

Reimplemented in SourceTemplate< T >, SourceTemplate< FileStore >, SourceTemplate< RandomNumberStore >, SourceTemplate< StringStore >, AutoSignaling< BufferedTransformation >, AutoSignaling< InputRejecting< BufferedTransformation > >, AutoSignaling< Filter >, AutoSignaling< Source >, and AutoSignaling< Unflushable< Multichannel< Filter > > >.

Definition at line 788 of file cryptlib.h.

unsigned long BufferedTransformation::MaxRetrievable  )  const [virtual, inherited]
 

returns number of bytes that is currently 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 FileStore, RandomNumberStore, NullStore, MessageQueue, ByteQueue, ByteQueue::Walker, and RandomPool.

Definition at line 247 of file cryptlib.cpp.

References BufferedTransformation::AttachedTransformation(), BufferedTransformation::CopyTo(), and BufferedTransformation::MaxRetrievable().

Referenced by RandomNumberStore::AnyRetrievable(), Integer::BERDecode(), Integer::Decode(), DL_GroupParameters_EC< EC >::Initialize(), BufferedTransformation::MaxRetrievable(), EcRecommendedParameters< ECP >::NewEC(), EcRecommendedParameters< EC2N >::NewEC(), Integer::OpenPGPDecode(), and BufferedTransformation::TotalBytesRetrievable().

bool BufferedTransformation::GetNextMessage  )  [virtual, inherited]
 

start retrieving the next message

Returns false if no more messages exist or this message is not completely retrieved.

Reimplemented in MessageQueue, and Store.

Definition at line 336 of file cryptlib.cpp.

References BufferedTransformation::AnyMessages(), BufferedTransformation::AttachedTransformation(), and BufferedTransformation::GetNextMessage().

Referenced by BufferedTransformation::GetNextMessage(), and BufferedTransformation::TransferMessagesTo2().

bool Waitable::Wait unsigned long  milliseconds  )  [inherited]
 

wait on this object

same as creating an empty container, calling GetWaitObjects(), and calling Wait() on the container

Definition at line 321 of file wait.cpp.

References Waitable::GetWaitObjects(), and WaitObjectContainer::Wait().

Referenced by NetworkSource::GeneralPump2(), and NetworkSink::TimedFlush().


The documentation for this class was generated from the following file:
Generated on Fri Sep 9 19:01:32 2005 for Crypto++ by  doxygen 1.4.4