#include <base32.h>
Inheritance diagram for Base32Encoder:
To specify alternative code, call Initialize() with EncodingLookupArray parameter.
Definition at line 10 of file base32.h.
Public Member Functions | |
Base32Encoder (BufferedTransformation *attachment=NULL, bool uppercase=true, int outputGroupSize=0, const std::string &separator=":", const std::string &terminator="") | |
void | IsolatedInitialize (const NameValuePairs ¶meters) |
void | FirstPut (const byte *) |
void | LastPut (const byte *, size_t) |
bool | IsolatedFlush (bool hardFlush, bool blocking) |
void | SetFilter (Filter *filter) |
void | NextPutMultiple (const byte *s, size_t len) |
void | NextPutModifiable (byte *inString, size_t length) |
size_t | Put2 (const byte *inString, size_t length, int messageEnd, bool blocking) |
input multiple bytes for blocking or non-blocking processing | |
size_t | PutModifiable2 (byte *inString, size_t length, int messageEnd, bool blocking) |
input multiple bytes that may be modified by callee for blocking or non-blocking processing | |
void | ForceNextPut () |
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 | |
size_t | TransferTo2 (BufferedTransformation &target, lword &transferBytes, const std::string &channel=NULL_CHANNEL, bool blocking=true) |
upon return, byteCount contains number of bytes that have finished being transfered, and returns the number of bytes left in the current transfer block | |
size_t | CopyRangeTo2 (BufferedTransformation &target, lword &begin, lword end=LWORD_MAX, const std::string &channel=NULL_CHANNEL, bool blocking=true) const |
upon return, begin contains the start position of data yet to be finished copying, and returns the number of bytes left in the current transfer block | |
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, CallStack const &callStack) |
wait on this object | |
Static Public Attributes | |
static const std::string | NULL_CHANNEL |
Protected Member Functions | |
bool | DidFirstPut () |
virtual void | InitializeDerivedAndReturnNewSizes (const NameValuePairs ¶meters, size_t &firstSize, size_t &blockSize, size_t &lastSize) |
virtual void | InitializeDerived (const NameValuePairs ¶meters) |
virtual void | NextPutSingle (const byte *inString) |
virtual void | FlushDerived () |
virtual BufferedTransformation * | NewDefaultAttachment () const |
void | Insert (Filter *nextFilter) |
virtual bool | ShouldPropagateMessageEnd () const |
virtual bool | ShouldPropagateMessageSeriesEnd () const |
void | PropagateInitialize (const NameValuePairs ¶meters, int propagation) |
size_t | Output (int outputSite, const byte *inString, size_t length, int messageEnd, bool blocking, const std::string &channel=NULL_CHANNEL) |
size_t | OutputModifiable (int outputSite, byte *inString, size_t 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 | |
member_ptr< BufferedTransformation > | m_filter |
size_t | m_inputPosition |
int | m_continueAt |
bool ProxyFilter::IsolatedFlush | ( | bool | hardFlush, | |
bool | blocking | |||
) | [virtual, inherited] |
calls ForceNextPut() if hardFlush is true
Reimplemented from FilterWithBufferedInput.
Definition at line 468 of file filters.cpp.
References member_ptr< T >::get(), and ProxyFilter::m_filter.
size_t FilterWithBufferedInput::Put2 | ( | const byte * | inString, | |
size_t | length, | |||
int | messageEnd, | |||
bool | blocking | |||
) | [inline, virtual, inherited] |
input multiple bytes for blocking or non-blocking processing
messageEnd | means how many filters to signal MessageEnd to, including this one |
Implements BufferedTransformation.
size_t FilterWithBufferedInput::PutModifiable2 | ( | byte * | inString, | |
size_t | length, | |||
int | messageEnd, | |||
bool | blocking | |||
) | [inline, virtual, inherited] |
input multiple bytes that may be modified by callee for blocking or non-blocking processing
messageEnd | means how many filters to signal MessageEnd to, including this one |
Reimplemented from BufferedTransformation.
void FilterWithBufferedInput::ForceNextPut | ( | ) | [inherited] |
The input buffer may contain more than blockSize bytes if lastSize != 0. ForceNextPut() forces a call to NextPut() if this is the case.
Definition at line 418 of file filters.cpp.
References FilterWithBufferedInput::NextPutModifiable().
Referenced by FilterWithBufferedInput::IsolatedFlush().
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.
bool Filter::Flush | ( | bool | hardFlush, | |
int | propagation = -1 , |
|||
bool | blocking = true | |||
) | [virtual, inherited] |
flush buffered input and/or output
hardFlush | is used to indicate whether all data should be flushed |
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 736 of file cryptlib.h.
virtual byte* BufferedTransformation::CreatePutSpace | ( | size_t & | size | ) | [inline, virtual, inherited] |
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 755 of file cryptlib.h.
Referenced by BufferedTransformation::ChannelCreatePutSpace(), and ArrayXorSink::CreatePutSpace().
void BufferedTransformation::GetWaitObjects | ( | WaitObjectContainer & | container, | |
CallStack const & | callStack | |||
) | [virtual, inherited] |
put wait objects into container
callStack | is used for tracing no wait loops, example: something.GetWaitObjects(c, CallStack("my func after X", 0));
|
Implements Waitable.
Reimplemented in Redirector, NetworkSource, and NetworkSink.
Definition at line 214 of file cryptlib.cpp.
References BufferedTransformation::AttachedTransformation(), and BufferedTransformation::GetWaitObjects().
Referenced by NetworkSource::GetWaitObjects(), and BufferedTransformation::GetWaitObjects().
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 813 of file cryptlib.h.
lword 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, and ByteQueue::Walker.
Definition at line 279 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 368 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, | |
CallStack const & | callStack | |||
) | [inherited] |
wait on this object
same as creating an empty container, calling GetWaitObjects(), and calling Wait() on the container
Definition at line 388 of file wait.cpp.
References Waitable::GetWaitObjects(), and WaitObjectContainer::Wait().
Referenced by NetworkSink::DoFlush(), and NetworkSource::DoPump().