#include <filters.h>
Inheritance diagram for Filter:
Definition at line 14 of file filters.h.
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 byte * | CreatePutSpace (unsigned int &size) |
request space which can be written into by the caller, and then used as input to Put() | |
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) |
virtual unsigned int | Put2 (const byte *inString, unsigned int length, int messageEnd, bool blocking)=0 |
input multiple bytes for blocking or non-blocking processing | |
virtual 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 | |
SIGNALS | |
virtual void | IsolatedInitialize (const NameValuePairs ¶meters) |
virtual bool | IsolatedFlush (bool hardFlush, bool blocking)=0 |
virtual bool | IsolatedMessageSeriesEnd (bool blocking) |
virtual void | SetAutoSignalPropagation (int propagation) |
set propagation of automatically generated and transferred signals | |
virtual int | GetAutoSignalPropagation () const |
Public Member Functions | |
Filter (BufferedTransformation *attachment=NULL) | |
bool | Attachable () |
returns whether this object allows attachment | |
BufferedTransformation * | AttachedTransformation () |
returns the object immediately attached to this object or NULL for no attachment | |
const BufferedTransformation * | AttachedTransformation () 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 ¶meters=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 | |
BufferedTransformation & | Ref () |
return a reference to this object | |
virtual std::string | AlgorithmName () const |
returns name of this algorithm, not universally implemented yet | |
virtual Clonable * | Clone () const |
this is not implemented by most classes yet | |
bool | Wait (unsigned long milliseconds) |
wait on this object | |
Static Public Attributes | |
static const std::string | NULL_CHANNEL |
Protected Member Functions | |
virtual BufferedTransformation * | NewDefaultAttachment () const |
void | Insert (Filter *nextFilter) |
virtual bool | ShouldPropagateMessageEnd () const |
virtual bool | ShouldPropagateMessageSeriesEnd () const |
void | PropagateInitialize (const NameValuePairs ¶meters, 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 |
|
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. |
|
flush buffered input and/or output
Reimplemented from BufferedTransformation. Reimplemented in SecretSharing, InformationDispersal, Unflushable< Filter >, Unflushable< Multichannel< Filter > >, and Multichannel< Filter >. Definition at line 68 of file filters.cpp. References m_continueAt, and OutputFlush(). |
|
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(), m_continueAt, OutputMessageSeriesEnd(), and ShouldPropagateMessageSeriesEnd(). |
|
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 716 of file cryptlib.h. |
|
request space which can be written into by the caller, and then used as input to Put()
Reimplemented in MeterFilter, HashFilter, Redirector, OutputProxy, ArraySink, ArrayXorSink, ByteQueue, Multichannel< Filter >, and Multichannel< Sink >. Definition at line 735 of file cryptlib.h. Referenced by BufferedTransformation::ChannelCreatePutSpace(), and ArrayXorSink::CreatePutSpace(). |
|
input multiple bytes for blocking or non-blocking processing
Implemented in BaseN_Encoder, BaseN_Decoder, Grouper, PK_DefaultEncryptionFilter, PK_DefaultDecryptionFilter, FileSink, MeterFilter, FilterWithBufferedInput, FilterWithInputQueue, HashFilter, SignerFilter, Redirector, OutputProxy, StringSinkTemplate< T >, ArraySink, ArrayXorSink, SecretSharing, InformationDispersal, PaddingRemover, MessageQueue, NetworkSink, ByteQueue, MaurerRandomnessTest, BitBucket, FilterTester, Deflator, Inflator, InputRejecting< BufferedTransformation >, InputRejecting< Filter >, Multichannel< Filter >, and Multichannel< Sink >. Referenced by BufferedTransformation::ChannelPut2(), and Output(). |
|
input multiple bytes that may be modified by callee for blocking or non-blocking processing
Reimplemented in MeterFilter, FilterWithBufferedInput, OutputProxy, Multichannel< Filter >, and Multichannel< Sink >. Definition at line 753 of file cryptlib.h. Referenced by BufferedTransformation::ChannelPutModifiable2(), NetworkSource::GeneralPump2(), and OutputModifiable(). |
|
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 793 of file cryptlib.h. |
|
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(). |
|
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(). |
|
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(). |